-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #133 from IUS-CS/doc/API-docs
Doc/api docs
- Loading branch information
Showing
86 changed files
with
11,197 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en"> | ||
| <head> | ||
| <!-- Generated by javadoc (17) on Tue Dec 05 19:07:52 EST 2023 --> | ||
| <title>All Classes and Interfaces</title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="dc.created" content="2023-12-05"> | ||
| <meta name="description" content="class index"> | ||
| <meta name="generator" content="javadoc/AllClassesIndexWriter"> | ||
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> | ||
| <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> | ||
| <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> | ||
| <script type="text/javascript" src="script.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> | ||
| </head> | ||
| <body class="all-classes-index-page"> | ||
| <script type="text/javascript">var evenRowColor = "even-row-color"; | ||
| var oddRowColor = "odd-row-color"; | ||
| var tableTab = "table-tab"; | ||
| var activeTableTab = "active-table-tab"; | ||
| var pathtoroot = "./"; | ||
| loadScripts(document, 'script');</script> | ||
| <noscript> | ||
| <div>JavaScript is disabled on your browser.</div> | ||
| </noscript> | ||
| <div class="flex-box"> | ||
| <header role="banner" class="flex-header"> | ||
| <nav role="navigation"> | ||
| <!-- ========= START OF TOP NAVBAR ======= --> | ||
| <div class="top-nav" id="navbar-top"> | ||
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> | ||
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> | ||
| <li><a href="index.html">Overview</a></li> | ||
| <li>Package</li> | ||
| <li>Class</li> | ||
| <li><a href="overview-tree.html">Tree</a></li> | ||
| <li><a href="index-files/index-1.html">Index</a></li> | ||
| <li><a href="help-doc.html#all-classes">Help</a></li> | ||
| </ul> | ||
| </div> | ||
| <div class="sub-nav"> | ||
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> | ||
| <input type="text" id="search-input" value="search" disabled="disabled"> | ||
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> | ||
| </div> | ||
| </div> | ||
| <!-- ========= END OF TOP NAVBAR ========= --> | ||
| <span class="skip-nav" id="skip-navbar-top"></span></nav> | ||
| </header> | ||
| <div class="flex-content"> | ||
| <main role="main"> | ||
| <div class="header"> | ||
| <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces</h1> | ||
| </div> | ||
| <div id="all-classes-table"> | ||
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="all-classes-table-tab0" role="tab" aria-selected="true" aria-controls="all-classes-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table', 2)" class="active-table-tab">All Classes and Interfaces</button><button id="all-classes-table-tab2" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab2', 2)" class="table-tab">Classes</button><button id="all-classes-table-tab3" role="tab" aria-selected="false" aria-controls="all-classes-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('all-classes-table', 'all-classes-table-tab3', 2)" class="table-tab">Enum Classes</button></div> | ||
| <div id="all-classes-table.tabpanel" role="tabpanel"> | ||
| <div class="summary-table two-column-summary" aria-labelledby="all-classes-table-tab0"> | ||
| <div class="table-header col-first">Class</div> | ||
| <div class="table-header col-last">Description</div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/AbstractAnimal.html" title="class in team.rocket.Entities">AbstractAnimal</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/AbstractOrganism.html" title="class in team.rocket.Entities">AbstractOrganism</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/AbstractPlant.html" title="class in team.rocket.Entities">AbstractPlant</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/Carrot.html" title="class in team.rocket.Entities">Carrot</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/Terminal/DaysPerRunFlagHandler.html" title="class in team.rocket.IO.Terminal">DaysPerRunFlagHandler</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Handles the DaysPerRun Flag | ||
| Ex: --days_amount 8</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab3"><a href="team/rocket/Enums/Direction.html" title="enum class in team.rocket.Enums">Direction</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab3"> </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/Terminal/FlagHandler.html" title="class in team.rocket.IO.Terminal">FlagHandler</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Largely based on <a href="https://www.oodesign.com/chain-of-responsibility-pattern">OODesign Chain of Responsibility</a>.</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/Fox.html" title="class in team.rocket.Entities">Fox</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/Grass.html" title="class in team.rocket.Entities">Grass</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/Terminal/GridSizeFlagHandler.html" title="class in team.rocket.IO.Terminal">GridSizeFlagHandler</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Handles Grid Size Flags | ||
| Ex --grid_width 55 --grid_height 35</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/Terminal/InitialOrganismCountFlagHandler.html" title="class in team.rocket.IO.Terminal">InitialOrganismCountFlagHandler</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Handles Terminal Flags that pertain to initial Organism Count | ||
| Will put an initial amount of Organisms onto the map | ||
| Ex: --rabbit_count 6</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Map.html" title="class in team.rocket">Map</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">A team.rocket.Map contains the information about the arrangement of a set of simulated organisms.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/OrganismFactory.html" title="class in team.rocket.Entities">OrganismFactory</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Imitating <a href="https://www.oodesign.com/singleton-pattern">Singleton</a> | ||
| Creates new objects of organisms after they've been registered</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Entities/Rabbit.html" title="class in team.rocket.Entities">Rabbit</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/util/RandomManager.html" title="class in team.rocket.util">RandomManager</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">A utility class for the Random java tool</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/Simulation.html" title="class in team.rocket">Simulation</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">team.rocket.Simulation is the class that controls the backend of the simulation.</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/Terminal/TerminalFlagRequest.html" title="class in team.rocket.IO.Terminal">TerminalFlagRequest</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">A request to be used with the Terminal FlagHandlers</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/util/TimeManager.html" title="class in team.rocket.util">TimeManager</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Handles Getting the time and makes it require less instantiation</div> | ||
| </div> | ||
| <div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/Terminal/TimeStepsPerDayFlagHandler.html" title="class in team.rocket.IO.Terminal">TimeStepsPerDayFlagHandler</a></div> | ||
| <div class="col-last even-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">Handles the TimeStepsPerDay flag | ||
| Ex: --steps_per_day 12</div> | ||
| </div> | ||
| <div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="team/rocket/IO/UI.html" title="class in team.rocket.IO">UI</a></div> | ||
| <div class="col-last odd-row-color all-classes-table all-classes-table-tab2"> | ||
| <div class="block">UI is the standard entry point for using the simulation.</div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </main> | ||
| </div> | ||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en"> | ||
| <head> | ||
| <!-- Generated by javadoc (17) on Tue Dec 05 19:07:52 EST 2023 --> | ||
| <title>All Packages</title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="dc.created" content="2023-12-05"> | ||
| <meta name="description" content="package index"> | ||
| <meta name="generator" content="javadoc/AllPackagesIndexWriter"> | ||
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> | ||
| <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> | ||
| <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> | ||
| <script type="text/javascript" src="script.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> | ||
| </head> | ||
| <body class="all-packages-index-page"> | ||
| <script type="text/javascript">var pathtoroot = "./"; | ||
| loadScripts(document, 'script');</script> | ||
| <noscript> | ||
| <div>JavaScript is disabled on your browser.</div> | ||
| </noscript> | ||
| <div class="flex-box"> | ||
| <header role="banner" class="flex-header"> | ||
| <nav role="navigation"> | ||
| <!-- ========= START OF TOP NAVBAR ======= --> | ||
| <div class="top-nav" id="navbar-top"> | ||
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> | ||
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> | ||
| <li><a href="index.html">Overview</a></li> | ||
| <li>Package</li> | ||
| <li>Class</li> | ||
| <li><a href="overview-tree.html">Tree</a></li> | ||
| <li><a href="index-files/index-1.html">Index</a></li> | ||
| <li><a href="help-doc.html#all-packages">Help</a></li> | ||
| </ul> | ||
| </div> | ||
| <div class="sub-nav"> | ||
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> | ||
| <input type="text" id="search-input" value="search" disabled="disabled"> | ||
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> | ||
| </div> | ||
| </div> | ||
| <!-- ========= END OF TOP NAVBAR ========= --> | ||
| <span class="skip-nav" id="skip-navbar-top"></span></nav> | ||
| </header> | ||
| <div class="flex-content"> | ||
| <main role="main"> | ||
| <div class="header"> | ||
| <h1 title="All&nbsp;Packages" class="title">All Packages</h1> | ||
| </div> | ||
| <div class="caption"><span>Package Summary</span></div> | ||
| <div class="summary-table two-column-summary"> | ||
| <div class="table-header col-first">Package</div> | ||
| <div class="table-header col-last">Description</div> | ||
| <div class="col-first even-row-color"><a href="team/rocket/package-summary.html">team.rocket</a></div> | ||
| <div class="col-last even-row-color"> </div> | ||
| <div class="col-first odd-row-color"><a href="team/rocket/Entities/package-summary.html">team.rocket.Entities</a></div> | ||
| <div class="col-last odd-row-color"> </div> | ||
| <div class="col-first even-row-color"><a href="team/rocket/Enums/package-summary.html">team.rocket.Enums</a></div> | ||
| <div class="col-last even-row-color"> </div> | ||
| <div class="col-first odd-row-color"><a href="team/rocket/IO/package-summary.html">team.rocket.IO</a></div> | ||
| <div class="col-last odd-row-color"> </div> | ||
| <div class="col-first even-row-color"><a href="team/rocket/IO/Terminal/package-summary.html">team.rocket.IO.Terminal</a></div> | ||
| <div class="col-last even-row-color"> </div> | ||
| <div class="col-first odd-row-color"><a href="team/rocket/util/package-summary.html">team.rocket.util</a></div> | ||
| <div class="col-last odd-row-color"> </div> | ||
| </div> | ||
| </main> | ||
| </div> | ||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <!DOCTYPE HTML> | ||
| <html lang="en"> | ||
| <head> | ||
| <!-- Generated by javadoc (17) on Tue Dec 05 19:07:52 EST 2023 --> | ||
| <title>Constant Field Values</title> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="dc.created" content="2023-12-05"> | ||
| <meta name="description" content="summary of constants"> | ||
| <meta name="generator" content="javadoc/ConstantsSummaryWriterImpl"> | ||
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> | ||
| <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> | ||
| <link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style"> | ||
| <script type="text/javascript" src="script.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-3.6.1.min.js"></script> | ||
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> | ||
| </head> | ||
| <body class="constants-summary-page"> | ||
| <script type="text/javascript">var pathtoroot = "./"; | ||
| loadScripts(document, 'script');</script> | ||
| <noscript> | ||
| <div>JavaScript is disabled on your browser.</div> | ||
| </noscript> | ||
| <div class="flex-box"> | ||
| <header role="banner" class="flex-header"> | ||
| <nav role="navigation"> | ||
| <!-- ========= START OF TOP NAVBAR ======= --> | ||
| <div class="top-nav" id="navbar-top"> | ||
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> | ||
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> | ||
| <li><a href="index.html">Overview</a></li> | ||
| <li>Package</li> | ||
| <li>Class</li> | ||
| <li><a href="overview-tree.html">Tree</a></li> | ||
| <li><a href="index-files/index-1.html">Index</a></li> | ||
| <li><a href="help-doc.html#constant-values">Help</a></li> | ||
| </ul> | ||
| </div> | ||
| <div class="sub-nav"> | ||
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> | ||
| <input type="text" id="search-input" value="search" disabled="disabled"> | ||
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> | ||
| </div> | ||
| </div> | ||
| <!-- ========= END OF TOP NAVBAR ========= --> | ||
| <span class="skip-nav" id="skip-navbar-top"></span></nav> | ||
| </header> | ||
| <div class="flex-content"> | ||
| <main role="main"> | ||
| <div class="header"> | ||
| <h1 title="Constant Field Values" class="title">Constant Field Values</h1> | ||
| <section class="packages"> | ||
| <h2 title="Contents">Contents</h2> | ||
| <ul> | ||
| <li><a href="#team.rocket">team.rocket.*</a></li> | ||
| </ul> | ||
| </section> | ||
| </div> | ||
| <section class="constants-summary" id="team.rocket"> | ||
| <h2 title="team.rocket">team.rocket.*</h2> | ||
| <ul class="block-list"> | ||
| <li> | ||
| <div class="caption"><span>team.rocket.<a href="team/rocket/Map.html" title="class in team.rocket">Map</a></span></div> | ||
| <div class="summary-table three-column-summary"> | ||
| <div class="table-header col-first">Modifier and Type</div> | ||
| <div class="table-header col-second">Constant Field</div> | ||
| <div class="table-header col-last">Value</div> | ||
| <div class="col-first even-row-color"><code id="team.rocket.Map.DEFAULT_HEIGHT">public static final int</code></div> | ||
| <div class="col-second even-row-color"><code><a href="team/rocket/Map.html#DEFAULT_HEIGHT">DEFAULT_HEIGHT</a></code></div> | ||
| <div class="col-last even-row-color"><code>5</code></div> | ||
| <div class="col-first odd-row-color"><code id="team.rocket.Map.DEFAULT_WIDTH">public static final int</code></div> | ||
| <div class="col-second odd-row-color"><code><a href="team/rocket/Map.html#DEFAULT_WIDTH">DEFAULT_WIDTH</a></code></div> | ||
| <div class="col-last odd-row-color"><code>5</code></div> | ||
| </div> | ||
| </li> | ||
| <li> | ||
| <div class="caption"><span>team.rocket.<a href="team/rocket/Simulation.html" title="class in team.rocket">Simulation</a></span></div> | ||
| <div class="summary-table three-column-summary"> | ||
| <div class="table-header col-first">Modifier and Type</div> | ||
| <div class="table-header col-second">Constant Field</div> | ||
| <div class="table-header col-last">Value</div> | ||
| <div class="col-first even-row-color"><code id="team.rocket.Simulation.DEFAULT_DAYS_PER_RUN">public static final int</code></div> | ||
| <div class="col-second even-row-color"><code><a href="team/rocket/Simulation.html#DEFAULT_DAYS_PER_RUN">DEFAULT_DAYS_PER_RUN</a></code></div> | ||
| <div class="col-last even-row-color"><code>10</code></div> | ||
| <div class="col-first odd-row-color"><code id="team.rocket.Simulation.DEFAULT_MILLISECONDS_PER_TIME_STEP">public static final int</code></div> | ||
| <div class="col-second odd-row-color"><code><a href="team/rocket/Simulation.html#DEFAULT_MILLISECONDS_PER_TIME_STEP">DEFAULT_MILLISECONDS_PER_TIME_STEP</a></code></div> | ||
| <div class="col-last odd-row-color"><code>100</code></div> | ||
| <div class="col-first even-row-color"><code id="team.rocket.Simulation.DEFAULT_TIME_STEPS_PER_DAY">public static final int</code></div> | ||
| <div class="col-second even-row-color"><code><a href="team/rocket/Simulation.html#DEFAULT_TIME_STEPS_PER_DAY">DEFAULT_TIME_STEPS_PER_DAY</a></code></div> | ||
| <div class="col-last even-row-color"><code>10</code></div> | ||
| </div> | ||
| </li> | ||
| </ul> | ||
| </section> | ||
| </main> | ||
| </div> | ||
| </div> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| team.rocket | ||
| team.rocket.Entities | ||
| team.rocket.Enums | ||
| team.rocket.IO | ||
| team.rocket.IO.Terminal | ||
| team.rocket.util |
Oops, something went wrong.