TASK: Update API docs from 8.4

neos · Jan 28, 2025 · f0865dd · f0865dd
1 parent 0a71167
commit f0865dd
Show file tree

Hide file tree

Showing 14 changed files with 94 additions and 88 deletions.
diff --git a/flow/8.4/Neos/Eel.html b/flow/8.4/Neos/Eel.html
@@ -123,6 +123,11 @@ <h2>Classes</h2>
                 <div class="col-md-6">
                     <a href="../Neos/Eel/EvaluationException.html"><abbr title="Neos\Eel\EvaluationException">EvaluationException</abbr></a>    </div>
                 <div class="col-md-6"><p>Some exception that occurred during evaluation of an expression</p></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-6">
+                    <a href="../Neos/Eel/Exception.html"><abbr title="Neos\Eel\Exception">Exception</abbr></a>    </div>
+                <div class="col-md-6"><p>A general Eel exception</p></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">
@@ -143,6 +148,11 @@ <h2>Classes</h2>
                 <div class="col-md-6">
                     <a href="../Neos/Eel/Package.html"><abbr title="Neos\Eel\Package">Package</abbr></a>    </div>
                 <div class="col-md-6"><p>Package base class of the Eel package.</p></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-6">
+                    <a href="../Neos/Eel/ParserException.html"><abbr title="Neos\Eel\ParserException">ParserException</abbr></a>    </div>
+                <div class="col-md-6"><p>Some exception that occurred during parsing of an expression</p></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">
@@ -177,19 +187,7 @@ <h2>Interfaces</h2>
             </div>
             </div>
 
-            <h2>Exceptions</h2>
-    <div class="container-fluid underlined">
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../Neos/Eel/Exception.html"><abbr title="Neos\Eel\Exception">Exception</abbr></a>    </div>
-                <div class="col-md-6"><p>A general Eel exception</p></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../Neos/Eel/ParserException.html"><abbr title="Neos\Eel\ParserException">ParserException</abbr></a>    </div>
-                <div class="col-md-6"><p>Some exception that occurred during parsing of an expression</p></div>
-            </div>
-            </div>
+
 </div><div id="footer">
         Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.            <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
     </div>

diff --git a/flow/8.4/Neos/Eel/FlowQuery.html b/flow/8.4/Neos/Eel/FlowQuery.html
@@ -94,6 +94,11 @@ <h2>Namespaces</h2>
             <h2>Classes</h2>
     <div class="container-fluid underlined">
                     <div class="row">
+                <div class="col-md-6">
+                    <a href="../../Neos/Eel/FlowQuery/FizzleException.html"><abbr title="Neos\Eel\FlowQuery\FizzleException">FizzleException</abbr></a>    </div>
+                <div class="col-md-6"></div>
+            </div>
+                    <div class="row">
                 <div class="col-md-6">
                     <a href="../../Neos/Eel/FlowQuery/FizzleParser.html"><abbr title="Neos\Eel\FlowQuery\FizzleParser">FizzleParser</abbr></a>    </div>
                 <div class="col-md-6"><p>Fizzle parser</p></div>
@@ -102,6 +107,11 @@ <h2>Classes</h2>
                 <div class="col-md-6">
                     <a href="../../Neos/Eel/FlowQuery/FlowQuery.html"><abbr title="Neos\Eel\FlowQuery\FlowQuery">FlowQuery</abbr></a>    </div>
                 <div class="col-md-6"><p>FlowQuery is jQuery for PHP, a selector and traversal engine for object sets.</p></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-6">
+                    <a href="../../Neos/Eel/FlowQuery/FlowQueryException.html"><abbr title="Neos\Eel\FlowQuery\FlowQueryException">FlowQueryException</abbr></a>    </div>
+                <div class="col-md-6"></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">
@@ -125,19 +135,7 @@ <h2>Interfaces</h2>
             </div>
             </div>
 
-            <h2>Exceptions</h2>
-    <div class="container-fluid underlined">
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../Neos/Eel/FlowQuery/FizzleException.html"><abbr title="Neos\Eel\FlowQuery\FizzleException">FizzleException</abbr></a>    </div>
-                <div class="col-md-6"></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../Neos/Eel/FlowQuery/FlowQueryException.html"><abbr title="Neos\Eel\FlowQuery\FlowQueryException">FlowQueryException</abbr></a>    </div>
-                <div class="col-md-6"></div>
-            </div>
-            </div>
+
 </div><div id="footer">
         Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.            <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
     </div>

diff --git a/flow/8.4/Neos/Flow/Configuration.html b/flow/8.4/Neos/Flow/Configuration.html
@@ -103,15 +103,17 @@ <h2>Classes</h2>
                     <a href="../../Neos/Flow/Configuration/ConfigurationSchemaValidator.html"><abbr title="Neos\Flow\Configuration\ConfigurationSchemaValidator">ConfigurationSchemaValidator</abbr></a>    </div>
                 <div class="col-md-6"><p>A validator for all configuration entries using Schema</p></div>
             </div>
+            </div>
+
+
+            <h2>Exceptions</h2>
+    <div class="container-fluid underlined">
                     <div class="row">
                 <div class="col-md-6">
                     <a href="../../Neos/Flow/Configuration/Exception.html"><abbr title="Neos\Flow\Configuration\Exception">Exception</abbr></a>    </div>
                 <div class="col-md-6"><p>A generic Configuration Exception</p></div>
             </div>
             </div>
-
-
-
 </div><div id="footer">
         Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.            <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
     </div>

diff --git a/flow/8.4/Neos/Flow/I18n/Service.html b/flow/8.4/Neos/Flow/I18n/Service.html
@@ -369,7 +369,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getConfiguration">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L101">at line 101</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L103">at line 103</a></div>
         <code>                    <a href="../../../Neos/Flow/I18n/Configuration.html"><abbr title="Neos\Flow\I18n\Configuration">Configuration</abbr></a>
     <strong>getConfiguration</strong>()
         </code>
@@ -402,7 +402,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getLocalizedFilename">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L127">at line 127</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L129">at line 129</a></div>
         <code>                    array
     <strong>getLocalizedFilename</strong>(string $pathAndFilename, <abbr title="Neos\Flow\I18n\Neos\Flow\I18n\Locale">Locale</abbr>|null $locale = null, bool $strict = false)
         </code>
@@ -473,7 +473,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getXliffFilenameAndPath">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L180">at line 180</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L182">at line 182</a></div>
         <code>                    array
     <strong>getXliffFilenameAndPath</strong>(string $path, string $sourceName, <abbr title="Neos\Flow\I18n\Neos\Flow\I18n\Locale">Locale</abbr>|null $locale = null)
         </code>
@@ -544,7 +544,7 @@ <h4>See also</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getLocaleChain">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L201">at line 201</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L203">at line 203</a></div>
         <code>                    array
     <strong>getLocaleChain</strong>(<a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a> $locale)
         </code>
@@ -587,7 +587,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getParentLocaleOf">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L238">at line 238</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L240">at line 240</a></div>
         <code>                    <a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a>
     <strong>getParentLocaleOf</strong>(<a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a> $locale)
         </code>
@@ -629,7 +629,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_findBestMatchingLocale">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L252">at line 252</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L254">at line 254</a></div>
         <code>                    mixed
     <strong>findBestMatchingLocale</strong>(<a href="../../../Neos/Flow/I18n/Locale.html"><abbr title="Neos\Flow\I18n\Locale">Locale</abbr></a> $locale)
         </code>
@@ -673,7 +673,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_generateAvailableLocalesCollectionFromSettings">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L265">at line 265</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L267">at line 267</a></div>
         <code>            protected        void
     <strong>generateAvailableLocalesCollectionFromSettings</strong>()
         </code>
@@ -706,7 +706,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_getScanExcludePattern">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L278">at line 278</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L280">at line 280</a></div>
         <code>            protected        string
     <strong>getScanExcludePattern</strong>()
         </code>
@@ -739,7 +739,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_generateAvailableLocalesCollectionByScanningFilesystem">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L305">at line 305</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/I18n/Service.php#L307">at line 307</a></div>
         <code>            protected        void
     <strong>generateAvailableLocalesCollectionByScanningFilesystem</strong>()
         </code>

diff --git a/flow/8.4/Neos/Flow/Log/ThrowableStorage/FileStorage.html b/flow/8.4/Neos/Flow/Log/ThrowableStorage/FileStorage.html
@@ -634,7 +634,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_renderBacktrace">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php#L235">at line 235</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php#L240">at line 240</a></div>
         <code>            protected        string
     <strong>renderBacktrace</strong>(array $backtrace)
         </code>
@@ -676,7 +676,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_renderRequestInfo">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php#L250">at line 250</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php#L255">at line 255</a></div>
         <code>            protected        string
     <strong>renderRequestInfo</strong>()
         </code>
@@ -708,7 +708,7 @@ <h4>Return Value</h4>
             </div>
                     <div class="method-item">
                     <h3 id="method_cleanupThrowableDumps">
-        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php#L264">at line 264</a></div>
+        <div class="location"><a href="https://github.com/neos/flow-development-collection/blob/8.4/Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php#L269">at line 269</a></div>
         <code>            protected        void
     <strong>cleanupThrowableDumps</strong>()
         </code>

diff --git a/flow/8.4/Neos/Flow/Persistence/Doctrine/Exception.html b/flow/8.4/Neos/Flow/Persistence/Doctrine/Exception.html
@@ -94,6 +94,11 @@ <h2>Classes</h2>
                 <div class="col-md-6">
                     <a href="../../../../Neos/Flow/Persistence/Doctrine/Exception/DatabaseConnectionException.html"><abbr title="Neos\Flow\Persistence\Doctrine\Exception\DatabaseConnectionException">DatabaseConnectionException</abbr></a>    </div>
                 <div class="col-md-6"><p>An database connection exception</p></div>
+            </div>
+                    <div class="row">
+                <div class="col-md-6">
+                    <a href="../../../../Neos/Flow/Persistence/Doctrine/Exception/DatabaseException.html"><abbr title="Neos\Flow\Persistence\Doctrine\Exception\DatabaseException">DatabaseException</abbr></a>    </div>
+                <div class="col-md-6"><p>An generic database exception</p></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">
@@ -103,14 +108,7 @@ <h2>Classes</h2>
             </div>
 
 
-            <h2>Exceptions</h2>
-    <div class="container-fluid underlined">
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../../../Neos/Flow/Persistence/Doctrine/Exception/DatabaseException.html"><abbr title="Neos\Flow\Persistence\Doctrine\Exception\DatabaseException">DatabaseException</abbr></a>    </div>
-                <div class="col-md-6"><p>An generic database exception</p></div>
-            </div>
-            </div>
+
 </div><div id="footer">
         Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.            <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
     </div>

diff --git a/flow/8.4/Neos/Flow/Persistence/Doctrine/Mapping/Exception.html b/flow/8.4/Neos/Flow/Persistence/Doctrine/Mapping/Exception.html
@@ -88,17 +88,17 @@ <h1>Neos\Flow\Persistence\Doctrine\Mapping\Exception</h1>
     </div>
 
 
-
-
-
-            <h2>Exceptions</h2>
+            <h2>Classes</h2>
     <div class="container-fluid underlined">
                     <div class="row">
                 <div class="col-md-6">
                     <a href="../../../../../Neos/Flow/Persistence/Doctrine/Mapping/Exception/ClassSchemaNotFoundException.html"><abbr title="Neos\Flow\Persistence\Doctrine\Mapping\Exception\ClassSchemaNotFoundException">ClassSchemaNotFoundException</abbr></a>    </div>
                 <div class="col-md-6"><p>A Class Schema Not Found Exception</p></div>
             </div>
             </div>
+
+
+
 </div><div id="footer">
         Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.            <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
     </div>

diff --git a/flow/8.4/Neos/Flow/ResourceManagement.html b/flow/8.4/Neos/Flow/ResourceManagement.html
@@ -97,11 +97,6 @@ <h2>Classes</h2>
                 <div class="col-md-6">
                     <a href="../../Neos/Flow/ResourceManagement/Collection.html"><abbr title="Neos\Flow\ResourceManagement\Collection">Collection</abbr></a>    </div>
                 <div class="col-md-6"><p>A resource collection</p></div>
-            </div>
-                    <div class="row">
-                <div class="col-md-6">
-                    <a href="../../Neos/Flow/ResourceManagement/Exception.html"><abbr title="Neos\Flow\ResourceManagement\Exception">Exception</abbr></a>    </div>
-                <div class="col-md-6"><p>Generic ResourceManagement Exception</p></div>
             </div>
                     <div class="row">
                 <div class="col-md-6">
@@ -141,7 +136,14 @@ <h2>Interfaces</h2>
             </div>
             </div>
 
-
+            <h2>Exceptions</h2>
+    <div class="container-fluid underlined">
+                    <div class="row">
+                <div class="col-md-6">
+                    <a href="../../Neos/Flow/ResourceManagement/Exception.html"><abbr title="Neos\Flow\ResourceManagement\Exception">Exception</abbr></a>    </div>
+                <div class="col-md-6"><p>Generic ResourceManagement Exception</p></div>
+            </div>
+            </div>
 </div><div id="footer">
         Generated by <a href="https://github.com/code-lts/doctum">Doctum, a API Documentation generator and fork of Sami</a>.            <br/>Learn more about the <a href="https://flow.neos.io" rel="noreferrer noopener" target="_blank">Flow Framework</a> if you like!</div></div>
     </div>