dukantic/gomoku
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Aubin DORIVAL
2025-03-31 12:01:51 +02:00
parent 0867ea36c1
commit 7efba643b5
29 changed files with 1966 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
doc/GomokuCell.html
View File

@@ -1,11 +1,11 @@
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (24) on Fri Mar 28 11:00:03 CET 2025 -->
<!-- Generated by javadoc (24) on Mon Mar 31 12:00:50 CEST 2025 -->
<title>GomokuCell</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="2025-03-28">
<meta name="dc.created" content="2025-03-31">
<meta name="description" content="declaration: class: GomokuCell">
<meta name="generator" content="javadoc/ClassWriter">
<link rel="stylesheet" type="text/css" href="resource-files/jquery-ui.min.css" title="Style">
@@ -79,12 +79,14 @@ loadScripts(document, 'script');</script>
<ol class="toc-list">
<li><a href="#getNeighbour(Cardinal)" tabindex="0">getNeighbour(Cardinal)</a></li>
<li><a href="#getAllNeighbour()" tabindex="0">getAllNeighbour()</a></li>
<li><a href="#getSate()" tabindex="0">getSate()</a></li>
<li><a href="#getSameColorNeighbour()" tabindex="0">getSameColorNeighbour()</a></li>
<li><a href="#getState()" tabindex="0">getState()</a></li>
<li><a href="#setState(Color)" tabindex="0">setState(Color)</a></li>
<li><a href="#isEmpty()" tabindex="0">isEmpty()</a></li>
<li><a href="#isPlayed()" tabindex="0">isPlayed()</a></li>
<li><a href="#isPlayable()" tabindex="0">isPlayable()</a></li>
<li><a href="#linkCell(Cardinal,GomokuCell)" tabindex="0">linkCell(Cardinal, GomokuCell)</a></li>
<li><a href="#link(GomokuCell,GomokuCell,Cardinal)" tabindex="0">link(GomokuCell, GomokuCell, Cardinal)</a></li>
<li><a href="#toString()" tabindex="0">toString()</a></li>
</ol>
</li>
@@ -150,7 +152,7 @@ loadScripts(document, 'script');</script>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
@@ -166,26 +168,36 @@ loadScripts(document, 'script');</script>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return one neighbour.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Color.html" title="enum class in Unnamed Package">Color</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSate()" class="member-name-link">getSate</a>()</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><wbr>&lt;<a href="Cardinal.html" title="enum class in Unnamed Package">Cardinal</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSameColorNeighbour()" class="member-name-link">getSameColorNeighbour</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the number of same colored neighbours in all direction.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Color.html" title="enum class in Unnamed Package">Color</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getState()" class="member-name-link">getState</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return the state.</div>
</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="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isEmpty()" class="member-name-link">isEmpty</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method returns if the current cell is empty</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPlayable()" class="member-name-link">isPlayable</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<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="#isPlayable()" class="member-name-link">isPlayable</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return if the cell is playable.</div>
</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="#isPlayed()" class="member-name-link">isPlayed</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isPlayed()" class="member-name-link">isPlayed</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">This method returns if the cell has already played.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#link(GomokuCell,GomokuCell,Cardinal)" class="member-name-link">link</a><wbr>(<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>&nbsp;c1,
<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>&nbsp;c2,
<a href="Cardinal.html" title="enum class in Unnamed Package">Cardinal</a>&nbsp;c1Toc2)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#linkCell(Cardinal,GomokuCell)" class="member-name-link">linkCell</a><wbr>(<a href="Cardinal.html" title="enum class in Unnamed Package">Cardinal</a>&nbsp;car,
<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>&nbsp;cell)</code></div>
@@ -293,10 +305,23 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="getSate()">
<h3>getSate</h3>
<section class="detail" id="getSameColorNeighbour()">
<h3>getSameColorNeighbour</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Color.html" title="enum class in Unnamed Package">Color</a></span>&nbsp;<span class="element-name">getSate</span>()</div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="Cardinal.html" title="enum class in Unnamed Package">Cardinal</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a>&gt;</span>&nbsp;<span class="element-name">getSameColorNeighbour</span>()</div>
<div class="block">Return the number of same colored neighbours in all direction.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The Map of neighbours.</dd>
</dl>
</div>
</section>
</li>
<li>
<section class="detail" id="getState()">
<h3>getState</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="Color.html" title="enum class in Unnamed Package">Color</a></span>&nbsp;<span class="element-name">getState</span>()</div>
<div class="block">Return the state.</div>
<dl class="notes">
<dt>Returns:</dt>
@@ -375,6 +400,16 @@ loadScripts(document, 'script');</script>
</section>
</li>
<li>
<section class="detail" id="link(GomokuCell,GomokuCell,Cardinal)">
<h3>link</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">link</span><wbr><span class="parameters">(<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>&nbsp;c1,
<a href="GomokuCell.html" title="class in Unnamed Package">GomokuCell</a>&nbsp;c2,
<a href="Cardinal.html" title="enum class in Unnamed Package">Cardinal</a>&nbsp;c1Toc2)</span></div>
</div>
</section>
</li>
<li>
<section class="detail" id="toString()">
<h3>toString</h3>
<div class="horizontal-scroll">