Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-meyer committed Sep 7, 2024
1 parent 4b59c57 commit 6abfd3b
Show file tree
Hide file tree
Showing 37 changed files with 339 additions and 306 deletions.
7 changes: 7 additions & 0 deletions .phpdoc/guide/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ Changelog
.. sidebar:: Table of Contents
.. contents::

v2.1.2
======

**New Features:**

* Added Composer commands for development tools (PHP Mess Detector, Psalm Taint Analysis)

v2.1.1
======

Expand Down
8 changes: 5 additions & 3 deletions .phpdoc/template/index.html.twig
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
data structures</a>, <a href="guides/overview/errorhandlers.html">error and exception handlers</a>, multiple
<a href="guides/overview/interfaces.html">traits implementing standard interfaces</a>, and more generic
<a href="guides/overview/traits.html">traits for common use cases</a>. They share the same design principles
like property and method naming schema, highest coding standards of <a href="https://phpstan.org/">PHPStan</a>
and <a href="https://psalm.dev/">Psalm</a>, and full <a href="https://www.php-fig.org/psr/psr-12/">PSR-12</a>
compliance to make sure they can be combined and easily re-used in other projects.</p>
like property and method naming schema, highest coding standards of <a href="https://phpstan.org/">PHPStan</a>,
<a href="https://psalm.dev/">Psalm</a>, <a href="https://phpmd.org/">PHP Mess Detector</a>,
<a href="https://github.com/PHPCSStandards/PHP_CodeSniffer/">PHP_CodeSniffer</a>, and full
<a href="https://www.php-fig.org/psr/psr-12/">PSR-12</a> compliance to make sure they can be combined and easily
re-used in other projects.</p>

<h3 id="toc">Table of Contents</h3>

Expand Down
68 changes: 34 additions & 34 deletions doc/classes/OCC-Basics-DataStructures-StrictArray.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions doc/classes/OCC-Basics-DataStructures-StrictCollection.html
Original file line number Diff line number Diff line change
Expand Up @@ -649,9 +649,9 @@ <h4 class="phpdocumentor-element__name" id="method_count">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Interfaces/CountableTrait.php"><a href="files/src-interfaces-countabletrait.html"><abbr title="src/Interfaces/CountableTrait.php">CountableTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">62</span>
<span class="phpdocumentor-element-found-in__line">59</span>

<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.62" class="phpdocumentor-element-found-in__source" data-line="62" data-modal="source-view" data-src="files/src/Interfaces/CountableTrait.php.txt"></a>
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.59" class="phpdocumentor-element-found-in__source" data-line="59" data-modal="source-view" data-src="files/src/Interfaces/CountableTrait.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Count the data items.</p>
Expand Down Expand Up @@ -1042,9 +1042,9 @@ <h4 class="phpdocumentor-element__name" id="method_offsetExists">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Interfaces/ArrayAccessTrait.php"><a href="files/src-interfaces-arrayaccesstrait.html"><abbr title="src/Interfaces/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">61</span>

<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.64" class="phpdocumentor-element-found-in__source" data-line="64" data-modal="source-view" data-src="files/src/Interfaces/ArrayAccessTrait.php.txt"></a>
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.61" class="phpdocumentor-element-found-in__source" data-line="61" data-modal="source-view" data-src="files/src/Interfaces/ArrayAccessTrait.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Check if the specified offset exists.</p>
Expand Down Expand Up @@ -1100,9 +1100,9 @@ <h4 class="phpdocumentor-element__name" id="method_offsetGet">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Interfaces/ArrayAccessTrait.php"><a href="files/src-interfaces-arrayaccesstrait.html"><abbr title="src/Interfaces/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
<span class="phpdocumentor-element-found-in__line">75</span>

<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.78" class="phpdocumentor-element-found-in__source" data-line="78" data-modal="source-view" data-src="files/src/Interfaces/ArrayAccessTrait.php.txt"></a>
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.75" class="phpdocumentor-element-found-in__source" data-line="75" data-modal="source-view" data-src="files/src/Interfaces/ArrayAccessTrait.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Retrieve data at the specified offset.</p>
Expand Down Expand Up @@ -1244,9 +1244,9 @@ <h4 class="phpdocumentor-element__name" id="method_offsetUnset">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/Interfaces/ArrayAccessTrait.php"><a href="files/src-interfaces-arrayaccesstrait.html"><abbr title="src/Interfaces/ArrayAccessTrait.php">ArrayAccessTrait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
<span class="phpdocumentor-element-found-in__line">108</span>

<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.111" class="phpdocumentor-element-found-in__source" data-line="111" data-modal="source-view" data-src="files/src/Interfaces/ArrayAccessTrait.php.txt"></a>
<a href="classes/OCC-Basics-DataStructures-StrictCollection.html#source-view.108" class="phpdocumentor-element-found-in__source" data-line="108" data-modal="source-view" data-src="files/src/Interfaces/ArrayAccessTrait.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Unset the specified offset.</p>
Expand Down
Loading

0 comments on commit 6abfd3b

Please sign in to comment.