Skip to content

Commit d976c22

Browse files
studentkriskstudentkrisk
committed
javadocs setup part 2
1 parent da72d2a commit d976c22

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+6257
-1
lines changed

‎.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,8 @@ $RECYCLE.BIN/
137137

138138
### Gradle ###
139139
.gradle
140-
/build/
140+
/build/*
141+
!/build/docs
141142

142143
# Ignore Gradle GUI config
143144
gradle-app.setting

‎build/docs/javadoc/allclasses-index.html

+97
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) -->
5+
<title>All Classes and Interfaces (2023-TShirtCannon-Imported API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="description" content="class index">
9+
<meta name="generator" content="javadoc/AllClassesIndexWriter">
10+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-classes-index-page">
18+
<script type="text/javascript">var pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top">
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="index.html">Overview</a></li>
31+
<li>Package</li>
32+
<li>Class</li>
33+
<li><a href="overview-tree.html">Tree</a></li>
34+
<li><a href="index-all.html">Index</a></li>
35+
<li><a href="help-doc.html#all-classes">Help</a></li>
36+
</ul>
37+
</div>
38+
<div class="sub-nav">
39+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
40+
<input type="text" id="search-input" value="search" disabled="disabled">
41+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
42+
</div>
43+
</div>
44+
<!-- ========= END OF TOP NAVBAR ========= -->
45+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
46+
</header>
47+
<div class="flex-content">
48+
<main role="main">
49+
<div class="header">
50+
<h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1>
51+
</div>
52+
<div id="all-classes-table">
53+
<div class="caption"><span>Classes</span></div>
54+
<div class="summary-table two-column-summary">
55+
<div class="table-header col-first">Class</div>
56+
<div class="table-header col-last">Description</div>
57+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/Angle.html" title="class in frc.robot.commands">Angle</a></div>
58+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
59+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/Cannon.html" title="class in frc.robot.subsystems">Cannon</a></div>
60+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
61+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.html" title="class in frc.robot">Constants</a></div>
62+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
63+
<div class="block">The Constants class provides a convenient place for teams to hold robot-wide numerical or boolean
64+
constants.</div>
65+
</div>
66+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.OIConstants.html" title="class in frc.robot">Constants.OIConstants</a></div>
67+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
68+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.PortConstants.html" title="class in frc.robot">Constants.PortConstants</a></div>
69+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
70+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Constants.RobotConstants.html" title="class in frc.robot">Constants.RobotConstants</a></div>
71+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
72+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/subsystems/DriveTrain.html" title="class in frc.robot.subsystems">DriveTrain</a></div>
73+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
74+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Main.html" title="class in frc.robot">Main</a></div>
75+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
76+
<div class="block">Do NOT add any static variables to this class, or any initialization at all.</div>
77+
</div>
78+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/Robot.html" title="class in frc.robot">Robot</a></div>
79+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
80+
<div class="block">The VM is configured to automatically run this class, and to call the functions corresponding to
81+
each mode, as described in the TimedRobot documentation.</div>
82+
</div>
83+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/RobotContainer.html" title="class in frc.robot">RobotContainer</a></div>
84+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">
85+
<div class="block">This class is where the bulk of the robot should be declared.</div>
86+
</div>
87+
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/Shoot.html" title="class in frc.robot.commands">Shoot</a></div>
88+
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
89+
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="frc/robot/commands/Turn.html" title="class in frc.robot.commands">Turn</a></div>
90+
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
91+
</div>
92+
</div>
93+
</main>
94+
</div>
95+
</div>
96+
</body>
97+
</html>

‎build/docs/javadoc/allpackages-index.html

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en">
3+
<head>
4+
<!-- Generated by javadoc (17) -->
5+
<title>All Packages (2023-TShirtCannon-Imported API)</title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1">
7+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8+
<meta name="description" content="package index">
9+
<meta name="generator" content="javadoc/AllPackagesIndexWriter">
10+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
11+
<link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style">
12+
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
13+
<script type="text/javascript" src="script.js"></script>
14+
<script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script>
15+
<script type="text/javascript" src="script-dir/jquery-ui.min.js"></script>
16+
</head>
17+
<body class="all-packages-index-page">
18+
<script type="text/javascript">var pathtoroot = "./";
19+
loadScripts(document, 'script');</script>
20+
<noscript>
21+
<div>JavaScript is disabled on your browser.</div>
22+
</noscript>
23+
<div class="flex-box">
24+
<header role="banner" class="flex-header">
25+
<nav role="navigation">
26+
<!-- ========= START OF TOP NAVBAR ======= -->
27+
<div class="top-nav" id="navbar-top">
28+
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
29+
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
30+
<li><a href="index.html">Overview</a></li>
31+
<li>Package</li>
32+
<li>Class</li>
33+
<li><a href="overview-tree.html">Tree</a></li>
34+
<li><a href="index-all.html">Index</a></li>
35+
<li><a href="help-doc.html#all-packages">Help</a></li>
36+
</ul>
37+
</div>
38+
<div class="sub-nav">
39+
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
40+
<input type="text" id="search-input" value="search" disabled="disabled">
41+
<input type="reset" id="reset-button" value="reset" disabled="disabled">
42+
</div>
43+
</div>
44+
<!-- ========= END OF TOP NAVBAR ========= -->
45+
<span class="skip-nav" id="skip-navbar-top"></span></nav>
46+
</header>
47+
<div class="flex-content">
48+
<main role="main">
49+
<div class="header">
50+
<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
51+
</div>
52+
<div class="caption"><span>Package Summary</span></div>
53+
<div class="summary-table two-column-summary">
54+
<div class="table-header col-first">Package</div>
55+
<div class="table-header col-last">Description</div>
56+
<div class="col-first even-row-color"><a href="frc/robot/package-summary.html">frc.robot</a></div>
57+
<div class="col-last even-row-color">&nbsp;</div>
58+
<div class="col-first odd-row-color"><a href="frc/robot/commands/package-summary.html">frc.robot.commands</a></div>
59+
<div class="col-last odd-row-color">&nbsp;</div>
60+
<div class="col-first even-row-color"><a href="frc/robot/subsystems/package-summary.html">frc.robot.subsystems</a></div>
61+
<div class="col-last even-row-color">&nbsp;</div>
62+
</div>
63+
</main>
64+
</div>
65+
</div>
66+
</body>
67+
</html>

0 commit comments

Comments
 (0)