[AUTO] Update documentation

gigili · May 31, 2023 · 1a1bbb9 · 1a1bbb9
1 parent fc29b7a
commit 1a1bbb9
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 21 deletions.
diff --git a/docs/classes/Gac-Routing-Routes.html b/docs/classes/Gac-Routing-Routes.html
@@ -199,6 +199,13 @@ <h3 id="toc">
     <span>
                         &nbsp;: string            </span>
 </dt>
+<dd></dd>
+
+            <dt class="phpdocumentor-table-of-contents__entry -property -private">
+    <a href="classes/Gac-Routing-Routes.html#property_response">$response</a>
+    <span>
+                        &nbsp;: <a href="classes/Gac-Routing-Response.html"><abbr title="\Gac\Routing\Response">Response</abbr></a>            </span>
+</dt>
 <dd></dd>
 
             <dt class="phpdocumentor-table-of-contents__entry -property -private">
@@ -682,6 +689,40 @@ <h4 class="phpdocumentor-element__name" id="property_prefix">
 
 
 
+</article>
+                    <article
+        class="
+            phpdocumentor-element
+            -property
+            -private
+                                                        "
+>
+    <h4 class="phpdocumentor-element__name" id="property_response">
+        $response
+        <a href="classes/Gac-Routing-Routes.html#property_response" class="headerlink"><i class="fas fa-link"></i></a>
+        <span class="phpdocumentor-element__modifiers">
+                                </span>
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">86</span>
+
+    </aside>
+
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">private</span>
+        <span class="phpdocumentor-signature__type"><a href="classes/Gac-Routing-Response.html"><abbr title="\Gac\Routing\Response">Response</abbr></a></span>
+    <span class="phpdocumentor-signature__name">$response</span>
+    </code>
+
+
+        <section class="phpdocumentor-description"><p>Instance of a Response class to be passed as an argument to routes callback</p>
+</section>
+
+
+
 </article>
                     <article
         class="
@@ -771,7 +812,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">86</span>
+    <span class="phpdocumentor-element-found-in__line">91</span>
 
     </aside>
 
@@ -804,7 +845,7 @@ <h4 class="phpdocumentor-element__name" id="method_add">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">97</span>
+    <span class="phpdocumentor-element-found-in__line">104</span>
 
     </aside>
 
@@ -867,7 +908,7 @@ <h4 class="phpdocumentor-element__name" id="method_append">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">568</span>
+    <span class="phpdocumentor-element-found-in__line">580</span>
 
     </aside>
 
@@ -914,7 +955,7 @@ <h4 class="phpdocumentor-element__name" id="method_delete">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">519</span>
+    <span class="phpdocumentor-element-found-in__line">531</span>
 
     </aside>
 
@@ -970,7 +1011,7 @@ <h4 class="phpdocumentor-element__name" id="method_get">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">467</span>
+    <span class="phpdocumentor-element-found-in__line">479</span>
 
     </aside>
 
@@ -1026,7 +1067,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_routes">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">455</span>
+    <span class="phpdocumentor-element-found-in__line">467</span>
 
     </aside>
 
@@ -1061,7 +1102,7 @@ <h4 class="phpdocumentor-element__name" id="method_handle">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">200</span>
+    <span class="phpdocumentor-element-found-in__line">207</span>
 
     </aside>
 
@@ -1120,7 +1161,7 @@ <h4 class="phpdocumentor-element__name" id="method_middleware">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">556</span>
+    <span class="phpdocumentor-element-found-in__line">568</span>
 
     </aside>
 
@@ -1167,7 +1208,7 @@ <h4 class="phpdocumentor-element__name" id="method_options">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">532</span>
+    <span class="phpdocumentor-element-found-in__line">544</span>
 
     </aside>
 
@@ -1223,7 +1264,7 @@ <h4 class="phpdocumentor-element__name" id="method_patch">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">506</span>
+    <span class="phpdocumentor-element-found-in__line">518</span>
 
     </aside>
 
@@ -1279,7 +1320,7 @@ <h4 class="phpdocumentor-element__name" id="method_post">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">480</span>
+    <span class="phpdocumentor-element-found-in__line">492</span>
 
     </aside>
 
@@ -1335,7 +1376,7 @@ <h4 class="phpdocumentor-element__name" id="method_prefix">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">544</span>
+    <span class="phpdocumentor-element-found-in__line">556</span>
 
     </aside>
 
@@ -1382,7 +1423,7 @@ <h4 class="phpdocumentor-element__name" id="method_put">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">493</span>
+    <span class="phpdocumentor-element-found-in__line">505</span>
 
     </aside>
 
@@ -1438,7 +1479,7 @@ <h4 class="phpdocumentor-element__name" id="method_route">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">115</span>
+    <span class="phpdocumentor-element-found-in__line">122</span>
 
     </aside>
 
@@ -1503,7 +1544,7 @@ <h4 class="phpdocumentor-element__name" id="method_save">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">159</span>
+    <span class="phpdocumentor-element-found-in__line">166</span>
 
     </aside>
 
@@ -1548,7 +1589,7 @@ <h4 class="phpdocumentor-element__name" id="method_execute_middleware">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">362</span>
+    <span class="phpdocumentor-element-found-in__line">374</span>
 
     </aside>
 
@@ -1609,7 +1650,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_all_arguments">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">410</span>
+    <span class="phpdocumentor-element-found-in__line">422</span>
 
     </aside>
 
@@ -1654,7 +1695,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_path">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">347</span>
+    <span class="phpdocumentor-element-found-in__line">359</span>
 
     </aside>
 
@@ -1689,7 +1730,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_route_arguments">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">272</span>
+    <span class="phpdocumentor-element-found-in__line">284</span>
 
     </aside>
 
@@ -1739,7 +1780,7 @@ <h4 class="phpdocumentor-element__name" id="method_setup_callback">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Routes.php"><a href="files/src-routes.html"><abbr title="src/Routes.php">Routes.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">311</span>
+    <span class="phpdocumentor-element-found-in__line">323</span>
 
     </aside>
 

diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js
@@ -325,6 +325,11 @@ Search.appendIndex(
             "name": "currentRoute",
             "summary": "",
             "url": "classes/Gac-Routing-Routes.html#property_currentRoute"
+        },                {
+            "fqsen": "\\Gac\\Routing\\Routes\u003A\u003A\u0024response",
+            "name": "response",
+            "summary": "",
+            "url": "classes/Gac-Routing-Routes.html#property_response"
         },                {
             "fqsen": "\\",
             "name": "\\",

diff --git a/docs/reports/markers.html b/docs/reports/markers.html
@@ -117,7 +117,7 @@ <h3><abbr title="src/Routes.php">Routes.php</abbr></h3>
                 <tbody>
                                     <tr>
                         <td class="phpdocumentor-cell">TODO</td>
-                        <td class="phpdocumentor-cell">217</td>
+                        <td class="phpdocumentor-cell">224</td>
                         <td class="phpdocumentor-cell">Find a way to not check the number of / as it seems a bit hacky</td>
                     </tr>
                                 </tbody>