Updated documentation, Fix Build- and Release-Scripts

horstoeko · Dec 25, 2022 · d49f9b4 · d49f9b4
1 parent ef1581d
commit d49f9b4
Show file tree

Hide file tree

Showing 8 changed files with 93 additions and 65 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -35,4 +35,5 @@ jobs:
             repo_token: "${{ secrets.GITHUB_TOKEN }}"
             prerelease: false
             files: |
+                build/dist/doc.zip
                 build/dist/builddoc.zip
diff --git a/build.ant.xml b/build.ant.xml
@@ -58,7 +58,7 @@
             <arg value="${phpdox}"/>
         </exec>
     </target>
-    <target name="full-build" depends="prepare,composer,static-analysis,phpunit,phpdox,-check-failure,projectdoc,deploy" description="Perform static analysis, run tests, and generate project documentation.">
+    <target name="full-build" depends="prepare,composer,static-analysis,phpunit,phpdox,-check-failure,deploy" description="Perform static analysis, run tests, and generate project documentation.">
         <echo message="Built"/>
     </target>
     <target name="lint" unless="lint.done" description="Perform syntax check of PHP sourcecode files.">
@@ -261,19 +261,6 @@
         </fail>
         <echo message="Checked failure"/>
     </target>
-    <target name="projectdoc" depends="prepare" description="Generator project documentation using Sami.">
-        <exec executable="php" taskname="projectdoc">
-            <arg path="${sami}"/>
-            <arg value="update"/>
-            <arg path="${basedir}/build/sami.config.php"/>
-        </exec>
-        <delete file="${basedir}/build/doc/PROJECT_VERSION"/>
-        <delete file="${basedir}/build/doc/SAMI_VERSION"/>
-        <delete file="${basedir}/build/doc/renderer.index"/>
-        <delete file="${basedir}/build/doc/opensearch.xml"/>
-        <delete dir="${basedir}/build/cache"/>
-        <property name="projectdoc.done" value="true"/>
-    </target>
     <target name="deploy" description="Deplay build">
         <zip destfile="${basedir}/build/dist/doc.zip">
             <fileset dir="${basedir}/build/doc">
@@ -318,7 +305,7 @@
         </exec>
         -->
     </target>
-    <target name="projectdocstandalone" description="Generator project documentation using phpdocumentator.">
+    <target name="projectdoc" description="Generator project documentation using sami.">
         <delete dir="${basedir}/cache"/>
         <delete dir="${basedir}/doc"/>
         <mkdir dir="${basedir}/cache"/>

diff --git a/build.xml b/build.xml
@@ -57,7 +57,7 @@
             <arg path="${phpdox}"/>
         </exec>
     </target>
-    <target name="full-build" depends="prepare,composer,static-analysis,phpunit,phpdox,-check-failure,projectdoc,deploy" description="Perform static analysis, run tests, and generate project documentation.">
+    <target name="full-build" depends="prepare,composer,static-analysis,phpunit,phpdox,-check-failure,deploy" description="Perform static analysis, run tests, and generate project documentation.">
         <echo message="Built"/>
     </target>
     <target name="lint" unless="lint.done" description="Perform syntax check of PHP sourcecode files.">
@@ -247,19 +247,6 @@
         </fail>
         <echo message="Checked failure"/>
     </target>
-    <target name="projectdoc" depends="prepare" description="Generator project documentation using sami.">
-        <exec executable="php" taskname="projectdoc">
-            <arg path="${sami}"/>
-            <arg value="update"/>
-            <arg path="${project.basedir}/build/sami.config.php"/>
-        </exec>
-        <delete file="${project.basedir}/build/doc/PROJECT_VERSION"/>
-        <delete file="${project.basedir}/build/doc/SAMI_VERSION"/>
-        <delete file="${project.basedir}/build/doc/renderer.index"/>
-        <delete file="${project.basedir}/build/doc/opensearch.xml"/>
-        <delete dir="${project.basedir}/build/cache"/>
-        <property name="projectdoc.done" value="true"/>
-    </target>
     <target name="deploy" description="Deplay build">
         <zip destfile="${project.basedir}/build/dist/doc.zip">
             <fileset dir="${project.basedir}/build/doc">
@@ -304,7 +291,7 @@
         </exec>
         -->
     </target>
-    <target name="projectdocstandalone" description="Generator project documentation using sami.">
+    <target name="projectdoc" description="Generator project documentation using sami.">
         <delete dir="${project.basedir}/cache"/>
         <delete dir="${project.basedir}/doc"/>
         <mkdir dir="${project.basedir}/cache"/>

diff --git a/composer.json b/composer.json
@@ -61,6 +61,6 @@
         "phpcbf12": "./vendor/bin/phpcbf --standard=./build/phpcsrules_psr12.xml --ignore=/src/entities/* -q ./src ./tests",
         "phpstan": "./vendor/bin/phpstan analyze -c ./build/phpstan.neon --autoload-file=vendor/autoload.php --no-interaction --no-progress --xdebug",
         "phpstan_cs": "./vendor/bin/phpstan analyze -c ./build/phpstan.neon --autoload-file=vendor/autoload.php --no-interaction --no-progress --error-format=checkstyle --xdebug",
-        "orderxdoc": "phing -f ./build.xml projectdocstandalone"
+        "orderxdoc": "phing -f ./build.xml projectdoc"
     }
 }
diff --git a/doc/doc-index.html b/doc/doc-index.html
@@ -312,7 +312,8 @@ <h2 id="letterA">A</h2>
 the unique supplier assigned serial identifier for this trade product instance.</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionSupplyChainPackaging"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionSupplyChainPackaging</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
                     <dd>Get the supply chain packaging information</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionProductOriginTradeCountry"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionProductOriginTradeCountry</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
                     <dd>Get information on the product origin</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionProductReferencedDocument"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionProductReferencedDocument</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
-                    <dd>Get an additional product reference document at position level</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionAdditionalReferencedDocument"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionAdditionalReferencedDocument</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
+                    <dd>Get an additional product reference document at position level</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionProductReferencedDocumentBinaryData"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionProductReferencedDocumentBinaryData</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
+                    <dd>Get the binary data of an additional product reference document at position level</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionAdditionalReferencedDocument"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionAdditionalReferencedDocument</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
                     <dd>Get an additional Document reference on a position</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionAdditionalReferencedDocumentBinaryData"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionAdditionalReferencedDocumentBinaryData</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
                     <dd>Get the binary data of an additional Document reference on a position</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionBuyerOrderReferencedDocument"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionBuyerOrderReferencedDocument</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>
                     <dd>Get details of the related buyer order position</dd><dt><a href="horstoeko/orderx/OrderDocumentReader.html#method_getDocumentPositionQuotationReferencedDocument"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr>::getDocumentPositionQuotationReferencedDocument</a>() &mdash; <em>Method in class <a href="horstoeko/orderx/OrderDocumentReader.html"><abbr title="horstoeko\orderx\OrderDocumentReader">OrderDocumentReader</abbr></a></em></dt>

diff --git a/doc/horstoeko/orderx/OrderDocumentBuilder.html b/doc/horstoeko/orderx/OrderDocumentBuilder.html
@@ -1229,7 +1229,7 @@ <h2>Methods</h2>
                     <a href="../../horstoeko/orderx/OrderDocumentBuilder.html"><abbr title="horstoeko\orderx\OrderDocumentBuilder">OrderDocumentBuilder</abbr></a>
                 </div>
                 <div class="col-md-8 type">
-                    <a href="#method_setDocumentPositionNote">setDocumentPositionNote</a>(string|null $content = null, string|null $contentCode = null, string|null $subjectCode = null)
+                    <a href="#method_setDocumentPositionNote">setDocumentPositionNote</a>(string $content, string|null $contentCode = null, string|null $subjectCode = null)
 
                                             <p>Add detailed information on the free text on the position</p>                </div>
                 <div class="col-md-2"></div>
@@ -7263,7 +7263,7 @@ <h4>Return Value</h4>
                     <h3 id="method_setDocumentPositionNote">
         <div class="location">at         line 2373</div>
         <code>                    <a href="../../horstoeko/orderx/OrderDocumentBuilder.html"><abbr title="horstoeko\orderx\OrderDocumentBuilder">OrderDocumentBuilder</abbr></a>
-    <strong>setDocumentPositionNote</strong>(string|null $content = null, string|null $contentCode = null, string|null $subjectCode = null)
+    <strong>setDocumentPositionNote</strong>(string $content, string|null $contentCode = null, string|null $subjectCode = null)
         </code>
     </h3>
     <div class="details">
@@ -7277,7 +7277,7 @@ <h4>Parameters</h4>
 
                     <table class="table table-condensed">
                     <tr>
-                <td>string|null</td>
+                <td>string</td>
                 <td>$content</td>
                 <td>A free text that contains unstructured information that is relevant to the invoice item</td>
             </tr>