Api documentations update (Wed Jan 17 12:14:14 UTC 2024)

#apidocs
code-lts · Jan 17, 2024 · c65bb8d · c65bb8d
1 parent 1dc5fec
commit c65bb8d
Show file tree

Hide file tree

Showing 11 changed files with 229 additions and 271 deletions.
diff --git a/api-docs/phpstorm-stubs/Ds/Deque.html b/api-docs/phpstorm-stubs/Ds/Deque.html
diff --git a/api-docs/phpstorm-stubs/Ds/Map.html b/api-docs/phpstorm-stubs/Ds/Map.html
diff --git a/api-docs/phpstorm-stubs/Ds/Pair.html b/api-docs/phpstorm-stubs/Ds/Pair.html
@@ -193,7 +193,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1817">at line 1817</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1826">at line 1826</a></div>
         <code>                    
     <strong>__construct</strong>(<abbr title="Ds\TKey">TKey</abbr> $key = null, <abbr title="Ds\TValue">TValue</abbr> $value = null)
         </code>
@@ -231,7 +231,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_clear">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1824">at line 1824</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1833">at line 1833</a></div>
         <code>                    
     <strong>clear</strong>()
         </code>
@@ -254,7 +254,7 @@ <h3 id="method_clear">
             </div>
                     <div class="method-item">
                     <h3 id="method_copy">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1833">at line 1833</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1842">at line 1842</a></div>
         <code>                    <a href="../Ds/Pair.html"><abbr title="Ds\Pair">Pair</abbr></a>
     <strong>copy</strong>()
         </code>
@@ -286,7 +286,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isEmpty">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1842">at line 1842</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1851">at line 1851</a></div>
         <code>                    bool
     <strong>isEmpty</strong>()
         </code>
@@ -318,7 +318,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_toArray">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1854">at line 1854</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1863">at line 1863</a></div>
         <code>                    array
     <strong>toArray</strong>()
         </code>
@@ -350,7 +350,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_jsonSerialize">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1862">at line 1862</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L1871">at line 1871</a></div>
         <code>                    mixed
     <strong>jsonSerialize</strong>()
         </code>

diff --git a/api-docs/phpstorm-stubs/Ds/PriorityQueue.html b/api-docs/phpstorm-stubs/Ds/PriorityQueue.html
@@ -173,7 +173,8 @@ <h2>Methods</h2>
                 <div class="col-md-8">
                     <a href="#method_getIterator">getIterator</a>()
 
-                                            <p><p>Retrieve an external iterator</p></p>                </div>
+                                            <p class="no-description">No description</p>
+                                    </div>
                 <div class="col-md-2"></div>
             </div>
                     <div class="row">
@@ -244,7 +245,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method_count">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2631">at line 2631</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2646">at line 2646</a></div>
         <code>                    int
     <strong>count</strong>()
         </code>
@@ -280,7 +281,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_allocate">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2639">at line 2639</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2654">at line 2654</a></div>
         <code>                    void
     <strong>allocate</strong>(int $capacity)
         </code>
@@ -322,7 +323,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_capacity">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2647">at line 2647</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2662">at line 2662</a></div>
         <code>                    int
     <strong>capacity</strong>()
         </code>
@@ -354,7 +355,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_clear">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2653">at line 2653</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2668">at line 2668</a></div>
         <code>                    void
     <strong>clear</strong>()
         </code>
@@ -386,7 +387,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_copy">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2660">at line 2660</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2675">at line 2675</a></div>
         <code>                    <abbr title="Ds\Collection&lt;\Ds\TKey,\Ds\TValue&gt;">TValue&gt;</abbr>
     <strong>copy</strong>()
         </code>
@@ -418,7 +419,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getIterator">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2662">at line 2662</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2680">at line 2680</a></div>
         <code>                    <a href="../Traversable.html">Traversable</a>
     <strong>getIterator</strong>()
         </code>
@@ -428,7 +429,8 @@ <h3 id="method_getIterator">
 
 
         <div class="method-description">
-                            <p><p>Retrieve an external iterator</p></p>                        
+                            <p class="no-description">No description</p>
+
         </div>
         <div class="tags">
 
@@ -443,15 +445,6 @@ <h4>Return Value</h4>
     </table>
 
 
-                            <h4>Exceptions</h4>
-
-                    <table class="table table-condensed">
-                    <tr>
-                <td><a href="../Exception.html">Exception</a></td>
-                <td></td>
-            </tr>
-            </table>
-
 
 
                     </div>
@@ -460,7 +453,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isEmpty">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2669">at line 2669</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2687">at line 2687</a></div>
         <code>                    bool
     <strong>isEmpty</strong>()
         </code>
@@ -492,7 +485,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_peek">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2678">at line 2678</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2696">at line 2696</a></div>
         <code>                    <abbr title="Ds\TValue">TValue</abbr>
     <strong>peek</strong>()
         </code>
@@ -533,7 +526,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_pop">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2687">at line 2687</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2705">at line 2705</a></div>
         <code>                    <abbr title="Ds\TValue">TValue</abbr>
     <strong>pop</strong>()
         </code>
@@ -574,7 +567,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_push">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2695">at line 2695</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2713">at line 2713</a></div>
         <code>                    
     <strong>push</strong>(<abbr title="Ds\TValue">TValue</abbr> $value, int $priority)
         </code>
@@ -612,7 +605,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_toArray">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2704">at line 2704</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2722">at line 2722</a></div>
         <code>                    array
     <strong>toArray</strong>()
         </code>
@@ -645,7 +638,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_jsonSerialize">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2713">at line 2713</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2731">at line 2731</a></div>
         <code>                    mixed
     <strong>jsonSerialize</strong>()
         </code>

diff --git a/api-docs/phpstorm-stubs/Ds/Queue.html b/api-docs/phpstorm-stubs/Ds/Queue.html
@@ -289,7 +289,7 @@ <h2>Details</h2>
             <div id="method-details">
                     <div class="method-item">
                     <h3 id="method___construct">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2471">at line 2471</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2486">at line 2486</a></div>
         <code>                    
     <strong>__construct</strong>(<abbr title="Ds\iterable&lt;\Ds\TValue&gt;">TValue&gt;</abbr> $values = [])
         </code>
@@ -324,7 +324,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_allocate">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2485">at line 2485</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2500">at line 2500</a></div>
         <code>                    
     <strong>allocate</strong>(int $capacity)
         </code>
@@ -361,7 +361,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_capacity">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2494">at line 2494</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2509">at line 2509</a></div>
         <code>                    int
     <strong>capacity</strong>()
         </code>
@@ -393,7 +393,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_clear">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2500">at line 2500</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2515">at line 2515</a></div>
         <code>                    void
     <strong>clear</strong>()
         </code>
@@ -425,7 +425,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_count">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2511">at line 2511</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2526">at line 2526</a></div>
         <code>                    int
     <strong>count</strong>()
         </code>
@@ -461,7 +461,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_copy">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2518">at line 2518</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2533">at line 2533</a></div>
         <code>                    <abbr title="Ds\Collection&lt;\Ds\TKey,\Ds\TValue&gt;">TValue&gt;</abbr>
     <strong>copy</strong>()
         </code>
@@ -493,7 +493,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getIterator">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2523">at line 2523</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2538">at line 2538</a></div>
         <code>                    <a href="../Traversable.html">Traversable</a>
     <strong>getIterator</strong>()
         </code>
@@ -527,7 +527,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_isEmpty">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2530">at line 2530</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2545">at line 2545</a></div>
         <code>                    bool
     <strong>isEmpty</strong>()
         </code>
@@ -559,7 +559,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_toArray">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2539">at line 2539</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2554">at line 2554</a></div>
         <code>                    array
     <strong>toArray</strong>()
         </code>
@@ -592,7 +592,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_jsonSerialize">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2548">at line 2548</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2563">at line 2563</a></div>
         <code>                    mixed
     <strong>jsonSerialize</strong>()
         </code>
@@ -626,7 +626,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_peek">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2559">at line 2559</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2574">at line 2574</a></div>
         <code>                    <abbr title="Ds\TValue">TValue</abbr>
     <strong>peek</strong>()
         </code>
@@ -667,7 +667,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_pop">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2570">at line 2570</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2585">at line 2585</a></div>
         <code>                    <abbr title="Ds\TValue">TValue</abbr>
     <strong>pop</strong>()
         </code>
@@ -708,7 +708,7 @@ <h4>Exceptions</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_push">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2579">at line 2579</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2594">at line 2594</a></div>
         <code>                    
     <strong>push</strong>(<abbr title="Ds\TValue">TValue</abbr> ...$values)
         </code>
@@ -741,7 +741,7 @@ <h4>Parameters</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_offsetExists">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2584">at line 2584</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2599">at line 2599</a></div>
         <code>                    bool
     <strong>offsetExists</strong>(mixed $offset)
         </code>
@@ -789,7 +789,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_offsetGet">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2591">at line 2591</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2606">at line 2606</a></div>
         <code>                    mixed
     <strong>offsetGet</strong>(mixed $offset)
         </code>
@@ -834,7 +834,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_offsetSet">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2597">at line 2597</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2612">at line 2612</a></div>
         <code>                    void
     <strong>offsetSet</strong>(TKey $offset, TValue $value)
         </code>
@@ -886,7 +886,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_offsetUnset">
-        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2602">at line 2602</a></div>
+        <div class="location"><a href="https://github.com/JetBrains/phpstorm-stubs/blob/master/ds/ds.php#L2617">at line 2617</a></div>
         <code>                    void
     <strong>offsetUnset</strong>(TKey $offset)
         </code>