Skip to content

Commit

Permalink
📝 API docs update
Browse files Browse the repository at this point in the history
Signed-off-by: Heroyt <[email protected]>
  • Loading branch information
Heroyt committed May 22, 2021
1 parent 5635d49 commit 5c35866
Show file tree
Hide file tree
Showing 24 changed files with 3,146 additions and 656 deletions.
208 changes: 104 additions & 104 deletions docs/classes/TournamentGenerator-BlankTeam.html

Large diffs are not rendered by default.

63 changes: 36 additions & 27 deletions docs/classes/TournamentGenerator-Containers-BaseContainer.html

Large diffs are not rendered by default.

45 changes: 27 additions & 18 deletions docs/classes/TournamentGenerator-Containers-ContainerQuery.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h2 class="phpdocumentor-content__title">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">18</span>
<span class="phpdocumentor-element-found-in__line">19</span>
</aside>

<p class="phpdocumentor-summary">Class ContainerQuery</p>
Expand All @@ -135,6 +135,15 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
<section class="phpdocumentor-description"><p>Tomáš Vojík <a href="mailto:[email protected]">[email protected]</a></p>
</section>

</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.4</span>

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

</dd>
</dl>

Expand Down Expand Up @@ -296,7 +305,7 @@ <h4 class="phpdocumentor-element__name" id="property_container">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">22</span>
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>


Expand Down Expand Up @@ -327,7 +336,7 @@ <h4 class="phpdocumentor-element__name" id="property_desc">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
<span class="phpdocumentor-element-found-in__line">28</span>
</aside>


Expand Down Expand Up @@ -357,7 +366,7 @@ <h4 class="phpdocumentor-element__name" id="property_filters">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>


Expand Down Expand Up @@ -388,7 +397,7 @@ <h4 class="phpdocumentor-element__name" id="property_sortClosure">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>


Expand Down Expand Up @@ -418,7 +427,7 @@ <h4 class="phpdocumentor-element__name" id="property_sorter">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">28</span>
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>


Expand Down Expand Up @@ -448,7 +457,7 @@ <h4 class="phpdocumentor-element__name" id="property_sortProperty">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
<span class="phpdocumentor-element-found-in__line">27</span>
</aside>


Expand Down Expand Up @@ -478,7 +487,7 @@ <h4 class="phpdocumentor-element__name" id="property_topLevelOnly">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>


Expand Down Expand Up @@ -508,7 +517,7 @@ <h4 class="phpdocumentor-element__name" id="property_uniqueOnly">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">30</span>
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>


Expand Down Expand Up @@ -542,7 +551,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
<span class="phpdocumentor-element-found-in__line">38</span>
</aside>

<p class="phpdocumentor-summary">ContainerQuery constructor.</p>
Expand Down Expand Up @@ -595,7 +604,7 @@ <h4 class="phpdocumentor-element__name" id="method_addSorter">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">150</span>
<span class="phpdocumentor-element-found-in__line">151</span>
</aside>


Expand Down Expand Up @@ -639,7 +648,7 @@ <h4 class="phpdocumentor-element__name" id="method_desc">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">114</span>
<span class="phpdocumentor-element-found-in__line">115</span>
</aside>

<p class="phpdocumentor-summary">Sort in descending order</p>
Expand Down Expand Up @@ -673,7 +682,7 @@ <h4 class="phpdocumentor-element__name" id="method_filter">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">104</span>
<span class="phpdocumentor-element-found-in__line">105</span>
</aside>

<p class="phpdocumentor-summary">Add a filter callback</p>
Expand Down Expand Up @@ -718,7 +727,7 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>

<p class="phpdocumentor-summary">Get the result</p>
Expand Down Expand Up @@ -752,7 +761,7 @@ <h4 class="phpdocumentor-element__name" id="method_sort">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">126</span>
<span class="phpdocumentor-element-found-in__line">127</span>
</aside>

<p class="phpdocumentor-summary">Sort a result using a callback - maintaining the index association</p>
Expand Down Expand Up @@ -797,7 +806,7 @@ <h4 class="phpdocumentor-element__name" id="method_sortBy">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">140</span>
<span class="phpdocumentor-element-found-in__line">141</span>
</aside>

<p class="phpdocumentor-summary">Sort a result set by a given property</p>
Expand Down Expand Up @@ -857,7 +866,7 @@ <h4 class="phpdocumentor-element__name" id="method_unique">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">160</span>
<span class="phpdocumentor-element-found-in__line">161</span>
</aside>

<p class="phpdocumentor-summary">Get only unique values</p>
Expand Down Expand Up @@ -891,7 +900,7 @@ <h4 class="phpdocumentor-element__name" id="method_sortByPropertyCallback">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/TournamentGenerator/Containers/ContainerQuery.php"><a href="files/src-tournamentgenerator-containers-containerquery.html"><abbr title="src/TournamentGenerator/Containers/ContainerQuery.php">ContainerQuery.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">173</span>
<span class="phpdocumentor-element-found-in__line">174</span>
</aside>

<p class="phpdocumentor-summary">Sort function for sorting by a defined property</p>
Expand Down
Loading

0 comments on commit 5c35866

Please sign in to comment.