Skip to content

Commit

Permalink
Deploying to javadoc from @ bb4cc32 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
BrownGenius committed Jan 20, 2024
1 parent 6b40b68 commit 5146d16
Show file tree
Hide file tree
Showing 10 changed files with 220 additions and 10 deletions.
4 changes: 3 additions & 1 deletion javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,10 @@ <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">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/shooter/ShooterIOSim.html" title="class in frc.robot.subsystems.shooter">ShooterIOSim</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/shooter/ShooterSubsystem.html" title="class in frc.robot.subsystems.shooter">ShooterSubsystem</a></div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/shooter/ShooterIOSparkMax.html" title="class in frc.robot.subsystems.shooter">ShooterIOSparkMax</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/shooter/ShooterSubsystem.html" title="class in frc.robot.subsystems.shooter">ShooterSubsystem</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
</div>
</div>
</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-01-20 14:25:35 EST"</code></div>
<div class="col-last even-row-color"><code>"2024-01-20 14:34:10 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>1705778735255L</code></div>
<div class="col-last odd-row-color"><code>1705779250930L</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-01-20 14:24:56 EST"</code></div>
<div class="col-last even-row-color"><code>"2024-01-20 14:33:29 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>9</code></div>
<div class="col-last odd-row-color"><code>10</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>"f58f702f959dc44699cd6a5fd62a72e2e04c2e68"</code></div>
<div class="col-last even-row-color"><code>"bb4cc321614080f5a4f7e8ed46fcbe8fe9516d30"</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
2 changes: 1 addition & 1 deletion javadoc/frc/robot/subsystems/shooter/ShooterIO.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ <h1 title="Interface ShooterIO" class="title">Interface ShooterIO</h1>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="ShooterIOSim.html" title="class in frc.robot.subsystems.shooter">ShooterIOSim</a></code></dd>
<dd><code><a href="ShooterIOSim.html" title="class in frc.robot.subsystems.shooter">ShooterIOSim</a></code>, <code><a href="ShooterIOSparkMax.html" title="class in frc.robot.subsystems.shooter">ShooterIOSparkMax</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ShooterIO</span></div>
Expand Down
196 changes: 196 additions & 0 deletions javadoc/frc/robot/subsystems/shooter/ShooterIOSparkMax.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,196 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>ShooterIOSparkMax (Crescendo2024 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.subsystems.shooter, class: ShooterIOSparkMax">
<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="../../../../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>Field&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.subsystems.shooter</a></div>
<h1 title="Class ShooterIOSparkMax" class="title">Class ShooterIOSparkMax</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.subsystems.shooter.ShooterIOSparkMax</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="ShooterIO.html" title="interface in frc.robot.subsystems.shooter">ShooterIO</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ShooterIOSparkMax</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>
implements <a href="ShooterIO.html" title="interface in frc.robot.subsystems.shooter">ShooterIO</a></span></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-frc.robot.subsystems.shooter.ShooterIO">Nested classes/interfaces inherited from interface&nbsp;frc.robot.subsystems.shooter.<a href="ShooterIO.html" title="interface in frc.robot.subsystems.shooter">ShooterIO</a></h2>
<code><a href="ShooterIO.ShooterIOInputs.html" title="class in frc.robot.subsystems.shooter">ShooterIO.ShooterIOInputs</a></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">ShooterIOSparkMax</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 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="#setVoltage(double)" class="member-name-link">setVoltage</a><wbr>(double&nbsp;volts)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Run open loop at the specified voltage.</div>
</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="#updateInputs(frc.robot.subsystems.shooter.ShooterIO.ShooterIOInputs)" class="member-name-link">updateInputs</a><wbr>(<a href="ShooterIO.ShooterIOInputs.html" title="class in frc.robot.subsystems.shooter">ShooterIO.ShooterIOInputs</a>&nbsp;inputs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Updates the set of loggable inputs.</div>
</div>
</div>
</div>
</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>ShooterIOSparkMax</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ShooterIOSparkMax</span>()</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="updateInputs(frc.robot.subsystems.shooter.ShooterIO.ShooterIOInputs)">
<h3>updateInputs</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">updateInputs</span><wbr><span class="parameters">(<a href="ShooterIO.ShooterIOInputs.html" title="class in frc.robot.subsystems.shooter">ShooterIO.ShooterIOInputs</a>&nbsp;inputs)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ShooterIO.html#updateInputs(frc.robot.subsystems.shooter.ShooterIO.ShooterIOInputs)">ShooterIO</a></code></span></div>
<div class="block">Updates the set of loggable inputs.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ShooterIO.html#updateInputs(frc.robot.subsystems.shooter.ShooterIO.ShooterIOInputs)">updateInputs</a></code>&nbsp;in interface&nbsp;<code><a href="ShooterIO.html" title="interface in frc.robot.subsystems.shooter">ShooterIO</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setVoltage(double)">
<h3>setVoltage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setVoltage</span><wbr><span class="parameters">(double&nbsp;volts)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="ShooterIO.html#setVoltage(double)">ShooterIO</a></code></span></div>
<div class="block">Run open loop at the specified voltage.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="ShooterIO.html#setVoltage(double)">setVoltage</a></code>&nbsp;in interface&nbsp;<code><a href="ShooterIO.html" title="interface in frc.robot.subsystems.shooter">ShooterIO</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>
4 changes: 3 additions & 1 deletion javadoc/frc/robot/subsystems/shooter/package-summary.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,10 @@ <h1 title="Package frc.robot.subsystems.shooter" class="title">Package frc.robot
<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="ShooterIOSim.html" title="class in frc.robot.subsystems.shooter">ShooterIOSim</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="ShooterSubsystem.html" title="class in frc.robot.subsystems.shooter">ShooterSubsystem</a></div>
<div class="col-first even-row-color class-summary class-summary-tab2"><a href="ShooterIOSparkMax.html" title="class in frc.robot.subsystems.shooter">ShooterIOSparkMax</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="ShooterSubsystem.html" title="class in frc.robot.subsystems.shooter">ShooterSubsystem</a></div>
<div class="col-last odd-row-color class-summary class-summary-tab2">&nbsp;</div>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 5146d16

Please sign in to comment.