Skip to content

Commit

Permalink
Deploying to javadoc from @ bdaf226 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Jack-Haefele committed Feb 20, 2024
1 parent 91535d7 commit c2c2430
Show file tree
Hide file tree
Showing 5 changed files with 202 additions and 40 deletions.
38 changes: 28 additions & 10 deletions javadoc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,24 @@ <h2 title="frc.robot">frc.robot.*</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Intake.INTAKE_LIMIT_SWITCH_DIO_PORT">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_LIMIT_SWITCH_DIO_PORT">INTAKE_LIMIT_SWITCH_DIO_PORT</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.Intake.INTAKE_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_MOTOR_ID">INTAKE_MOTOR_ID</a></code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Intake.INTAKE_FOLLOWER_INVERSE_STATE">public&nbsp;static&nbsp;final&nbsp;boolean</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_FOLLOWER_INVERSE_STATE">INTAKE_FOLLOWER_INVERSE_STATE</a></code></div>
<div class="col-last even-row-color"><code>false</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.Intake.INTAKE_LIMIT_SWITCH_DIO_PORT">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_LIMIT_SWITCH_DIO_PORT">INTAKE_LIMIT_SWITCH_DIO_PORT</a></code></div>
<div class="col-last odd-row-color"><code>0</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Intake.INTAKE_MOTOR_SPEED">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Intake.html#INTAKE_MOTOR_SPEED">INTAKE_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color"><code>1.0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.Intake.LOWER_INTAKE_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.Intake.html#LOWER_INTAKE_MOTOR_ID">LOWER_INTAKE_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color"><code>0</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Intake.UPPER_INTAKE_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Intake.html#UPPER_INTAKE_MOTOR_ID">UPPER_INTAKE_MOTOR_ID</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.Intake.UPPER_INTAKE_MOTOR_INVERTED">public&nbsp;static&nbsp;final&nbsp;boolean</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.Intake.html#UPPER_INTAKE_MOTOR_INVERTED">UPPER_INTAKE_MOTOR_INVERTED</a></code></div>
<div class="col-last odd-row-color"><code>false</code></div>
</div>
</li>
<li>
Expand Down Expand Up @@ -163,12 +172,21 @@ <h2 title="frc.robot">frc.robot.*</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Constant Field</div>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxBelts.BELT_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#BELT_MOTOR_ID">BELT_MOTOR_ID</a></code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxBelts.BELT_MOTOR_SPEED">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#BELT_MOTOR_SPEED">BELT_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color"><code>1.0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.MailboxBelts.BELTS_FOLLOWER_INVERSE_STATE">public&nbsp;static&nbsp;final&nbsp;boolean</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#BELTS_FOLLOWER_INVERSE_STATE">BELTS_FOLLOWER_INVERSE_STATE</a></code></div>
<div class="col-last odd-row-color"><code>false</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxBelts.LOWER_BELT_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#LOWER_BELT_MOTOR_ID">LOWER_BELT_MOTOR_ID</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.MailboxBelts.BELT_MOTOR_SPEED">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#BELT_MOTOR_SPEED">BELT_MOTOR_SPEED</a></code></div>
<div class="col-last odd-row-color"><code>1.0</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.Constants.MailboxBelts.UPPER_BELT_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#UPPER_BELT_MOTOR_ID">UPPER_BELT_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color"><code>0</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.MailboxBelts.UPPER_BELT_MOTOR_INVERTED">public&nbsp;static&nbsp;final&nbsp;boolean</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.MailboxBelts.html#UPPER_BELT_MOTOR_INVERTED">UPPER_BELT_MOTOR_INVERTED</a></code></div>
<div class="col-last even-row-color"><code>false</code></div>
</div>
</li>
<li>
Expand Down
80 changes: 70 additions & 10 deletions javadoc/frc/robot/Constants.Intake.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,21 +90,36 @@ <h2>Field Summary</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#INTAKE_LIMIT_SWITCH_DIO_PORT" class="member-name-link">INTAKE_LIMIT_SWITCH_DIO_PORT</a></code></div>
<div class="col-first even-row-color"><code>static final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#INTAKE_FOLLOWER_INVERSE_STATE" class="member-name-link">INTAKE_FOLLOWER_INVERSE_STATE</a></code></div>
<div class="col-last even-row-color">
<div class="block">DIO Port ID for the Intake limit switch.</div>
<div class="block">Inversion state for the intake follower motor.</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#INTAKE_MOTOR_ID" class="member-name-link">INTAKE_MOTOR_ID</a></code></div>
<div class="col-second odd-row-color"><code><a href="#INTAKE_LIMIT_SWITCH_DIO_PORT" class="member-name-link">INTAKE_LIMIT_SWITCH_DIO_PORT</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Motor id of the Intake motor.</div>
<div class="block">DIO Port ID for the Intake limit switch.</div>
</div>
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#INTAKE_MOTOR_SPEED" class="member-name-link">INTAKE_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color">
<div class="block">Speed we want to run the Intake at.</div>
</div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#LOWER_INTAKE_MOTOR_ID" class="member-name-link">LOWER_INTAKE_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Motor id of the Lower Intake motor.</div>
</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#UPPER_INTAKE_MOTOR_ID" class="member-name-link">UPPER_INTAKE_MOTOR_ID</a></code></div>
<div class="col-last even-row-color">
<div class="block">Motor id of the Upper Intake motor.</div>
</div>
<div class="col-first odd-row-color"><code>static final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#UPPER_INTAKE_MOTOR_INVERTED" class="member-name-link">UPPER_INTAKE_MOTOR_INVERTED</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Inversion state of the upper intake motor.</div>
</div>
</div>
</section>
</li>
Expand Down Expand Up @@ -140,15 +155,45 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="INTAKE_MOTOR_ID">
<h3>INTAKE_MOTOR_ID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">INTAKE_MOTOR_ID</span></div>
<div class="block">Motor id of the Intake motor.</div>
<section class="detail" id="LOWER_INTAKE_MOTOR_ID">
<h3>LOWER_INTAKE_MOTOR_ID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">LOWER_INTAKE_MOTOR_ID</span></div>
<div class="block">Motor id of the Lower Intake motor.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Intake.LOWER_INTAKE_MOTOR_ID">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="UPPER_INTAKE_MOTOR_ID">
<h3>UPPER_INTAKE_MOTOR_ID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">UPPER_INTAKE_MOTOR_ID</span></div>
<div class="block">Motor id of the Upper Intake motor.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Intake.INTAKE_MOTOR_ID">Constant Field Values</a></li>
<li><a href="../../constant-values.html#frc.robot.Constants.Intake.UPPER_INTAKE_MOTOR_ID">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="UPPER_INTAKE_MOTOR_INVERTED">
<h3>UPPER_INTAKE_MOTOR_INVERTED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">UPPER_INTAKE_MOTOR_INVERTED</span></div>
<div class="block">Inversion state of the upper intake motor.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Intake.UPPER_INTAKE_MOTOR_INVERTED">Constant Field Values</a></li>
</ul>
</dd>
</dl>
Expand Down Expand Up @@ -184,6 +229,21 @@ <h3>INTAKE_MOTOR_SPEED</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="INTAKE_FOLLOWER_INVERSE_STATE">
<h3>INTAKE_FOLLOWER_INVERSE_STATE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">INTAKE_FOLLOWER_INVERSE_STATE</span></div>
<div class="block">Inversion state for the intake follower motor.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Intake.INTAKE_FOLLOWER_INVERSE_STATE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down
82 changes: 71 additions & 11 deletions javadoc/frc/robot/Constants.MailboxBelts.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,15 +90,30 @@ <h2>Field Summary</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static final double</code></div>
<div class="col-second even-row-color"><code><a href="#BELT_MOTOR_SPEED" class="member-name-link">BELT_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color">
<div class="block">The speed for the belt motors.</div>
</div>
<div class="col-first odd-row-color"><code>static final boolean</code></div>
<div class="col-second odd-row-color"><code><a href="#BELTS_FOLLOWER_INVERSE_STATE" class="member-name-link">BELTS_FOLLOWER_INVERSE_STATE</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Inversion state of the belts follower motor.</div>
</div>
<div class="col-first even-row-color"><code>static final int</code></div>
<div class="col-second even-row-color"><code><a href="#BELT_MOTOR_ID" class="member-name-link">BELT_MOTOR_ID</a></code></div>
<div class="col-second even-row-color"><code><a href="#LOWER_BELT_MOTOR_ID" class="member-name-link">LOWER_BELT_MOTOR_ID</a></code></div>
<div class="col-last even-row-color">
<div class="block">The channel on the PCM for the belt motor</div>
<div class="block">The CAN ID for the lower belt motor</div>
</div>
<div class="col-first odd-row-color"><code>static final double</code></div>
<div class="col-second odd-row-color"><code><a href="#BELT_MOTOR_SPEED" class="member-name-link">BELT_MOTOR_SPEED</a></code></div>
<div class="col-first odd-row-color"><code>static final int</code></div>
<div class="col-second odd-row-color"><code><a href="#UPPER_BELT_MOTOR_ID" class="member-name-link">UPPER_BELT_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The speed for the belt motor.</div>
<div class="block">The CAN ID for the upper belt motor</div>
</div>
<div class="col-first even-row-color"><code>static final boolean</code></div>
<div class="col-second even-row-color"><code><a href="#UPPER_BELT_MOTOR_INVERTED" class="member-name-link">UPPER_BELT_MOTOR_INVERTED</a></code></div>
<div class="col-last even-row-color">
<div class="block">Inversion state of the upper belt motor.</div>
</div>
</div>
</section>
Expand Down Expand Up @@ -135,15 +150,30 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="BELT_MOTOR_ID">
<h3>BELT_MOTOR_ID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">BELT_MOTOR_ID</span></div>
<div class="block">The channel on the PCM for the belt motor</div>
<section class="detail" id="UPPER_BELT_MOTOR_ID">
<h3>UPPER_BELT_MOTOR_ID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">UPPER_BELT_MOTOR_ID</span></div>
<div class="block">The CAN ID for the upper belt motor</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.MailboxBelts.UPPER_BELT_MOTOR_ID">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="LOWER_BELT_MOTOR_ID">
<h3>LOWER_BELT_MOTOR_ID</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">LOWER_BELT_MOTOR_ID</span></div>
<div class="block">The CAN ID for the lower belt motor</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.MailboxBelts.BELT_MOTOR_ID">Constant Field Values</a></li>
<li><a href="../../constant-values.html#frc.robot.Constants.MailboxBelts.LOWER_BELT_MOTOR_ID">Constant Field Values</a></li>
</ul>
</dd>
</dl>
Expand All @@ -153,7 +183,7 @@ <h3>BELT_MOTOR_ID</h3>
<section class="detail" id="BELT_MOTOR_SPEED">
<h3>BELT_MOTOR_SPEED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">BELT_MOTOR_SPEED</span></div>
<div class="block">The speed for the belt motor.</div>
<div class="block">The speed for the belt motors.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
Expand All @@ -164,6 +194,36 @@ <h3>BELT_MOTOR_SPEED</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="UPPER_BELT_MOTOR_INVERTED">
<h3>UPPER_BELT_MOTOR_INVERTED</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">UPPER_BELT_MOTOR_INVERTED</span></div>
<div class="block">Inversion state of the upper belt motor.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.MailboxBelts.UPPER_BELT_MOTOR_INVERTED">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="BELTS_FOLLOWER_INVERSE_STATE">
<h3>BELTS_FOLLOWER_INVERSE_STATE</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">BELTS_FOLLOWER_INVERSE_STATE</span></div>
<div class="block">Inversion state of the belts follower motor.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.MailboxBelts.BELTS_FOLLOWER_INVERSE_STATE">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down
Loading

0 comments on commit c2c2430

Please sign in to comment.