Skip to content

Commit

Permalink
Deploying to javadoc from @ 37addc2 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Jack-Haefele committed Mar 8, 2024
1 parent 9d4d6cd commit d2bcc25
Show file tree
Hide file tree
Showing 12 changed files with 657 additions and 157 deletions.
158 changes: 83 additions & 75 deletions javadoc/allclasses-index.html

Large diffs are not rendered by default.

156 changes: 90 additions & 66 deletions javadoc/frc/robot/RobotContainer.html

Large diffs are not rendered by default.

232 changes: 232 additions & 0 deletions javadoc/frc/robot/commands/ClearPDPStickyFaults.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ClearPDPStickyFaults (robot2024 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="declaration: package: frc.robot.commands, class: ClearPDPStickyFaults">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">frc.robot.commands</a></div>
<h1 title="Class ClearPDPStickyFaults" class="title">Class ClearPDPStickyFaults</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><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">java.lang.Object</a>
<div class="inheritance">edu.wpi.first.wpilibj2.command.Command
<div class="inheritance">frc.robot.commands.ClearPDPStickyFaults</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code>edu.wpi.first.util.sendable.Sendable</code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ClearPDPStickyFaults</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.Command</span></div>
<div class="block">Clears the PDP's sticky faults</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="inherited-list">
<h2 id="nested-classes-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Nested classes/interfaces inherited from class&nbsp;edu.wpi.first.wpilibj2.command.Command</h2>
<code>edu.wpi.first.wpilibj2.command.Command.InterruptionBehavior</code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-edu.wpi.first.wpilibj2.command.Command">Fields inherited from class&nbsp;edu.wpi.first.wpilibj2.command.Command</h3>
<code>m_requirements</code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ClearPDPStickyFaults</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new ClearPDPStickyFaults.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<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="#end(boolean)" class="member-name-link">end</a><wbr>(boolean&nbsp;interrupted)</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-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-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>
<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>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>ClearPDPStickyFaults</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ClearPDPStickyFaults</span>()</div>
<div class="block">Creates a new ClearPDPStickyFaults.</div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="initialize()">
<h3>initialize</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">initialize</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>initialize</code>&nbsp;in class&nbsp;<code>edu.wpi.first.wpilibj2.command.Command</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="execute()">
<h3>execute</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>execute</code>&nbsp;in class&nbsp;<code>edu.wpi.first.wpilibj2.command.Command</code></dd>
</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>
<li>
<section class="detail" id="isFinished()">
<h3>isFinished</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isFinished</span>()</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code>isFinished</code>&nbsp;in class&nbsp;<code>edu.wpi.first.wpilibj2.command.Command</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
30 changes: 17 additions & 13 deletions javadoc/frc/robot/commands/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -95,32 +95,36 @@ <h1 title="Package frc.robot.commands" class="title">Package frc.robot.commands<
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Aims with the limelight towards an object.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ClimbDown.html" title="class in frc.robot.commands">ClimbDown</a></div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ClearPDPStickyFaults.html" title="class in frc.robot.commands">ClearPDPStickyFaults</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Climbs the robot down until the command is stopped.</div>
<div class="block">Clears the PDP's sticky faults</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ClimbUp.html" title="class in frc.robot.commands">ClimbUp</a></div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ClimbDown.html" title="class in frc.robot.commands">ClimbDown</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Climbs the robot up until the command is stopped.</div>
<div class="block">Climbs the robot down until the command is stopped.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="DeployUrMom.html" title="class in frc.robot.commands">DeployUrMom</a></div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ClimbUp.html" title="class in frc.robot.commands">ClimbUp</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Prints "your mom"</div>
<div class="block">Climbs the robot up until the command is stopped.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="EnterXMode.html" title="class in frc.robot.commands">EnterXMode</a></div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="DeployUrMom.html" title="class in frc.robot.commands">DeployUrMom</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Points the wheels toward the inside and stops the wheels from moving in any direction.</div>
<div class="block">Prints "your mom"</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RunIntake.html" title="class in frc.robot.commands">RunIntake</a></div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="EnterXMode.html" title="class in frc.robot.commands">EnterXMode</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Command that runs the intake on the robot.</div>
<div class="block">Points the wheels toward the inside and stops the wheels from moving in any direction.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RunIntakeReverse.html" title="class in frc.robot.commands">RunIntakeReverse</a></div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="RunIntake.html" title="class in frc.robot.commands">RunIntake</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Command that runs the intake in the opposite direction on the robot.</div>
<div class="block">Command that runs the intake on the robot.</div>
</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="SeekTargetWithLimelight.html" title="class in frc.robot.commands">SeekTargetWithLimelight</a></div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="RunIntakeReverse.html" title="class in frc.robot.commands">RunIntakeReverse</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Command that runs the intake in the opposite direction on the robot.</div>
</div>
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="SeekTargetWithLimelight.html" title="class in frc.robot.commands">SeekTargetWithLimelight</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">
<div class="block">Seeks an unseen target with the Limelight by spinning the robot in a circle until the Limelight
sees a valid target.</div>
</div>
Expand Down
1 change: 1 addition & 0 deletions javadoc/frc/robot/commands/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ <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.<a href="AimWithLimelight.html" class="type-name-link" title="class in frc.robot.commands">AimWithLimelight</a></li>
<li class="circle">frc.robot.commands.<a href="ClearPDPStickyFaults.html" class="type-name-link" title="class in frc.robot.commands">ClearPDPStickyFaults</a></li>
<li class="circle">frc.robot.commands.<a href="ClimbDown.html" class="type-name-link" title="class in frc.robot.commands">ClimbDown</a></li>
<li class="circle">frc.robot.commands.<a href="ClimbUp.html" class="type-name-link" title="class in frc.robot.commands">ClimbUp</a></li>
<li class="circle">frc.robot.commands.<a href="DeployUrMom.html" class="type-name-link" title="class in frc.robot.commands">DeployUrMom</a></li>
Expand Down
Loading

0 comments on commit d2bcc25

Please sign in to comment.