Skip to content

Commit

Permalink
Publish docs from PathPlannerLib
Browse files Browse the repository at this point in the history
  • Loading branch information
@mjansen4857
mjansen4857 committed Oct 14, 2023
0 parents commit 98875ec
Show file tree
Hide file tree
Showing 386 changed files with 84,617 additions and 0 deletions.
280 changes: 280 additions & 0 deletions docs/cpp/ADStar_8h_source.html

Large diffs are not rendered by default.

215 changes: 215 additions & 0 deletions docs/cpp/AutoBuilder_8h_source.html

Large diffs are not rendered by default.

180 changes: 180 additions & 0 deletions docs/cpp/ChassisSpeedsRateLimiter_8h_source.html

Large diffs are not rendered by default.

139 changes: 139 additions & 0 deletions docs/cpp/CommandUtil_8h_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PathPlannerLib: src/main/native/include/pathplanner/lib/auto/CommandUtil.h 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="doxygen-awesome.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 id="projectrow">
<td id="projectalign">
<div id="projectname">PathPlannerLib
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('CommandUtil_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
<div class="headertitle"><div class="title">CommandUtil.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;wpi/json.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;frc2/command/Command.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span>pathplanner {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"><a class="line" href="classpathplanner_1_1CommandUtil.html"> 8</a></span><span class="keyword">class </span><a class="code hl_class" href="classpathplanner_1_1CommandUtil.html">CommandUtil</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">static</span> frc2::CommandPtr <a class="code hl_function" href="classpathplanner_1_1CommandUtil.html#a084caee4b421f3596d4a9d0e8bc6b82e">wrappedEventCommand</a>(</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> std::shared_ptr&lt;frc2::Command&gt; command);</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">static</span> frc2::CommandPtr <a class="code hl_function" href="classpathplanner_1_1CommandUtil.html#a1242839afe67a5c778da2d905818b2f4">commandFromJson</a>(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">static</span> frc2::CommandPtr waitCommandFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> frc2::CommandPtr namedCommandFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">static</span> frc2::CommandPtr pathCommandFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">static</span> frc2::CommandPtr sequentialGroupFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">static</span> frc2::CommandPtr parallelGroupFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">static</span> frc2::CommandPtr raceGroupFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">static</span> frc2::CommandPtr deadlineGroupFromJson(<span class="keyword">const</span> wpi::json &amp;json);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>};</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>}</div>
<div class="ttc" id="aclasspathplanner_1_1CommandUtil_html"><div class="ttname"><a href="classpathplanner_1_1CommandUtil.html">pathplanner::CommandUtil</a></div><div class="ttdef"><b>Definition:</b> CommandUtil.h:8</div></div>
<div class="ttc" id="aclasspathplanner_1_1CommandUtil_html_a084caee4b421f3596d4a9d0e8bc6b82e"><div class="ttname"><a href="classpathplanner_1_1CommandUtil.html#a084caee4b421f3596d4a9d0e8bc6b82e">pathplanner::CommandUtil::wrappedEventCommand</a></div><div class="ttdeci">static frc2::CommandPtr wrappedEventCommand(std::shared_ptr&lt; frc2::Command &gt; command)</div><div class="ttdef"><b>Definition:</b> CommandUtil.cpp:11</div></div>
<div class="ttc" id="aclasspathplanner_1_1CommandUtil_html_a1242839afe67a5c778da2d905818b2f4"><div class="ttname"><a href="classpathplanner_1_1CommandUtil.html#a1242839afe67a5c778da2d905818b2f4">pathplanner::CommandUtil::commandFromJson</a></div><div class="ttdeci">static frc2::CommandPtr commandFromJson(const wpi::json &amp;json)</div><div class="ttdef"><b>Definition:</b> CommandUtil.cpp:31</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<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_b09f3849ec87f7f01357d2c1b28ddfb1.html">native</a></li><li class="navelem"><a class="el" href="dir_34a15534b0ba644081206e4286ea6115.html">include</a></li><li class="navelem"><a class="el" href="dir_9928c8ff9a485b7ddff02877d2a05a10.html">pathplanner</a></li><li class="navelem"><a class="el" href="dir_13948881c4c0769b2e268e8b81181ef8.html">lib</a></li><li class="navelem"><a class="el" href="dir_c2a4c57c2fee12ede795dfa3b4f6ba03.html">auto</a></li><li class="navelem"><b>CommandUtil.h</b></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5 </li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit 98875ec

Please sign in to comment.