Skip to content

Commit

Permalink
Deploying to javadoc from @ ce5db06 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
BrownGenius committed Mar 6, 2024
1 parent 421a6fc commit 8d0b4d9
Show file tree
Hide file tree
Showing 64 changed files with 3,560 additions and 443 deletions.
128 changes: 72 additions & 56 deletions javadoc/allclasses-index.html

Large diffs are not rendered by default.

24 changes: 16 additions & 8 deletions javadoc/allpackages-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,23 +61,31 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/commands/climber/package-summary.html">frc.robot.commands.climber</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/commands/drive/package-summary.html">frc.robot.commands.drive</a></div>
<div class="col-first even-row-color"><a href="frc/robot/commands/debug/package-summary.html">frc.robot.commands.debug</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/commands/intake/package-summary.html">frc.robot.commands.intake</a></div>
<div class="col-first odd-row-color"><a href="frc/robot/commands/drive/package-summary.html">frc.robot.commands.drive</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/commands/shooter/package-summary.html">frc.robot.commands.shooter</a></div>
<div class="col-first even-row-color"><a href="frc/robot/commands/intake/package-summary.html">frc.robot.commands.intake</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/commands/shooter/package-summary.html">frc.robot.commands.shooter</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/commands/vision/package-summary.html">frc.robot.commands.vision</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/config/package-summary.html">frc.robot.config</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/arm/package-summary.html">frc.robot.subsystems.arm</a></div>
<div class="col-first even-row-color"><a href="frc/robot/controls/package-summary.html">frc.robot.controls</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/arm/package-summary.html">frc.robot.subsystems.arm</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/climber/package-summary.html">frc.robot.subsystems.climber</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/climber/package-summary.html">frc.robot.subsystems.climber</a></div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/drive/package-summary.html">frc.robot.subsystems.drive</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/drive/package-summary.html">frc.robot.subsystems.drive</a></div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/intake/package-summary.html">frc.robot.subsystems.intake</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/intake/package-summary.html">frc.robot.subsystems.intake</a></div>
<div class="col-first odd-row-color"><a href="frc/robot/subsystems/shooter/package-summary.html">frc.robot.subsystems.shooter</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/shooter/package-summary.html">frc.robot.subsystems.shooter</a></div>
<div class="col-first even-row-color"><a href="frc/robot/subsystems/vision/package-summary.html">frc.robot.subsystems.vision</a></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><a href="frc/robot/util/package-summary.html">frc.robot.util</a></div>
<div class="col-last odd-row-color">&nbsp;</div>
Expand Down
10 changes: 5 additions & 5 deletions javadoc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ <h2 title="frc.robot">frc.robot.*</h2>
<div class="table-header col-last">Value</div>
<div class="col-first even-row-color"><code id="frc.robot.BuildConstants.BUILD_DATE">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/BuildConstants.html#BUILD_DATE">BUILD_DATE</a></code></div>
<div class="col-last even-row-color"><code>"2024-03-04 23:18:41 EST"</code></div>
<div class="col-last even-row-color"><code>"2024-03-06 15:08:59 EST"</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.BuildConstants.BUILD_UNIX_TIME">public&nbsp;static&nbsp;final&nbsp;long</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/BuildConstants.html#BUILD_UNIX_TIME">BUILD_UNIX_TIME</a></code></div>
<div class="col-last odd-row-color"><code>1709612321357L</code></div>
<div class="col-last odd-row-color"><code>1709755739774L</code></div>
<div class="col-first even-row-color"><code id="frc.robot.BuildConstants.DIRTY">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/BuildConstants.html#DIRTY">DIRTY</a></code></div>
<div class="col-last even-row-color"><code>0</code></div>
Expand All @@ -78,13 +78,13 @@ <h2 title="frc.robot">frc.robot.*</h2>
<div class="col-last odd-row-color"><code>"main"</code></div>
<div class="col-first even-row-color"><code id="frc.robot.BuildConstants.GIT_DATE">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/BuildConstants.html#GIT_DATE">GIT_DATE</a></code></div>
<div class="col-last even-row-color"><code>"2024-03-04 23:17:48 EST"</code></div>
<div class="col-last even-row-color"><code>"2024-03-06 15:08:01 EST"</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.BuildConstants.GIT_REVISION">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/BuildConstants.html#GIT_REVISION">GIT_REVISION</a></code></div>
<div class="col-last odd-row-color"><code>60</code></div>
<div class="col-last odd-row-color"><code>61</code></div>
<div class="col-first even-row-color"><code id="frc.robot.BuildConstants.GIT_SHA">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/BuildConstants.html#GIT_SHA">GIT_SHA</a></code></div>
<div class="col-last even-row-color"><code>"975e46132a59b909ac85e0209c3c01ece96e7892"</code></div>
<div class="col-last even-row-color"><code>"ce5db0651a51faacee076ab038f6c564d0298abc"</code></div>
<div class="col-first odd-row-color"><code id="frc.robot.BuildConstants.MAVEN_GROUP">public&nbsp;static&nbsp;final&nbsp;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/BuildConstants.html#MAVEN_GROUP">MAVEN_GROUP</a></code></div>
<div class="col-last odd-row-color"><code>""</code></div>
Expand Down
4 changes: 4 additions & 0 deletions javadoc/element-list
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@ frc.robot
frc.robot.commands.arm
frc.robot.commands.assist
frc.robot.commands.climber
frc.robot.commands.debug
frc.robot.commands.drive
frc.robot.commands.intake
frc.robot.commands.shooter
frc.robot.commands.vision
frc.robot.config
frc.robot.controls
frc.robot.subsystems.arm
frc.robot.subsystems.climber
frc.robot.subsystems.drive
frc.robot.subsystems.intake
frc.robot.subsystems.shooter
frc.robot.subsystems.vision
frc.robot.util
13 changes: 2 additions & 11 deletions javadoc/frc/robot/RobotContainer.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,9 @@ <h2>Method Summary</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#commandsToShuffleboard()" class="member-name-link">commandsToShuffleboard</a>()</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.wpilibj2.command.Command</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAutonomousCommand()" class="member-name-link">getAutonomousCommand</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>edu.wpi.first.wpilibj2.command.Command</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAutonomousCommand()" class="member-name-link">getAutonomousCommand</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
Expand Down Expand Up @@ -185,12 +182,6 @@ <h3>getAutonomousCommand</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">edu.wpi.first.wpilibj2.command.Command</span>&nbsp;<span class="element-name">getAutonomousCommand</span>()</div>
</section>
</li>
<li>
<section class="detail" id="commandsToShuffleboard()">
<h3>commandsToShuffleboard</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">commandsToShuffleboard</span>()</div>
</section>
</li>
</ul>
</section>
</li>
Expand Down
25 changes: 5 additions & 20 deletions javadoc/frc/robot/commands/arm/ArmToPosition.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,6 @@ <h1 title="Class ArmToPosition" class="title">Class ArmToPosition</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArmToPosition</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
<div class="block">This class uses a widget on Shuffleboard to control the arm setpoint. It is meant to be used for
debug/test/bring type work.</div>
</section>
<section class="summary">
<ul class="summary-list">
Expand Down Expand Up @@ -132,23 +130,20 @@ <h2>Method Summary</h2>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#end(boolean)" class="member-name-link">end</a><wbr>(boolean&nbsp;interrupted)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initialize()" class="member-name-link">initialize</a>()</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isFinished()" class="member-name-link">isFinished</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Methods inherited from class&nbsp;edu.wpi.first.wpilibj2.command.Command</h3>
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
<code>addRequirements, alongWith, andThen, andThen, asProxy, beforeStarting, beforeStarting, cancel, deadlineWith, end, finallyDo, finallyDo, getInterruptionBehavior, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, initSendable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, runsWhenDisabled, schedule, setName, setSubsystem, unless, until, withInterruptBehavior, withName, withTimeout</code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
Expand Down Expand Up @@ -208,16 +203,6 @@ <h3>isFinished</h3>
</dl>
</section>
</li>
<li>
<section class="detail" id="end(boolean)">
<h3>end</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">end</span><wbr><span class="parameters">(boolean&nbsp;interrupted)</span></div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>end</code>&nbsp;in class&nbsp;<code>edu.wpi.first.wpilibj2.command.Command</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
Expand Down
4 changes: 4 additions & 0 deletions javadoc/frc/robot/commands/arm/ArmToPositionTP.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ <h1 title="Class ArmToPositionTP" class="title">Class ArmToPositionTP</h1>
<dt>All Implemented Interfaces:</dt>
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
</dl>
<dl class="notes">
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="../assist/ProtectArm.html" title="class in frc.robot.commands.assist">ProtectArm</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ArmToPositionTP</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.TrapezoidProfileCommand</span></div>
Expand Down
10 changes: 2 additions & 8 deletions javadoc/frc/robot/commands/arm/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,9 @@ <h1 title="Package frc.robot.commands.arm" class="title">Package frc.robot.comma
<div class="table-header col-first">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArmToPosition.html" title="class in frc.robot.commands.arm">ArmToPosition</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">This class uses a widget on Shuffleboard to control the arm setpoint.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArmToPositionDebug.html" title="class in frc.robot.commands.arm">ArmToPositionDebug</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">This class uses a widget on Shuffleboard to control the arm setpoint.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ArmToPositionTP.html" title="class in frc.robot.commands.arm">ArmToPositionTP</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ArmToPositionTP.html" title="class in frc.robot.commands.arm">ArmToPositionTP</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
</div>
</div>
</li>
Expand Down
1 change: 0 additions & 1 deletion javadoc/frc/robot/commands/arm/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
<li class="circle">edu.wpi.first.wpilibj2.command.Command (implements edu.wpi.first.util.sendable.Sendable)
<ul>
<li class="circle">frc.robot.commands.arm.<a href="ArmToPosition.html" class="type-name-link" title="class in frc.robot.commands.arm">ArmToPosition</a></li>
<li class="circle">frc.robot.commands.arm.<a href="ArmToPositionDebug.html" class="type-name-link" title="class in frc.robot.commands.arm">ArmToPositionDebug</a></li>
<li class="circle">edu.wpi.first.wpilibj2.command.TrapezoidProfileCommand
<ul>
<li class="circle">frc.robot.commands.arm.<a href="ArmToPositionTP.html" class="type-name-link" title="class in frc.robot.commands.arm">ArmToPositionTP</a></li>
Expand Down
Loading

0 comments on commit 8d0b4d9

Please sign in to comment.