Skip to content

Commit

Permalink
New documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@gchallen
gchallen committed Sep 11, 2017
1 parent a70826b commit b5dcb11
Show file tree
Hide file tree
Showing 19 changed files with 1,104 additions and 78 deletions.
4 changes: 1 addition & 3 deletions config/checkstyle/checkstyle.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,7 @@

<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<module name="JavadocMethod">
<property name="allowMissingThrowsTags" value="true"/>
</module>
<module name="JavadocMethod"/>
<module name="JavadocType"/>
<module name="JavadocVariable"/>
<module name="JavadocStyle"/>
Expand Down
6 changes: 3 additions & 3 deletions docs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 15:30:41 CDT 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 17:35:20 CDT 2017 -->
<title>All Classes (mazemaker API)</title>
<meta name="date" content="2017-09-11">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -13,9 +13,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.html" title="class in edu.illinois.cs.cs125.lib.mazemaker" target="classFrame">Maze</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.DimensionException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker" target="classFrame">Maze.DimensionException</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.DirectionException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker" target="classFrame">Maze.DirectionException</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.ValidationException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker" target="classFrame">Maze.ValidationException</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.Location.html" title="class in edu.illinois.cs.cs125.lib.mazemaker" target="classFrame">Maze.Location</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.LocationException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker" target="classFrame">Maze.LocationException</a></li>
</ul>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions docs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 15:30:41 CDT 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 17:35:20 CDT 2017 -->
<title>All Classes (mazemaker API)</title>
<meta name="date" content="2017-09-11">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand All @@ -13,9 +13,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.html" title="class in edu.illinois.cs.cs125.lib.mazemaker">Maze</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.DimensionException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker">Maze.DimensionException</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.DirectionException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker">Maze.DirectionException</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.ValidationException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker">Maze.ValidationException</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.Location.html" title="class in edu.illinois.cs.cs125.lib.mazemaker">Maze.Location</a></li>
<li><a href="edu/illinois/cs/cs125/lib/mazemaker/Maze.LocationException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker">Maze.LocationException</a></li>
</ul>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 15:30:41 CDT 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 17:35:20 CDT 2017 -->
<title>Constant Field Values (mazemaker API)</title>
<meta name="date" content="2017-09-11">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
2 changes: 1 addition & 1 deletion docs/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 15:30:41 CDT 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 17:35:20 CDT 2017 -->
<title>Deprecated List (mazemaker API)</title>
<meta name="date" content="2017-09-11">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
Expand Down
10 changes: 5 additions & 5 deletions docs/edu/illinois/cs/cs125/lib/mazemaker/Maze.DirectionException.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 15:30:41 CDT 2017 -->
<!-- Generated by javadoc (1.8.0_144) on Mon Sep 11 17:35:20 CDT 2017 -->
<title>Maze.DirectionException (mazemaker API)</title>
<meta name="date" content="2017-09-11">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
Expand Down Expand Up @@ -41,8 +41,8 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.DimensionException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.ValidationException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.Location.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?edu/illinois/cs/cs125/lib/mazemaker/Maze.DirectionException.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -178,8 +178,8 @@ <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.DimensionException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.ValidationException.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../../edu/illinois/cs/cs125/lib/mazemaker/Maze.Location.html" title="class in edu.illinois.cs.cs125.lib.mazemaker"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?edu/illinois/cs/cs125/lib/mazemaker/Maze.DirectionException.html" target="_top">Frames</a></li>
Expand Down
Loading

0 comments on commit b5dcb11

Please sign in to comment.