Skip to content

Commit

Permalink
Deploying to javadoc from @ c859e82 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
willitcode committed Feb 26, 2024
1 parent 539b65d commit bba215c
Show file tree
Hide file tree
Showing 18 changed files with 1,101 additions and 69 deletions.
22 changes: 19 additions & 3 deletions javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,31 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Aims with the limelight towards an object.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.html" title="class in frc.robot">Constants</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/ClimbDown.html" title="class in frc.robot.commands">ClimbDown</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Climbs the robot down until the command is stopped.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/Climber.html" title="class in frc.robot.subsystems">Climber</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The subsystem for the climber.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/ClimbUp.html" title="class in frc.robot.commands">ClimbUp</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Climbs the robot up until the command is stopped.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.html" title="class in frc.robot">Constants</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean
constants.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Auto.html" title="class in frc.robot">Constants.Auto</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Auto.html" title="class in frc.robot">Constants.Auto</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Holds constants specfically related to autonomous.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Climber.html" title="class in frc.robot">Constants.Climber</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">The constants for the climber.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.Controllers.html" title="class in frc.robot">Constants.Controllers</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Constants that are relating to the controllers.</div>
Expand Down
17 changes: 17 additions & 0 deletions javadoc/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,23 @@ <h2 title="frc.robot">frc.robot.*</h2>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.Climber.html" title="class in frc.robot">Constants.Climber</a></span></div>
<div class="summary-table three-column-summary">
<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.Climber.CLIMBER_INVERTED">public&nbsp;static&nbsp;final&nbsp;boolean</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Climber.html#CLIMBER_INVERTED">CLIMBER_INVERTED</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.Climber.CLIMBER_MOTOR_ID">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="frc/robot/Constants.Climber.html#CLIMBER_MOTOR_ID">CLIMBER_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color"><code>13</code></div>
<div class="col-first even-row-color"><code id="frc.robot.Constants.Climber.CLIMBER_MOTOR_SPEED">public&nbsp;static&nbsp;final&nbsp;double</code></div>
<div class="col-second even-row-color"><code><a href="frc/robot/Constants.Climber.html#CLIMBER_MOTOR_SPEED">CLIMBER_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color"><code>0.5</code></div>
</div>
</li>
<li>
<div class="caption"><span>frc.robot.<a href="frc/robot/Constants.Controllers.html" title="class in frc.robot">Constants.Controllers</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
Expand Down
211 changes: 211 additions & 0 deletions javadoc/frc/robot/Constants.Climber.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Constants.Climber (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, class: Constants, class: Climber">
<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 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="../../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>Nested&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><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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</a></div>
<h1 title="Class Constants.Climber" class="title">Class Constants.Climber</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">frc.robot.Constants.Climber</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>Enclosing class:</dt>
<dd><a href="Constants.html" title="class in frc.robot">Constants</a></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public static class </span><span class="element-name type-name-label">Constants.Climber</span>
<span class="extends-implements">extends <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></span></div>
<div class="block">The constants for the climber.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<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 boolean</code></div>
<div class="col-second even-row-color"><code><a href="#CLIMBER_INVERTED" class="member-name-link">CLIMBER_INVERTED</a></code></div>
<div class="col-last even-row-color">
<div class="block">Whether or not the climber is inverted.</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="#CLIMBER_MOTOR_ID" class="member-name-link">CLIMBER_MOTOR_ID</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The motor id for the climber</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="#CLIMBER_MOTOR_SPEED" class="member-name-link">CLIMBER_MOTOR_SPEED</a></code></div>
<div class="col-last even-row-color">
<div class="block">The speed the climber will climb.</div>
</div>
</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">Climber</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<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">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="CLIMBER_MOTOR_ID">
<h3>CLIMBER_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">CLIMBER_MOTOR_ID</span></div>
<div class="block">The motor id for the climber</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Climber.CLIMBER_MOTOR_ID">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="CLIMBER_MOTOR_SPEED">
<h3>CLIMBER_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">CLIMBER_MOTOR_SPEED</span></div>
<div class="block">The speed the climber will climb.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Climber.CLIMBER_MOTOR_SPEED">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="CLIMBER_INVERTED">
<h3>CLIMBER_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">CLIMBER_INVERTED</span></div>
<div class="block">Whether or not the climber is inverted.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../constant-values.html#frc.robot.Constants.Climber.CLIMBER_INVERTED">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= 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>Climber</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Climber</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
31 changes: 18 additions & 13 deletions javadoc/frc/robot/Constants.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,38 +97,43 @@ <h2>Nested Class Summary</h2>
<div class="block">Holds constants specfically related to autonomous.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Controllers.html" class="type-name-link" title="class in frc.robot">Constants.Controllers</a></code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Climber.html" class="type-name-link" title="class in frc.robot">Constants.Climber</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Constants that are relating to the controllers.</div>
<div class="block">The constants for the climber.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.Drive.html" class="type-name-link" title="class in frc.robot">Constants.Drive</a></code></div>
<div class="col-second even-row-color"><code><a href="Constants.Controllers.html" class="type-name-link" title="class in frc.robot">Constants.Controllers</a></code></div>
<div class="col-last even-row-color">
<div class="block">Constants for the Drivetrain</div>
<div class="block">Constants that are relating to the controllers.</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Intake.html" class="type-name-link" title="class in frc.robot">Constants.Intake</a></code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Drive.html" class="type-name-link" title="class in frc.robot">Constants.Drive</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Constants for the Intake System</div>
<div class="block">Constants for the Drivetrain</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.Limelight.html" class="type-name-link" title="class in frc.robot">Constants.Limelight</a></code></div>
<div class="col-second even-row-color"><code><a href="Constants.Intake.html" class="type-name-link" title="class in frc.robot">Constants.Intake</a></code></div>
<div class="col-last even-row-color">
<div class="block">Holds contstants for the Limelights.</div>
<div class="block">Constants for the Intake System</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Mailbox.html" class="type-name-link" title="class in frc.robot">Constants.Mailbox</a></code></div>
<div class="col-second odd-row-color"><code><a href="Constants.Limelight.html" class="type-name-link" title="class in frc.robot">Constants.Limelight</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Constants for the Mailbox system</div>
<div class="block">Holds contstants for the Limelights.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.MailboxBelts.html" class="type-name-link" title="class in frc.robot">Constants.MailboxBelts</a></code></div>
<div class="col-second even-row-color"><code><a href="Constants.Mailbox.html" class="type-name-link" title="class in frc.robot">Constants.Mailbox</a></code></div>
<div class="col-last even-row-color">
<div class="block">Constants for the Belts system.</div>
<div class="block">Constants for the Mailbox system</div>
</div>
<div class="col-first odd-row-color"><code>static class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="Constants.MailboxPneumatics.html" class="type-name-link" title="class in frc.robot">Constants.MailboxPneumatics</a></code></div>
<div class="col-second odd-row-color"><code><a href="Constants.MailboxBelts.html" class="type-name-link" title="class in frc.robot">Constants.MailboxBelts</a></code></div>
<div class="col-last odd-row-color">
<div class="block">Constants for the Belts system.</div>
</div>
<div class="col-first even-row-color"><code>static class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Constants.MailboxPneumatics.html" class="type-name-link" title="class in frc.robot">Constants.MailboxPneumatics</a></code></div>
<div class="col-last even-row-color">
<div class="block">Constants for the Pneumatics system.</div>
</div>
</div>
Expand Down
Loading

0 comments on commit bba215c

Please sign in to comment.