Automatic documentation generation

sweetrdf · Sep 1, 2023 · 649bdf3 · 649bdf3
1 parent 9756afd
commit 649bdf3
Show file tree

Hide file tree

Showing 10 changed files with 471 additions and 16 deletions.
diff --git a/classes/rdfInterface-BlankNodeInterface.html b/classes/rdfInterface-BlankNodeInterface.html
@@ -161,6 +161,13 @@ <h4 id="toc-methods">
 
 </h4>
 <dl class="phpdocumentor-table-of-contents">
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a>
+    <span>
+                                &nbsp;: string    </span>
+</dt>
+<dd>Should return:</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/rdfInterface-TermCompareInterface.html#method_equals">equals()</a>
     <span>
@@ -191,6 +198,48 @@ <h3 class="phpdocumentor-elements__header" id="methods">
             -method
             -public
                                                         "
+>
+    <h4 class="phpdocumentor-element__name" id="method___toString">
+        __toString()
+        <a href="classes/rdfInterface-TermCompareInterface.html#method___toString" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php"><a href="files/vendor-sweetrdf-rdf-interface-src-rdfinterface-termcompareinterface.html"><abbr title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php">TermCompareInterface.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">48</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Should return:</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
+
+    <div class="phpdocumentor-label-line">
+        </div>
+        <section class="phpdocumentor-description"><ul>
+<li>an URI for named nodes and blank nodes</li>
+<li>a value in lexical form for literals</li>
+</ul>
+<p>For all other kind of terms the return value depends on the implementation</p>
+</section>
+
+
+
+
+            <section>
+        <h5 class="phpdocumentor-return-value__heading">Return values</h5>
+        <span class="phpdocumentor-signature__response_type">string</span>
+            </section>
+
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
 >
     <h4 class="phpdocumentor-element__name" id="method_equals">
         equals()
@@ -207,7 +256,7 @@ <h4 class="phpdocumentor-element__name" id="method_equals">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                    <span class="phpdocumentor-signature__name">equals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermCompareInterface.html"><abbr title="\rdfInterface\TermCompareInterface">TermCompareInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$term</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
+                    <span class="phpdocumentor-signature__name">equals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermInterface.html"><abbr title="\rdfInterface\TermInterface">TermInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$term</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
 
     <div class="phpdocumentor-label-line">
         </div>
@@ -216,7 +265,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$term</span>
-                : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermCompareInterface.html"><abbr title="\rdfInterface\TermCompareInterface">TermCompareInterface</abbr></a></span>
+                : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermInterface.html"><abbr title="\rdfInterface\TermInterface">TermInterface</abbr></a></span>
                             </dt>
             <dd class="phpdocumentor-argument-list__definition">
 
@@ -374,6 +423,7 @@ <h4 class="phpdocumentor-element__name" id="method_getValue">
                             <li class="phpdocumentor-on-this-page-section__title">Methods</li>
                 <li>
                     <ul class="phpdocumentor-list -clean">
+                                                    <li><a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a></li>
                                                     <li><a href="classes/rdfInterface-TermCompareInterface.html#method_equals">equals()</a></li>
                                                     <li><a href="classes/rdfInterface-TermInterface.html#method_getValue">getValue()</a></li>
                                             </ul>

diff --git a/classes/rdfInterface-DatasetNodeInterface.html b/classes/rdfInterface-DatasetNodeInterface.html
@@ -169,6 +169,13 @@ <h4 id="toc-methods">
 
 </h4>
 <dl class="phpdocumentor-table-of-contents">
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a>
+    <span>
+                                &nbsp;: string    </span>
+</dt>
+<dd>Should return:</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/rdfInterface-DatasetNodeInterface.html#method_add">add()</a>
     <span>
@@ -444,6 +451,48 @@ <h3 class="phpdocumentor-elements__header" id="methods">
             -method
             -public
                                                         "
+>
+    <h4 class="phpdocumentor-element__name" id="method___toString">
+        __toString()
+        <a href="classes/rdfInterface-TermCompareInterface.html#method___toString" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php"><a href="files/vendor-sweetrdf-rdf-interface-src-rdfinterface-termcompareinterface.html"><abbr title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php">TermCompareInterface.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">48</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Should return:</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
+
+    <div class="phpdocumentor-label-line">
+        </div>
+        <section class="phpdocumentor-description"><ul>
+<li>an URI for named nodes and blank nodes</li>
+<li>a value in lexical form for literals</li>
+</ul>
+<p>For all other kind of terms the return value depends on the implementation</p>
+</section>
+
+
+
+
+            <section>
+        <h5 class="phpdocumentor-return-value__heading">Return values</h5>
+        <span class="phpdocumentor-signature__response_type">string</span>
+            </section>
+
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
 >
     <h4 class="phpdocumentor-element__name" id="method_add">
         add()
@@ -2541,6 +2590,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
                             <li class="phpdocumentor-on-this-page-section__title">Methods</li>
                 <li>
                     <ul class="phpdocumentor-list -clean">
+                                                    <li><a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a></li>
                                                     <li><a href="classes/rdfInterface-DatasetNodeInterface.html#method_add">add()</a></li>
                                                     <li><a href="classes/rdfInterface-DatasetInterface.html#method_any">any()</a></li>
                                                     <li><a href="classes/rdfInterface-DatasetNodeInterface.html#method_copy">copy()</a></li>

diff --git a/classes/rdfInterface-DefaultGraphInterface.html b/classes/rdfInterface-DefaultGraphInterface.html
@@ -167,6 +167,13 @@ <h4 id="toc-methods">
                                 &nbsp;: mixed    </span>
 </dt>
 
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a>
+    <span>
+                                &nbsp;: string    </span>
+</dt>
+<dd>Should return:</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/rdfInterface-TermCompareInterface.html#method_equals">equals()</a>
     <span>
@@ -222,6 +229,48 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
 
 
 
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
+>
+    <h4 class="phpdocumentor-element__name" id="method___toString">
+        __toString()
+        <a href="classes/rdfInterface-TermCompareInterface.html#method___toString" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php"><a href="files/vendor-sweetrdf-rdf-interface-src-rdfinterface-termcompareinterface.html"><abbr title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php">TermCompareInterface.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">48</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Should return:</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
+
+    <div class="phpdocumentor-label-line">
+        </div>
+        <section class="phpdocumentor-description"><ul>
+<li>an URI for named nodes and blank nodes</li>
+<li>a value in lexical form for literals</li>
+</ul>
+<p>For all other kind of terms the return value depends on the implementation</p>
+</section>
+
+
+
+
+            <section>
+        <h5 class="phpdocumentor-return-value__heading">Return values</h5>
+        <span class="phpdocumentor-signature__response_type">string</span>
+            </section>
+
 </article>
                     <article
         class="phpdocumentor-element
@@ -244,7 +293,7 @@ <h4 class="phpdocumentor-element__name" id="method_equals">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                    <span class="phpdocumentor-signature__name">equals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermCompareInterface.html"><abbr title="\rdfInterface\TermCompareInterface">TermCompareInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$term</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
+                    <span class="phpdocumentor-signature__name">equals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermInterface.html"><abbr title="\rdfInterface\TermInterface">TermInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$term</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
 
     <div class="phpdocumentor-label-line">
         </div>
@@ -253,7 +302,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$term</span>
-                : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermCompareInterface.html"><abbr title="\rdfInterface\TermCompareInterface">TermCompareInterface</abbr></a></span>
+                : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermInterface.html"><abbr title="\rdfInterface\TermInterface">TermInterface</abbr></a></span>
                             </dt>
             <dd class="phpdocumentor-argument-list__definition">
 
@@ -412,6 +461,7 @@ <h4 class="phpdocumentor-element__name" id="method_getValue">
                 <li>
                     <ul class="phpdocumentor-list -clean">
                                                     <li><a href="classes/rdfInterface-DefaultGraphInterface.html#method___construct">__construct()</a></li>
+                                                    <li><a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a></li>
                                                     <li><a href="classes/rdfInterface-TermCompareInterface.html#method_equals">equals()</a></li>
                                                     <li><a href="classes/rdfInterface-TermInterface.html#method_getValue">getValue()</a></li>
                                             </ul>

diff --git a/classes/rdfInterface-LiteralInterface.html b/classes/rdfInterface-LiteralInterface.html
@@ -180,6 +180,13 @@ <h4 id="toc-methods">
 
 </h4>
 <dl class="phpdocumentor-table-of-contents">
+            <dt class="phpdocumentor-table-of-contents__entry -method -public">
+    <a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a>
+    <span>
+                                &nbsp;: string    </span>
+</dt>
+<dd>Should return:</dd>
+
             <dt class="phpdocumentor-table-of-contents__entry -method -public">
     <a href="classes/rdfInterface-TermCompareInterface.html#method_equals">equals()</a>
     <span>
@@ -311,6 +318,48 @@ <h3 class="phpdocumentor-elements__header" id="methods">
             -method
             -public
                                                         "
+>
+    <h4 class="phpdocumentor-element__name" id="method___toString">
+        __toString()
+        <a href="classes/rdfInterface-TermCompareInterface.html#method___toString" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php"><a href="files/vendor-sweetrdf-rdf-interface-src-rdfinterface-termcompareinterface.html"><abbr title="vendor/sweetrdf/rdf-interface/src/rdfInterface/TermCompareInterface.php">TermCompareInterface.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">48</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Should return:</p>
+
+    <code class="phpdocumentor-code phpdocumentor-signature ">
+    <span class="phpdocumentor-signature__visibility">public</span>
+                    <span class="phpdocumentor-signature__name">__toString</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
+
+    <div class="phpdocumentor-label-line">
+        </div>
+        <section class="phpdocumentor-description"><ul>
+<li>an URI for named nodes and blank nodes</li>
+<li>a value in lexical form for literals</li>
+</ul>
+<p>For all other kind of terms the return value depends on the implementation</p>
+</section>
+
+
+
+
+            <section>
+        <h5 class="phpdocumentor-return-value__heading">Return values</h5>
+        <span class="phpdocumentor-signature__response_type">string</span>
+            </section>
+
+</article>
+                    <article
+        class="phpdocumentor-element
+            -method
+            -public
+                                                        "
 >
     <h4 class="phpdocumentor-element__name" id="method_equals">
         equals()
@@ -327,7 +376,7 @@ <h4 class="phpdocumentor-element__name" id="method_equals">
 
     <code class="phpdocumentor-code phpdocumentor-signature ">
     <span class="phpdocumentor-signature__visibility">public</span>
-                    <span class="phpdocumentor-signature__name">equals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermCompareInterface.html"><abbr title="\rdfInterface\TermCompareInterface">TermCompareInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$term</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
+                    <span class="phpdocumentor-signature__name">equals</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermInterface.html"><abbr title="\rdfInterface\TermInterface">TermInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$term</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
 
     <div class="phpdocumentor-label-line">
         </div>
@@ -336,7 +385,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
     <dl class="phpdocumentor-argument-list">
                     <dt class="phpdocumentor-argument-list__entry">
                 <span class="phpdocumentor-signature__argument__name">$term</span>
-                : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermCompareInterface.html"><abbr title="\rdfInterface\TermCompareInterface">TermCompareInterface</abbr></a></span>
+                : <span class="phpdocumentor-signature__argument__return-type"><a href="classes/rdfInterface-TermInterface.html"><abbr title="\rdfInterface\TermInterface">TermInterface</abbr></a></span>
                             </dt>
             <dd class="phpdocumentor-argument-list__definition">
 
@@ -786,6 +835,7 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
                             <li class="phpdocumentor-on-this-page-section__title">Methods</li>
                 <li>
                     <ul class="phpdocumentor-list -clean">
+                                                    <li><a href="classes/rdfInterface-TermCompareInterface.html#method___toString">__toString()</a></li>
                                                     <li><a href="classes/rdfInterface-TermCompareInterface.html#method_equals">equals()</a></li>
                                                     <li><a href="classes/rdfInterface-LiteralInterface.html#method_getDatatype">getDatatype()</a></li>
                                                     <li><a href="classes/rdfInterface-LiteralInterface.html#method_getLang">getLang()</a></li>