Skip to content

Commit

Permalink
📝 Generated new API documentation
Browse files Browse the repository at this point in the history 
Signed-off-by: Heroyt <[email protected]>
  • Loading branch information
@Heroyt
Heroyt committed Jun 21, 2021
1 parent 5dfbd0c commit 643e955
Show file tree
Hide file tree
Showing 162 changed files with 19,971 additions and 1,117 deletions.
16 changes: 16 additions & 0 deletions docs/classes/TournamentGenerator-Base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/tournament
<li><a href="namespaces/tournamentgenerator-containers.html"><abbr title="\TournamentGenerator\Containers">Containers</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-export.html"><abbr title="\TournamentGenerator\Export">Export</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-helpers.html"><abbr title="\TournamentGenerator\Helpers">Helpers</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-import.html"><abbr title="\TournamentGenerator\Import">Import</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-interfaces.html"><abbr title="\TournamentGenerator\Interfaces">Interfaces</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-preset.html"><abbr title="\TournamentGenerator\Preset">Preset</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-traits.html"><abbr title="\TournamentGenerator\Traits">Traits</abbr></a></li>
Expand All @@ -73,6 +74,7 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="packages/TournamentGene
<li><a href="packages/TournamentGenerator-Traits.html"><abbr title="\TournamentGenerator\Traits">Traits</abbr></a></li>
<li><a href="packages/TournamentGenerator-Containers.html"><abbr title="\TournamentGenerator\Containers">Containers</abbr></a></li>
<li><a href="packages/TournamentGenerator-Export.html"><abbr title="\TournamentGenerator\Export">Export</abbr></a></li>
<li><a href="packages/TournamentGenerator-Import.html"><abbr title="\TournamentGenerator\Import">Import</abbr></a></li>
</ul>
</section>

Expand Down Expand Up @@ -107,6 +109,9 @@ <h2 class="phpdocumentor-content__title">
</ul>
</div>

<span class="phpdocumentor-element__implements">
implements
<a href="classes/TournamentGenerator-Interfaces-WithId.html"><abbr title="\TournamentGenerator\Interfaces\WithId">WithId</abbr></a> </span>

</h2>

Expand Down Expand Up @@ -149,6 +154,17 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">



<h3 id="interfaces_class_traits">
Interfaces, Classes and Traits
<a href="#interfaces_class_traits" class="headerlink"><i class="fas fa-link"></i></a>
</h3>

<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -interface"><a href="classes/TournamentGenerator-Interfaces-WithId.html"><abbr title="\TournamentGenerator\Interfaces\WithId">WithId</abbr></a></dt>
<dd>Identifies an object with an ID</dd>


</dl>


<h3 id="toc">
Expand Down
64 changes: 54 additions & 10 deletions docs/classes/TournamentGenerator-BlankTeam.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ <h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/tournament
<li><a href="namespaces/tournamentgenerator-containers.html"><abbr title="\TournamentGenerator\Containers">Containers</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-export.html"><abbr title="\TournamentGenerator\Export">Export</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-helpers.html"><abbr title="\TournamentGenerator\Helpers">Helpers</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-import.html"><abbr title="\TournamentGenerator\Import">Import</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-interfaces.html"><abbr title="\TournamentGenerator\Interfaces">Interfaces</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-preset.html"><abbr title="\TournamentGenerator\Preset">Preset</abbr></a></li>
<li><a href="namespaces/tournamentgenerator-traits.html"><abbr title="\TournamentGenerator\Traits">Traits</abbr></a></li>
Expand All @@ -73,6 +74,7 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="packages/TournamentGene
<li><a href="packages/TournamentGenerator-Traits.html"><abbr title="\TournamentGenerator\Traits">Traits</abbr></a></li>
<li><a href="packages/TournamentGenerator-Containers.html"><abbr title="\TournamentGenerator\Containers">Containers</abbr></a></li>
<li><a href="packages/TournamentGenerator-Export.html"><abbr title="\TournamentGenerator\Export">Export</abbr></a></li>
<li><a href="packages/TournamentGenerator-Import.html"><abbr title="\TournamentGenerator\Import">Import</abbr></a></li>
</ul>
</section>

Expand Down Expand Up @@ -317,6 +319,13 @@ <h3 id="toc">
</dt>
<dd>Adds a win to the team</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/TournamentGenerator-Team.html#method_export">export()</a>
<span>
&nbsp;: <a href="classes/TournamentGenerator-Export-Exporter.html"><abbr title="\TournamentGenerator\Export\Exporter">Exporter</abbr></a> </span>
</dt>
<dd>Prepares an export query for the object</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/TournamentGenerator-Team.html#method_getGames">getGames()</a>
<span>
Expand Down Expand Up @@ -600,7 +609,7 @@ <h4 class="phpdocumentor-element__name" id="property_games">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>


Expand Down Expand Up @@ -631,7 +640,7 @@ <h4 class="phpdocumentor-element__name" id="property_gamesWith">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>


Expand Down Expand Up @@ -1000,7 +1009,7 @@ <h4 class="phpdocumentor-element__name" id="method_addGame">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">170</span>
<span class="phpdocumentor-element-found-in__line">173</span>
</aside>

<p class="phpdocumentor-summary">Adds a game to this team</p>
Expand Down Expand Up @@ -1046,7 +1055,7 @@ <h4 class="phpdocumentor-element__name" id="method_addGameWith">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<span class="phpdocumentor-element-found-in__line">114</span>
</aside>

<p class="phpdocumentor-summary">Adds a record of a game with another team in a group</p>
Expand Down Expand Up @@ -1101,7 +1110,7 @@ <h4 class="phpdocumentor-element__name" id="method_addGroup">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">156</span>
<span class="phpdocumentor-element-found-in__line">159</span>
</aside>

<p class="phpdocumentor-summary">Adds a group to a team and creates an array for all games to be played</p>
Expand Down Expand Up @@ -1147,7 +1156,7 @@ <h4 class="phpdocumentor-element__name" id="method_addGroupResults">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
<span class="phpdocumentor-element-found-in__line">92</span>
</aside>

<p class="phpdocumentor-summary">Creates a new data-array to store statistics for a new group</p>
Expand Down Expand Up @@ -1560,6 +1569,41 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
<section class="phpdocumentor-description"></section>


</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_export">
export()
<a href="classes/TournamentGenerator-Team.html#method_export" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">205</span>
</aside>

<p class="phpdocumentor-summary">Prepares an export query for the object</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">export</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/TournamentGenerator-Export-Exporter.html"><abbr title="\TournamentGenerator\Export\Exporter">Exporter</abbr></a></span></code>

<section class="phpdocumentor-description"></section>




<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/TournamentGenerator-Export-Exporter.html"><abbr title="\TournamentGenerator\Export\Exporter">Exporter</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>Exporter for this class</p>
</section>


</article>
<article
class="phpdocumentor-element
Expand All @@ -1574,7 +1618,7 @@ <h4 class="phpdocumentor-element__name" id="method_getGames">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">187</span>
<span class="phpdocumentor-element-found-in__line">190</span>
</aside>

<p class="phpdocumentor-summary">Gets all game from given group</p>
Expand Down Expand Up @@ -1630,7 +1674,7 @@ <h4 class="phpdocumentor-element__name" id="method_getGamesInfo">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>

<p class="phpdocumentor-summary">Gets team statistics from the given group without the group object</p>
Expand Down Expand Up @@ -1693,7 +1737,7 @@ <h4 class="phpdocumentor-element__name" id="method_getGameWith">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">127</span>
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>

<p class="phpdocumentor-summary">Gets a record of a game with another team or teams</p>
Expand Down Expand Up @@ -1749,7 +1793,7 @@ <h4 class="phpdocumentor-element__name" id="method_getGroupResults">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Team.php"><a href="files/src-tournamentgenerator-team.html"><abbr title="src/TournamentGenerator/Team.php">Team.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">70</span>
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>

<p class="phpdocumentor-summary">Gets team statistics from the given group</p>
Expand Down
Loading

0 comments on commit 643e955

Please sign in to comment.