Skip to content
This repository has been archived by the owner on Nov 2, 2023. It is now read-only.

Commit

Permalink
Document all the things
Browse files Browse the repository at this point in the history
  • Loading branch information
@ewpratten
ewpratten committed Sep 23, 2018
1 parent db22e69 commit e3f9bda
Show file tree
Hide file tree
Showing 183 changed files with 15,429 additions and 0 deletions.
82 changes: 82 additions & 0 deletions docs/html/Auto_8hpp_source.html
View file
@@ -0,0 +1,82 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BarebonesFRC: src/main/include/Commands/Autonomous/CommandGroups/Auto.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BarebonesFRC
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5eb159725f84c66aafd839904a4acdd0.html">main</a></li><li class="navelem"><a class="el" href="dir_df3bee86fdbfb464c3a94507855b0bdc.html">include</a></li><li class="navelem"><a class="el" href="dir_cc1209c02c45230b6482516732d65751.html">Commands</a></li><li class="navelem"><a class="el" href="dir_3e2c9bf601d09a882ec5a1035d60eb1b.html">Autonomous</a></li><li class="navelem"><a class="el" href="dir_b8664fb7acf596d862ef949a8a2fbeba.html">CommandGroups</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Auto.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef _JUST_DRIVE_FORWARD_HG_</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define _JUST_DRIVE_FORWARD_HG_</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;Commands/CommandGroup.h&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="classJustDriveForward.html"> 6</a></span>&#160;<span class="keyword">class </span><a class="code" href="classJustDriveForward.html">JustDriveForward</a>: <span class="keyword">public</span> frc::CommandGroup {</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; <a class="code" href="classJustDriveForward.html#ade55362020dc8678cc1d0ccd6a36a8da">JustDriveForward</a>();</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;};</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classJustDriveForward_html"><div class="ttname"><a href="classJustDriveForward.html">JustDriveForward</a></div><div class="ttdef"><b>Definition:</b> Auto.hpp:6</div></div>
<div class="ttc" id="classJustDriveForward_html_ade55362020dc8678cc1d0ccd6a36a8da"><div class="ttname"><a href="classJustDriveForward.html#ade55362020dc8678cc1d0ccd6a36a8da">JustDriveForward::JustDriveForward</a></div><div class="ttdeci">JustDriveForward()</div><div class="ttdef"><b>Definition:</b> Auto.cpp:4</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
80 changes: 80 additions & 0 deletions docs/html/CVServer_8hpp_source.html
View file
@@ -0,0 +1,80 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BarebonesFRC: src/main/include/Subsystems/CVServer.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BarebonesFRC
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5eb159725f84c66aafd839904a4acdd0.html">main</a></li><li class="navelem"><a class="el" href="dir_df3bee86fdbfb464c3a94507855b0bdc.html">include</a></li><li class="navelem"><a class="el" href="dir_722972e7b214f0021fb9fa10ce7918e4.html">Subsystems</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CVServer.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#include &lt;tuple&gt;</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="preprocessor">#include &lt;WPILib.h&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;ntcore.h&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;std::tuple&lt;double, double&gt; GetMotorSpeeds(std::shared_ptr&lt;NetworkTable&gt; &amp;ntable);</div></div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
89 changes: 89 additions & 0 deletions docs/html/CommandBase_8hpp_source.html
View file
@@ -0,0 +1,89 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>BarebonesFRC: src/main/include/CommandBase.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BarebonesFRC
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5eb159725f84c66aafd839904a4acdd0.html">main</a></li><li class="navelem"><a class="el" href="dir_df3bee86fdbfb464c3a94507855b0bdc.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">CommandBase.hpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef _COMMANDBASE_HG_</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define _COMMANDBASE_HG_</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &lt;OI.hpp&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#include &lt;Subsystems/DriveTrain.hpp&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#include &lt;Subsystems/Generic.hpp&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;WPILib.h&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &quot;Commands/Command.h&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classCommandBase.html"> 10</a></span>&#160;<span class="keyword">class </span><a class="code" href="classCommandBase.html">CommandBase</a>: <span class="keyword">public</span> frc::Command {</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; <a class="code" href="classCommandBase.html#af42de9fe79dc64fce99580ee1e2f678f">CommandBase</a>();</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <a class="code" href="classCommandBase.html#a0268f581df9f534ca703248a06e70e93">~CommandBase</a>();</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="classCommandBase.html#a378aea1c2b30c10b8345477508f9342c"> 15</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classOI.html">OI</a>* <a class="code" href="classCommandBase.html#a378aea1c2b30c10b8345477508f9342c">pOI</a>;</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classCommandBase.html#a4a9fa7804291eb70ccfb0ffc15c48f79"> 16</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classDriveTrain.html">DriveTrain</a>* <a class="code" href="classCommandBase.html#a4a9fa7804291eb70ccfb0ffc15c48f79">pDriveTrain</a>;</div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="classCommandBase.html#aba36a8427c251379a08938ebe5a06c2c"> 17</a></span>&#160; <span class="keyword">static</span> <a class="code" href="classGeneric.html">Generic</a>* <a class="code" href="classCommandBase.html#aba36a8427c251379a08938ebe5a06c2c">pGeneric</a>;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;};</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="classCommandBase_html_aba36a8427c251379a08938ebe5a06c2c"><div class="ttname"><a href="classCommandBase.html#aba36a8427c251379a08938ebe5a06c2c">CommandBase::pGeneric</a></div><div class="ttdeci">static Generic * pGeneric</div><div class="ttdef"><b>Definition:</b> CommandBase.hpp:17</div></div>
<div class="ttc" id="classCommandBase_html_af42de9fe79dc64fce99580ee1e2f678f"><div class="ttname"><a href="classCommandBase.html#af42de9fe79dc64fce99580ee1e2f678f">CommandBase::CommandBase</a></div><div class="ttdeci">CommandBase()</div><div class="ttdef"><b>Definition:</b> CommandBase.cpp:12</div></div>
<div class="ttc" id="classCommandBase_html_a378aea1c2b30c10b8345477508f9342c"><div class="ttname"><a href="classCommandBase.html#a378aea1c2b30c10b8345477508f9342c">CommandBase::pOI</a></div><div class="ttdeci">static OI * pOI</div><div class="ttdef"><b>Definition:</b> CommandBase.hpp:15</div></div>
<div class="ttc" id="classCommandBase_html_a0268f581df9f534ca703248a06e70e93"><div class="ttname"><a href="classCommandBase.html#a0268f581df9f534ca703248a06e70e93">CommandBase::~CommandBase</a></div><div class="ttdeci">~CommandBase()</div><div class="ttdef"><b>Definition:</b> CommandBase.cpp:37</div></div>
<div class="ttc" id="classDriveTrain_html"><div class="ttname"><a href="classDriveTrain.html">DriveTrain</a></div><div class="ttdef"><b>Definition:</b> DriveTrain.hpp:13</div></div>
<div class="ttc" id="classOI_html"><div class="ttname"><a href="classOI.html">OI</a></div><div class="ttdef"><b>Definition:</b> OI.hpp:7</div></div>
<div class="ttc" id="classGeneric_html"><div class="ttname"><a href="classGeneric.html">Generic</a></div><div class="ttdef"><b>Definition:</b> Generic.hpp:10</div></div>
<div class="ttc" id="classCommandBase_html"><div class="ttname"><a href="classCommandBase.html">CommandBase</a></div><div class="ttdef"><b>Definition:</b> CommandBase.hpp:10</div></div>
<div class="ttc" id="classCommandBase_html_a4a9fa7804291eb70ccfb0ffc15c48f79"><div class="ttname"><a href="classCommandBase.html#a4a9fa7804291eb70ccfb0ffc15c48f79">CommandBase::pDriveTrain</a></div><div class="ttdeci">static DriveTrain * pDriveTrain</div><div class="ttdef"><b>Definition:</b> CommandBase.hpp:16</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>

0 comments on commit e3f9bda

Please sign in to comment.