Skip to content

Commit

Permalink
Deploying to javadoc from @ e23fd63 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
willitcode committed Feb 13, 2024
1 parent e7afca5 commit 3577ede
Show file tree
Hide file tree
Showing 9 changed files with 227 additions and 3 deletions.
7 changes: 6 additions & 1 deletion javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,13 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Command that runs the intake on the robot.</div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/UrMom.html" title="class in frc.robot.subsystems">UrMom</a></div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/auto/TaxiAuto.html" title="class in frc.robot.commands.auto">TaxiAuto</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
<div class="block">Auto that just taxis (or more accurately, moves us out of the auto starting box.) Taxi time and
velocity can be tuned in Constants.Drive.</div>
</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/UrMom.html" title="class in frc.robot.subsystems">UrMom</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block">Subsystem for printing "your mom"</div>
</div>
</div>
Expand Down
24 changes: 24 additions & 0 deletions javadoc/frc/robot/Constants.Drive.html
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,16 @@ <h2>Field Summary</h2>
<div class="col-last even-row-color">
<div class="block">The Rotation Drive PID for the robot.</div>
</div>
<div class="col-first odd-row-color"><code>static double</code></div>
<div class="col-second odd-row-color"><code><a href="#TAXI_AUTO_DURATION_SECONDS" class="member-name-link">TAXI_AUTO_DURATION_SECONDS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The number of seconds that we want to taxi for</div>
</div>
<div class="col-first even-row-color"><code>static double</code></div>
<div class="col-second even-row-color"><code><a href="#TAXI_AUTO_METERS_PER_SECOND" class="member-name-link">TAXI_AUTO_METERS_PER_SECOND</a></code></div>
<div class="col-last even-row-color">
<div class="block">The number of meters per second that we want to move forward during the taxi auto</div>
</div>
<div class="col-first odd-row-color"><code>static com.pathplanner.lib.util.PIDConstants</code></div>
<div class="col-second odd-row-color"><code><a href="#TRANSLATION_DRIVE_PID" class="member-name-link">TRANSLATION_DRIVE_PID</a></code></div>
<div class="col-last odd-row-color">
Expand Down Expand Up @@ -196,6 +206,20 @@ <h3>ROTATION_DRIVE_PID</h3>
<div class="block">The Rotation Drive PID for the robot.</div>
</section>
</li>
<li>
<section class="detail" id="TAXI_AUTO_METERS_PER_SECOND">
<h3>TAXI_AUTO_METERS_PER_SECOND</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">TAXI_AUTO_METERS_PER_SECOND</span></div>
<div class="block">The number of meters per second that we want to move forward during the taxi auto</div>
</section>
</li>
<li>
<section class="detail" id="TAXI_AUTO_DURATION_SECONDS">
<h3>TAXI_AUTO_DURATION_SECONDS</h3>
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">TAXI_AUTO_DURATION_SECONDS</span></div>
<div class="block">The number of seconds that we want to taxi for</div>
</section>
</li>
</ul>
</section>
</li>
Expand Down
163 changes: 163 additions & 0 deletions javadoc/frc/robot/commands/auto/TaxiAuto.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>TaxiAuto (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.auto, class: TaxiAuto">
<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><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>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.commands.auto</a></div>
<h1 title="Class TaxiAuto" class="title">Class TaxiAuto</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">edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup
<div class="inheritance">frc.robot.commands.auto.TaxiAuto</div>
</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">TaxiAuto</span>
<span class="extends-implements">extends edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup</span></div>
<div class="block">Auto that just taxis (or more accurately, moves us out of the auto starting box.) Taxi time and
velocity can be tuned in Constants.Drive.</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">TaxiAuto</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a new TaxiAuto.</div>
</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-edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup">Methods inherited from class&nbsp;edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup</h3>
<code>addCommands, end, execute, getInterruptionBehavior, initialize, initSendable, isFinished, runsWhenDisabled, setDeadline</code></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, getName, getRequirements, getSubsystem, handleInterrupt, hasRequirement, ignoringDisable, isScheduled, onlyIf, onlyWhile, raceWith, repeatedly, 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>TaxiAuto</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TaxiAuto</span>()</div>
<div class="block">Creates a new TaxiAuto.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
5 changes: 5 additions & 0 deletions javadoc/frc/robot/commands/auto/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,11 @@ <h1 title="Package frc.robot.commands.auto" class="title">Package frc.robot.comm
<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="DriveAutoRobotOriented.html" title="class in frc.robot.commands.auto">DriveAutoRobotOriented</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="TaxiAuto.html" title="class in frc.robot.commands.auto">TaxiAuto</a></div>
<div class="col-last even-row-color class-summary class-summary-tab2">
<div class="block">Auto that just taxis (or more accurately, moves us out of the auto starting box.) Taxi time and
velocity can be tuned in Constants.Drive.</div>
</div>
</div>
</div>
</li>
Expand Down
5 changes: 5 additions & 0 deletions javadoc/frc/robot/commands/auto/package-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
<ul>
<li class="circle">frc.robot.commands.auto.<a href="DriveAutoFieldOriented.html" class="type-name-link" title="class in frc.robot.commands.auto">DriveAutoFieldOriented</a></li>
<li class="circle">frc.robot.commands.auto.<a href="DriveAutoRobotOriented.html" class="type-name-link" title="class in frc.robot.commands.auto">DriveAutoRobotOriented</a></li>
<li class="circle">edu.wpi.first.wpilibj2.command.ParallelDeadlineGroup
<ul>
<li class="circle">frc.robot.commands.auto.<a href="TaxiAuto.html" class="type-name-link" title="class in frc.robot.commands.auto">TaxiAuto</a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down
17 changes: 17 additions & 0 deletions javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,23 @@ <h2 class="title" id="I:S">S</h2>
</dl>
<h2 class="title" id="I:T">T</h2>
<dl class="index">
<dt><a href="frc/robot/Constants.Drive.html#TAXI_AUTO_DURATION_SECONDS" class="member-name-link">TAXI_AUTO_DURATION_SECONDS</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></dt>
<dd>
<div class="block">The number of seconds that we want to taxi for</div>
</dd>
<dt><a href="frc/robot/Constants.Drive.html#TAXI_AUTO_METERS_PER_SECOND" class="member-name-link">TAXI_AUTO_METERS_PER_SECOND</a> - Static variable in class frc.robot.<a href="frc/robot/Constants.Drive.html" title="class in frc.robot">Constants.Drive</a></dt>
<dd>
<div class="block">The number of meters per second that we want to move forward during the taxi auto</div>
</dd>
<dt><a href="frc/robot/commands/auto/TaxiAuto.html" class="type-name-link" title="class in frc.robot.commands.auto">TaxiAuto</a> - Class in <a href="frc/robot/commands/auto/package-summary.html">frc.robot.commands.auto</a></dt>
<dd>
<div class="block">Auto that just taxis (or more accurately, moves us out of the auto starting box.) Taxi time and
velocity can be tuned in Constants.Drive.</div>
</dd>
<dt><a href="frc/robot/commands/auto/TaxiAuto.html#%3Cinit%3E()" class="member-name-link">TaxiAuto()</a> - Constructor for class frc.robot.commands.auto.<a href="frc/robot/commands/auto/TaxiAuto.html" title="class in frc.robot.commands.auto">TaxiAuto</a></dt>
<dd>
<div class="block">Creates a new TaxiAuto.</div>
</dd>
<dt><a href="frc/robot/Robot.html#teleopExit()" class="member-name-link">teleopExit()</a> - Method in class frc.robot.<a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></dt>
<dd>&nbsp;</dd>
<dt><a href="frc/robot/Robot.html#teleopInit()" class="member-name-link">teleopInit()</a> - Method in class frc.robot.<a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></dt>
Expand Down
Loading

0 comments on commit 3577ede

Please sign in to comment.