Generate documentation.

ec-europa · Nov 15, 2024 · 1bbed2b · 1bbed2b
1 parent cf3da3b
commit 1bbed2b
Show file tree

Hide file tree

Showing 34 changed files with 1,519 additions and 1,066 deletions.
diff --git a/classes/EcEuropa-Toolkit-Mock.html b/classes/EcEuropa-Toolkit-Mock.html
@@ -296,7 +296,7 @@ <h4 class="phpdocumentor-element__name" id="property_defaultTag">
     <span class="phpdocumentor-signature__visibility">private</span>
     <span class="phpdocumentor-signature__static">static</span>    <span class="phpdocumentor-signature__type">string</span>
     <span class="phpdocumentor-signature__name">$defaultTag</span>
-     = <span class="phpdocumentor-signature__default-value">&#039;0.0.11&#039;</span></code>
+     = <span class="phpdocumentor-signature__default-value">&#039;0.0.20&#039;</span></code>
 
 
 

diff --git a/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html b/classes/EcEuropa-Toolkit-Task-Command-ConfigurationCommand.html
@@ -347,26 +347,7 @@ <h4 class="phpdocumentor-element__name" id="property_availableTasks">
     <span class="phpdocumentor-signature__visibility">protected</span>
         <span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
     <span class="phpdocumentor-signature__name">$availableTasks</span>
-     = <span class="phpdocumentor-signature__default-value">[
-    &#039;mkdir&#039; =&gt; [&#039;required&#039; =&gt; &#039;dir&#039;, &#039;defaults&#039; =&gt; &#039;mode&#039;],
-    &#039;touch&#039; =&gt; [&#039;required&#039; =&gt; &#039;file&#039;, &#039;defaults&#039; =&gt; [&#039;time&#039;, &#039;atime&#039;]],
-    &#039;copy&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;], &#039;defaults&#039; =&gt; &#039;force&#039;],
-    &#039;copy-dir&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;]],
-    &#039;rename&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;], &#039;defaults&#039; =&gt; &#039;force&#039;],
-    &#039;chmod&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;permissions&#039;], &#039;defaults&#039; =&gt; [&#039;umask&#039;, &#039;recursive&#039;]],
-    &#039;chgrp&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;group&#039;], &#039;defaults&#039; =&gt; &#039;recursive&#039;],
-    &#039;chown&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;user&#039;], &#039;defaults&#039; =&gt; &#039;recursive&#039;],
-    &#039;remove&#039; =&gt; [&#039;required&#039; =&gt; &#039;file&#039;],
-    &#039;symlink&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;]],
-    &#039;mirror&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;]],
-    &#039;process&#039; =&gt; [&#039;required&#039; =&gt; [&#039;source&#039;], &#039;defaults&#039; =&gt; &#039;destination&#039;],
-    &#039;append&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;text&#039;]],
-    &#039;run&#039; =&gt; [&#039;required&#039; =&gt; &#039;command&#039;],
-    //        &#039;process-php&#039; =&gt; [&#039;required&#039; =&gt; [&#039;source&#039;, &#039;destination&#039;], &#039;defaults&#039; =&gt; &#039;override&#039;],
-    &#039;exec&#039; =&gt; [&#039;required&#039; =&gt; &#039;command&#039;],
-    &#039;drush&#039; =&gt; [&#039;required&#039; =&gt; &#039;command&#039;],
-    &#039;replace-block&#039; =&gt; [&#039;required&#039; =&gt; [&#039;filename&#039;, &#039;start&#039;, &#039;end&#039;], &#039;defaults&#039; =&gt; [&#039;content&#039;, &#039;excludeStartEnd&#039;]],
-]</span></code>
+     = <span class="phpdocumentor-signature__default-value">[&#039;mkdir&#039; =&gt; [&#039;required&#039; =&gt; &#039;dir&#039;, &#039;defaults&#039; =&gt; &#039;mode&#039;], &#039;touch&#039; =&gt; [&#039;required&#039; =&gt; &#039;file&#039;, &#039;defaults&#039; =&gt; [&#039;time&#039;, &#039;atime&#039;]], &#039;copy&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;], &#039;defaults&#039; =&gt; &#039;force&#039;], &#039;copy-dir&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;]], &#039;rename&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;], &#039;defaults&#039; =&gt; &#039;force&#039;], &#039;chmod&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;permissions&#039;], &#039;defaults&#039; =&gt; [&#039;umask&#039;, &#039;recursive&#039;]], &#039;chgrp&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;group&#039;], &#039;defaults&#039; =&gt; &#039;recursive&#039;], &#039;chown&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;user&#039;], &#039;defaults&#039; =&gt; &#039;recursive&#039;], &#039;remove&#039; =&gt; [&#039;required&#039; =&gt; &#039;file&#039;], &#039;symlink&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;]], &#039;mirror&#039; =&gt; [&#039;required&#039; =&gt; [&#039;from&#039;, &#039;to&#039;]], &#039;process&#039; =&gt; [&#039;required&#039; =&gt; [&#039;source&#039;], &#039;defaults&#039; =&gt; &#039;destination&#039;], &#039;append&#039; =&gt; [&#039;required&#039; =&gt; [&#039;file&#039;, &#039;text&#039;]], &#039;run&#039; =&gt; [&#039;required&#039; =&gt; &#039;command&#039;], &#039;exec&#039; =&gt; [&#039;required&#039; =&gt; &#039;command&#039;], &#039;drush&#039; =&gt; [&#039;required&#039; =&gt; &#039;command&#039;], &#039;replace-block&#039; =&gt; [&#039;required&#039; =&gt; [&#039;filename&#039;, &#039;start&#039;, &#039;end&#039;], &#039;defaults&#039; =&gt; [&#039;content&#039;, &#039;excludeStartEnd&#039;]]]</span></code>
 
         <section class="phpdocumentor-description"><p>Each task defines all the needed parameters to execute,
 the required to ensure they are present, and the defaults
@@ -438,7 +419,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">73</span>
+    <span class="phpdocumentor-element-found-in__line">72</span>
 
     </aside>
 
@@ -485,7 +466,7 @@ <h4 class="phpdocumentor-element__name" id="method_getTasks">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">234</span>
+    <span class="phpdocumentor-element-found-in__line">233</span>
 
     </aside>
 
@@ -528,7 +509,7 @@ <h4 class="phpdocumentor-element__name" id="method_run">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">81</span>
+    <span class="phpdocumentor-element-found-in__line">80</span>
 
     </aside>
 
@@ -563,7 +544,7 @@ <h4 class="phpdocumentor-element__name" id="method_taskExecute">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">104</span>
+    <span class="phpdocumentor-element-found-in__line">103</span>
 
     </aside>
 
@@ -652,7 +633,7 @@ <h4 class="phpdocumentor-element__name" id="method_paramDefaultValue">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">327</span>
+    <span class="phpdocumentor-element-found-in__line">326</span>
 
     </aside>
 
@@ -707,7 +688,7 @@ <h4 class="phpdocumentor-element__name" id="method_prepareOutput">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">280</span>
+    <span class="phpdocumentor-element-found-in__line">279</span>
 
     </aside>
 
@@ -754,7 +735,7 @@ <h4 class="phpdocumentor-element__name" id="method_throwInvalidTaskException">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">312</span>
+    <span class="phpdocumentor-element-found-in__line">311</span>
 
     </aside>
 
@@ -816,7 +797,7 @@ <h4 class="phpdocumentor-element__name" id="method_throwParamException">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">298</span>
+    <span class="phpdocumentor-element-found-in__line">297</span>
 
     </aside>
 
@@ -887,7 +868,7 @@ <h4 class="phpdocumentor-element__name" id="method_validateAndEnsureParameters">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/Command/ConfigurationCommand.php"><a href="files/src-task-command-configurationcommand.html"><abbr title="src/Task/Command/ConfigurationCommand.php">ConfigurationCommand.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">250</span>
+    <span class="phpdocumentor-element-found-in__line">249</span>
 
     </aside>
 

diff --git a/classes/EcEuropa-Toolkit-Task-File-Process.html b/classes/EcEuropa-Toolkit-Task-File-Process.html
@@ -437,7 +437,7 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/File/Process.php"><a href="files/src-task-file-process.html"><abbr title="src/Task/File/Process.php">Process.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">55</span>
+    <span class="phpdocumentor-element-found-in__line">57</span>
 
     </aside>
 
@@ -458,14 +458,18 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
                 : <span class="phpdocumentor-signature__argument__return-type">string</span>
                             </dt>
             <dd class="phpdocumentor-argument-list__definition">
-
+                    <section class="phpdocumentor-description"><p>The source file.</p>
+</section>
+
             </dd>
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$destination</span>
                 : <span class="phpdocumentor-signature__argument__return-type">string</span>
                  = <span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span>            </dt>
             <dd class="phpdocumentor-argument-list__definition">
-
+                    <section class="phpdocumentor-description"><p>The destination file, if empty assumes the $source as destination.</p>
+</section>
+
             </dd>
             </dl>
 
@@ -489,7 +493,7 @@ <h4 class="phpdocumentor-element__name" id="method_run">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/File/Process.php"><a href="files/src-task-file-process.html"><abbr title="src/Task/File/Process.php">Process.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">116</span>
+    <span class="phpdocumentor-element-found-in__line">118</span>
 
     </aside>
 
@@ -532,7 +536,7 @@ <h4 class="phpdocumentor-element__name" id="method_extractTokens">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/File/Process.php"><a href="files/src-task-file-process.html"><abbr title="src/Task/File/Process.php">Process.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">82</span>
+    <span class="phpdocumentor-element-found-in__line">84</span>
 
     </aside>
 
@@ -575,7 +579,7 @@ <h4 class="phpdocumentor-element__name" id="method_loadContent">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/File/Process.php"><a href="files/src-task-file-process.html"><abbr title="src/Task/File/Process.php">Process.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">67</span>
+    <span class="phpdocumentor-element-found-in__line">69</span>
 
     </aside>
 
@@ -610,7 +614,7 @@ <h4 class="phpdocumentor-element__name" id="method_processTokens">
     <aside class="phpdocumentor-element-found-in">
     <abbr class="phpdocumentor-element-found-in__file" title="src/Task/File/Process.php"><a href="files/src-task-file-process.html"><abbr title="src/Task/File/Process.php">Process.php</abbr></a></abbr>
     :
-    <span class="phpdocumentor-element-found-in__line">97</span>
+    <span class="phpdocumentor-element-found-in__line">99</span>
 
     </aside>