Skip to content

Commit

Permalink
Updated javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@fruzyna
fruzyna committed Sep 4, 2023
1 parent fa23f0b commit 35c9170
Show file tree
Hide file tree
Showing 198 changed files with 6,999 additions and 1,163 deletions.
258 changes: 149 additions & 109 deletions docs/allclasses-index.html
View file

Large diffs are not rendered by default.

16 changes: 12 additions & 4 deletions docs/allclasses.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Classes (rfmain API)</title>
<title>All Classes (robot_framework API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
Expand All @@ -14,12 +14,13 @@
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<main role="main">
<h1 class="bar">All&nbsp;Classes</h1>
<main role="main" class="indexContainer">
<div class="indexContainer">
<ul>
<li><a href="org/wildstang/framework/io/inputs/AnalogInput.html" title="class in org.wildstang.framework.io.inputs">AnalogInput</a></li>
<li><a href="org/wildstang/framework/io/outputs/AnalogOutput.html" title="class in org.wildstang.framework.io.outputs">AnalogOutput</a></li>
Expand All @@ -33,6 +34,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/framework/auto/steps/control/AutoStepDelay.html" title="class in org.wildstang.framework.auto.steps.control">AutoStepDelay</a></li>
<li><a href="org/wildstang/framework/auto/steps/control/AutoStepStopAutonomous.html" title="class in org.wildstang.framework.auto.steps.control">AutoStepStopAutonomous</a></li>
<li><a href="org/wildstang/framework/auto/BobTrajectory.html" title="class in org.wildstang.framework.auto">BobTrajectory</a></li>
<li><a href="org/wildstang/sample/robot/CANConstants.html" title="class in org.wildstang.sample.robot">CANConstants</a></li>
<li><a href="org/wildstang/framework/config/Config.html" title="class in org.wildstang.framework.config">Config</a></li>
<li><a href="org/wildstang/framework/config/ConfigManager.html" title="class in org.wildstang.framework.config">ConfigManager</a></li>
<li><a href="org/wildstang/framework/core/Core.html" title="class in org.wildstang.framework.core">Core</a></li>
Expand All @@ -55,6 +57,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/hardware/JoystickConstants.html" title="class in org.wildstang.hardware">JoystickConstants</a></li>
<li><a href="org/wildstang/framework/logger/Log.html" title="class in org.wildstang.framework.logger">Log</a></li>
<li><a href="org/wildstang/framework/logger/Log.LogLevel.html" title="enum in org.wildstang.framework.logger">Log.LogLevel</a></li>
<li><a href="org/wildstang/sample/robot/Main.html" title="class in org.wildstang.sample.robot">Main</a></li>
<li><a href="org/wildstang/framework/io/outputs/Output.html" title="class in org.wildstang.framework.io.outputs">Output</a></li>
<li><a href="org/wildstang/framework/hardware/OutputConfig.html" title="interface in org.wildstang.framework.hardware"><span class="interfaceName">OutputConfig</span></a></li>
<li><a href="org/wildstang/framework/hardware/OutputFactory.html" title="interface in org.wildstang.framework.hardware"><span class="interfaceName">OutputFactory</span></a></li>
Expand All @@ -69,6 +72,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/framework/pid/controller/PidStateType.html" title="enum in org.wildstang.framework.pid.controller">PidStateType</a></li>
<li><a href="org/wildstang/hardware/roborio/RoboRIOInputFactory.html" title="class in org.wildstang.hardware.roborio">RoboRIOInputFactory</a></li>
<li><a href="org/wildstang/hardware/roborio/RoboRIOOutputFactory.html" title="class in org.wildstang.hardware.roborio">RoboRIOOutputFactory</a></li>
<li><a href="org/wildstang/sample/robot/Robot.html" title="class in org.wildstang.sample.robot">Robot</a></li>
<li><a href="org/wildstang/framework/auto/steps/SetGyroStep.html" title="class in org.wildstang.framework.auto.steps">SetGyroStep</a></li>
<li><a href="org/wildstang/framework/auto/program/Sleeper.html" title="class in org.wildstang.framework.auto.program">Sleeper</a></li>
<li><a href="org/wildstang/framework/pid/controller/SpeedPidController.html" title="class in org.wildstang.framework.pid.controller">SpeedPidController</a></li>
Expand All @@ -78,7 +82,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/framework/subsystems/swerve/SwerveDriveTemplate.html" title="class in org.wildstang.framework.subsystems.swerve">SwerveDriveTemplate</a></li>
<li><a href="org/wildstang/framework/auto/steps/SwervePathFollowerStep.html" title="class in org.wildstang.framework.auto.steps">SwervePathFollowerStep</a></li>
<li><a href="org/wildstang/framework/subsystems/drive/TankPath.html" title="class in org.wildstang.framework.subsystems.drive">TankPath</a></li>
<li><a href="frc/paths/Test.html" title="class in frc.paths">Test</a></li>
<li><a href="org/wildstang/framework/subsystems/drive/Trajectory.html" title="class in org.wildstang.framework.subsystems.drive">Trajectory</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/WsAbsoluteEncoder.html" title="class in org.wildstang.hardware.roborio.inputs">WsAbsoluteEncoder</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/config/WsAbsoluteEncoderConfig.html" title="class in org.wildstang.hardware.roborio.inputs.config">WsAbsoluteEncoderConfig</a></li>
Expand All @@ -87,6 +90,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/hardware/roborio/inputs/WsAnalogInput.html" title="class in org.wildstang.hardware.roborio.inputs">WsAnalogInput</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/config/WsAnalogInputConfig.html" title="class in org.wildstang.hardware.roborio.inputs.config">WsAnalogInputConfig</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsAnalogOutputConfig.html" title="class in org.wildstang.hardware.roborio.outputs.config">WsAnalogOutputConfig</a></li>
<li><a href="org/wildstang/sample/robot/WSAutoPrograms.html" title="enum in org.wildstang.sample.robot">WSAutoPrograms</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/config/WsCameraInputConfig.html" title="class in org.wildstang.hardware.roborio.inputs.config">WsCameraInputConfig</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/WsContinuousI2CInput.html" title="class in org.wildstang.hardware.roborio.inputs">WsContinuousI2CInput</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/config/WsContinuousI2CInputConfig.html" title="class in org.wildstang.hardware.roborio.inputs.config">WsContinuousI2CInputConfig</a></li>
Expand All @@ -103,6 +107,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/hardware/roborio/inputs/config/WsI2CInputConfig.html" title="class in org.wildstang.hardware.roborio.inputs.config">WsI2CInputConfig</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/WsI2COutput.html" title="class in org.wildstang.hardware.roborio.outputs">WsI2COutput</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsI2COutputConfig.html" title="class in org.wildstang.hardware.roborio.outputs.config">WsI2COutputConfig</a></li>
<li><a href="org/wildstang/sample/robot/WSInputs.html" title="enum in org.wildstang.sample.robot">WSInputs</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/WsJoystickAxis.html" title="class in org.wildstang.hardware.roborio.inputs">WsJoystickAxis</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/WsJoystickButton.html" title="class in org.wildstang.hardware.roborio.inputs">WsJoystickButton</a></li>
<li><a href="org/wildstang/hardware/roborio/inputs/WsJoystickToggleButton.html" title="class in org.wildstang.hardware.roborio.inputs">WsJoystickToggleButton</a></li>
Expand All @@ -115,6 +120,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/hardware/roborio/inputs/config/WsMotionProfileInputConfig.html" title="class in org.wildstang.hardware.roborio.inputs.config">WsMotionProfileInputConfig</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/WsMotorController.html" title="class in org.wildstang.hardware.roborio.outputs">WsMotorController</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsMotorControllers.html" title="enum in org.wildstang.hardware.roborio.outputs.config">WsMotorControllers</a></li>
<li><a href="org/wildstang/sample/robot/WSOutputs.html" title="enum in org.wildstang.sample.robot">WSOutputs</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/WsPhoenix.html" title="class in org.wildstang.hardware.roborio.outputs">WsPhoenix</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsPhoenixConfig.html" title="class in org.wildstang.hardware.roborio.outputs.config">WsPhoenixConfig</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsPhoenixFollowerConfig.html" title="class in org.wildstang.hardware.roborio.outputs.config">WsPhoenixFollowerConfig</a></li>
Expand All @@ -136,7 +142,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="org/wildstang/hardware/roborio/outputs/WsSparkMax.html" title="class in org.wildstang.hardware.roborio.outputs">WsSparkMax</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsSparkMaxConfig.html" title="class in org.wildstang.hardware.roborio.outputs.config">WsSparkMaxConfig</a></li>
<li><a href="org/wildstang/hardware/roborio/outputs/config/WsSparkMaxFollowerConfig.html" title="class in org.wildstang.hardware.roborio.outputs.config">WsSparkMaxFollowerConfig</a></li>
<li><a href="org/wildstang/sample/robot/WSSubsystems.html" title="enum in org.wildstang.sample.robot">WSSubsystems</a></li>
</ul>
</div>
</main>
</body>
</html>
58 changes: 29 additions & 29 deletions docs/allpackages-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Packages (rfmain API)</title>
<title>All Packages (robot_framework API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
Expand All @@ -14,14 +14,14 @@
<!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="jquery/jquery-3.6.0.min.js"></script>
<script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Packages (rfmain API)";
parent.document.title="All Packages (robot_framework API)";
}
}
catch(err) {
Expand Down Expand Up @@ -106,107 +106,107 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="frc/paths/package-summary.html">frc.paths</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/package-summary.html">org.wildstang.framework</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/package-summary.html">org.wildstang.framework</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/package-summary.html">org.wildstang.framework.auto</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/package-summary.html">org.wildstang.framework.auto</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/program/package-summary.html">org.wildstang.framework.auto.program</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/program/package-summary.html">org.wildstang.framework.auto.program</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/steps/package-summary.html">org.wildstang.framework.auto.steps</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/steps/package-summary.html">org.wildstang.framework.auto.steps</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/steps/control/package-summary.html">org.wildstang.framework.auto.steps.control</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/auto/steps/control/package-summary.html">org.wildstang.framework.auto.steps.control</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/config/package-summary.html">org.wildstang.framework.config</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/config/package-summary.html">org.wildstang.framework.config</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/core/package-summary.html">org.wildstang.framework.core</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/core/package-summary.html">org.wildstang.framework.core</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/hardware/package-summary.html">org.wildstang.framework.hardware</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/hardware/package-summary.html">org.wildstang.framework.hardware</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/io/package-summary.html">org.wildstang.framework.io</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/io/package-summary.html">org.wildstang.framework.io</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/io/inputs/package-summary.html">org.wildstang.framework.io.inputs</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/io/inputs/package-summary.html">org.wildstang.framework.io.inputs</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/io/outputs/package-summary.html">org.wildstang.framework.io.outputs</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/io/outputs/package-summary.html">org.wildstang.framework.io.outputs</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/logger/package-summary.html">org.wildstang.framework.logger</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/logger/package-summary.html">org.wildstang.framework.logger</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/package-summary.html">org.wildstang.framework.pid</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/package-summary.html">org.wildstang.framework.pid</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/controller/package-summary.html">org.wildstang.framework.pid.controller</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/controller/package-summary.html">org.wildstang.framework.pid.controller</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/input/package-summary.html">org.wildstang.framework.pid.input</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/input/package-summary.html">org.wildstang.framework.pid.input</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/output/package-summary.html">org.wildstang.framework.pid.output</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/pid/output/package-summary.html">org.wildstang.framework.pid.output</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/subsystems/package-summary.html">org.wildstang.framework.subsystems</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/subsystems/package-summary.html">org.wildstang.framework.subsystems</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/subsystems/drive/package-summary.html">org.wildstang.framework.subsystems.drive</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/subsystems/drive/package-summary.html">org.wildstang.framework.subsystems.drive</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/framework/subsystems/swerve/package-summary.html">org.wildstang.framework.subsystems.swerve</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/framework/subsystems/swerve/package-summary.html">org.wildstang.framework.subsystems.swerve</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/package-summary.html">org.wildstang.hardware</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/package-summary.html">org.wildstang.hardware</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/package-summary.html">org.wildstang.hardware.roborio</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/package-summary.html">org.wildstang.hardware.roborio</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/inputs/package-summary.html">org.wildstang.hardware.roborio.inputs</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/inputs/package-summary.html">org.wildstang.hardware.roborio.inputs</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/inputs/config/package-summary.html">org.wildstang.hardware.roborio.inputs.config</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/inputs/config/package-summary.html">org.wildstang.hardware.roborio.inputs.config</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/outputs/package-summary.html">org.wildstang.hardware.roborio.outputs</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/outputs/package-summary.html">org.wildstang.hardware.roborio.outputs</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/outputs/config/package-summary.html">org.wildstang.hardware.roborio.outputs.config</a></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="org/wildstang/hardware/roborio/outputs/config/package-summary.html">org.wildstang.hardware.roborio.outputs.config</a></th>
<th class="colFirst" scope="row"><a href="org/wildstang/sample/robot/package-summary.html">org.wildstang.sample.robot</a></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
Expand Down
Loading

0 comments on commit 35c9170

Please sign in to comment.