FelixKrull
/
CIiP-WiSe-2021-Projektarbeit-Mensch_Aerger_Dich_Nicht
2
0
Fork 2
Code Issues Pull Requests Projects Releases 2 Wiki Activity
Browse Source

Add Descriptions in Javadoc

AIPlayer
FelixKrull 3 years ago
parent
cd10df7555
commit
4053d84269
24 changed files with 39 additions and 27 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      javadoc/Figure.html
  2. 2
      javadoc/Game.html
  3. 2
      javadoc/GameTest.html
  4. 2
      javadoc/Gameboard.html
  5. 2
      javadoc/GameboardTest.html
  6. 12
      javadoc/Player.html
  7. 2
      javadoc/PlayerTest.html
  8. 2
      javadoc/allclasses-index.html
  9. 2
      javadoc/allpackages-index.html
  10. 2
      javadoc/help-doc.html
  11. 6
      javadoc/index-files/index-1.html
  12. 2
      javadoc/index-files/index-2.html
  13. 2
      javadoc/index-files/index-3.html
  14. 2
      javadoc/index-files/index-4.html
  15. 2
      javadoc/index-files/index-5.html
  16. 2
      javadoc/index-files/index-6.html
  17. 6
      javadoc/index-files/index-7.html
  18. 2
      javadoc/index-files/index-8.html
  19. 2
      javadoc/index-files/index-9.html
  20. 2
      javadoc/index.html
  21. 2
      javadoc/overview-tree.html
  22. 2
      javadoc/package-summary.html
  23. 2
      javadoc/package-tree.html
  24. 2
      src/main/java/Player.java

2
javadoc/Figure.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Figure</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/Game.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Game</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/GameTest.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>GameTest</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/Gameboard.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Gameboard</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/GameboardTest.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>GameboardTest</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

12
javadoc/Player.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Player</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -113,7 +113,9 @@ loadScripts(document, 'script');</script>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkGameWin(java.util.ArrayList)" class="member-name-link">checkGameWin</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="Figure.html" title="class in Unnamed Package">Figure</a>&gt;&nbsp;figures)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks if a Player has won the game with the current play</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#choose(java.util.ArrayList)" class="member-name-link">choose</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;&nbsp;usableFigures)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
@ -121,7 +123,9 @@ loadScripts(document, 'script');</script>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#rollDice()" class="member-name-link">rollDice</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Rolls the dice - Generates a random Number in the range of 1 - 6</div>
</div>
</div>
</div>
</div>
@ -160,6 +164,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="rollDice()">
<h3>rollDice</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name">rollDice</span>()</div>
<div class="block">Rolls the dice - Generates a random Number in the range of 1 - 6</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>value of the dice</dd>
@ -170,6 +175,7 @@ loadScripts(document, 'script');</script>
<section class="detail" id="checkGameWin(java.util.ArrayList)">
<h3>checkGameWin</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">checkGameWin</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/ArrayList.html" title="class or interface in java.util" class="external-link">ArrayList</a>&lt;<a href="Figure.html" title="class in Unnamed Package">Figure</a>&gt;&nbsp;figures)</span></div>
<div class="block">Checks if a Player has won the game with the current play</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>figures</code> - figures of the current Player</dd>

2
javadoc/PlayerTest.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>PlayerTest</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/allclasses-index.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<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">

2
javadoc/allpackages-index.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<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">

2
javadoc/help-doc.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>API Help</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

6
javadoc/index-files/index-1.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>C-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -65,7 +65,9 @@ loadScripts(document, 'script');</script>
<div class="block">Checks if the Player has figures in the base (off gameboard)</div>
</dd>
<dt><a href="../Player.html#checkGameWin(java.util.ArrayList)" class="member-name-link">checkGameWin(ArrayList&lt;Figure&gt;)</a> - Method in class <a href="../Player.html" title="class in Unnamed Package">Player</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Checks if a Player has won the game with the current play</div>
</dd>
<dt><a href="../Player.html#choose(java.util.ArrayList)" class="member-name-link">choose(ArrayList&lt;Integer&gt;)</a> - Method in class <a href="../Player.html" title="class in Unnamed Package">Player</a></dt>
<dd>
<div class="block">Get the user input on witch figure the user wants to move</div>

2
javadoc/index-files/index-2.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>F-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/index-files/index-3.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>G-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/index-files/index-4.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>I-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/index-files/index-5.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>M-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/index-files/index-6.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>P-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

6
javadoc/index-files/index-7.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>R-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
@ -53,7 +53,9 @@ loadScripts(document, 'script');</script>
<h2 class="title" id="I:R">R</h2>
<dl class="index">
<dt><a href="../Player.html#rollDice()" class="member-name-link">rollDice()</a> - Method in class <a href="../Player.html" title="class in Unnamed Package">Player</a></dt>
<dd>&nbsp;</dd>
<dd>
<div class="block">Rolls the dice - Generates a random Number in the range of 1 - 6</div>
</dd>
</dl>
<a href="index-1.html">C</a>&nbsp;<a href="index-2.html">F</a>&nbsp;<a href="index-3.html">G</a>&nbsp;<a href="index-4.html">I</a>&nbsp;<a href="index-5.html">M</a>&nbsp;<a href="index-6.html">P</a>&nbsp;<a href="index-7.html">R</a>&nbsp;<a href="index-8.html">S</a>&nbsp;<a href="index-9.html">T</a>&nbsp;<br><a href="../allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="../allpackages-index.html">All&nbsp;Packages</a></main>
</div>

2
javadoc/index-files/index-8.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>S-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/index-files/index-9.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>T-Index</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/index.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Generated Documentation (Untitled)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/overview-tree.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/package-summary.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title>Unnamed Package</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
javadoc/package-tree.html
View File

@ -1,7 +1,7 @@
<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (17) on Tue Feb 15 08:39:56 CET 2022 -->
<!-- Generated by javadoc (17) on Tue Feb 15 08:42:59 CET 2022 -->
<title> Class Hierarchy</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">

2
src/main/java/Player.java
View File

@ -21,6 +21,7 @@ public class Player {
}
/**
* Rolls the dice - Generates a random Number in the range of 1 - 6
* @return value of the dice
*/
public int rollDice() {
@ -28,6 +29,7 @@ public class Player {
}
/**
* Checks if a Player has won the game with the current play
* @param figures figures of the current Player
* @return true if Player has won
*/

Write Preview
Loading…
Cancel
Save