oppdaterer javadoc

This commit is contained in:
Tobydrama
2020-05-05 15:46:33 +02:00
parent d59c672c05
commit 2a03d3ac61
121 changed files with 371 additions and 403 deletions

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>BoardLoaderUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9};
var methods = {"i0":9,"i1":9,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
@ -130,20 +130,24 @@ extends java.lang.Object</pre>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/utility/BoardLoaderUtil.html#getBoardListHumanReadable--">getBoardListHumanReadable</a></span>()</code>
<div class="block">Gets a list of all available boards with human-readable names</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/utility/BoardLoaderUtil.html#getRealBoardName-java.lang.String-">getRealBoardName</a></span>(java.lang.String&nbsp;boardName)</code>
<div class="block">Gets the actual file name of a board given its human-readable name</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../inf112/fiasko/roborally/objects/Board.html" title="class in inf112.fiasko.roborally.objects">Board</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/utility/BoardLoaderUtil.html#loadBoard-java.lang.String-java.util.List-">loadBoard</a></span>(java.lang.String&nbsp;boardFile,
java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&gt;&nbsp;robotList)</code>
<div class="block">Loads a board described in a file</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../inf112/fiasko/roborally/objects/Board.html" title="class in inf112.fiasko.roborally.objects">Board</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../inf112/fiasko/roborally/utility/BoardLoaderUtil.html#loadBoardRotated-java.lang.String-java.util.List-boolean-">loadBoardRotated</a></span>(java.lang.String&nbsp;boardFile,
java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&gt;&nbsp;robotList,
boolean&nbsp;clockwise)</code>
<div class="block">Loads and rotates a board described in a file</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
@ -166,26 +170,36 @@ extends java.lang.Object</pre>
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="loadBoardRotated-java.lang.String-java.util.List-boolean-">
<a name="getRealBoardName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadBoardRotated</h4>
<pre>public static&nbsp;<a href="../../../../inf112/fiasko/roborally/objects/Board.html" title="class in inf112.fiasko.roborally.objects">Board</a>&nbsp;loadBoardRotated(java.lang.String&nbsp;boardFile,
java.util.List&lt;<a href="../../../../inf112/fiasko/roborally/objects/Robot.html" title="class in inf112.fiasko.roborally.objects">Robot</a>&gt;&nbsp;robotList,
boolean&nbsp;clockwise)
throws java.io.IOException</pre>
<div class="block">Loads and rotates a board described in a file</div>
<h4>getRealBoardName</h4>
<pre>public static&nbsp;java.lang.String&nbsp;getRealBoardName(java.lang.String&nbsp;boardName)</pre>
<div class="block">Gets the actual file name of a board given its human-readable name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>boardFile</code> - The file containing the board description</dd>
<dd><code>robotList</code> - A list of robots on the board</dd>
<dd><code>clockwise</code> - Whether to rotate the board clockwise</dd>
<dd><code>boardName</code> - The human-readable name of a board</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A board</dd>
<dd>The file name of the board</dd>
</dl>
</li>
</ul>
<a name="getBoardListHumanReadable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBoardListHumanReadable</h4>
<pre>public static&nbsp;java.lang.String[]&nbsp;getBoardListHumanReadable()
throws java.io.IOException</pre>
<div class="block">Gets a list of all available boards with human-readable names</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A list of all available boards</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - If the board file cannot be loaded</dd>
<dd><code>java.io.IOException</code> - If the board list cannot be read</dd>
</dl>
</li>
</ul>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>DeckLoaderUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>GridUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>IOUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>LaserHelper</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>NetworkUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>ResourceUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>StringUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
<title>TextureConverterUtil</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:53 CEST 2020 -->
<title>inf112.fiasko.roborally.utility</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:53 CEST 2020 -->
<title>inf112.fiasko.roborally.utility</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>

View File

@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="no">
<head>
<!-- Generated by javadoc (1.8.0_172) on Sun May 03 18:10:40 CEST 2020 -->
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:53 CEST 2020 -->
<title>inf112.fiasko.roborally.utility Class Hierarchy</title>
<meta name="date" content="2020-05-03">
<meta name="date" content="2020-05-05">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>