docs: update documentation
This commit is contained in:
parent
850ab084ff
commit
4e4f0b0a2e
15 changed files with 884 additions and 398 deletions
|
|
@ -151,6 +151,13 @@
|
|||
</dt>
|
||||
<dd>Stores the Hook connection string for the child sub page.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
||||
<a href="classes/Footnotes-Layout-Engine.html#property_plugin_name">$plugin_name</a>
|
||||
<span>
|
||||
: string </span>
|
||||
</dt>
|
||||
<dd>The ID of this plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes-Layout-Engine.html#method_description">description()</a>
|
||||
<span>
|
||||
|
|
@ -354,7 +361,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">40</span>
|
||||
<span class="phpdocumentor-element-found-in__line">49</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Stores all Sections for the child sub page.</p>
|
||||
|
|
@ -401,7 +408,7 @@
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">32</span>
|
||||
<span class="phpdocumentor-element-found-in__line">41</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Stores the Hook connection string for the child sub page.</p>
|
||||
|
|
@ -432,6 +439,62 @@ ull</span></code>
|
|||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article
|
||||
class="
|
||||
phpdocumentor-element
|
||||
-property
|
||||
-protected
|
||||
"
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
|
||||
$plugin_name
|
||||
<a href="classes/Footnotes-Layout-Engine.html#property_plugin_name" 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/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">33</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The ID of this plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">protected</span>
|
||||
<span class="phpdocumentor-signature__type">string</span>
|
||||
<span class="phpdocumentor-signature__name">$plugin_name</span>
|
||||
</code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
Tags
|
||||
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h5>
|
||||
<dl class="phpdocumentor-tag-list">
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
<dt class="phpdocumentor-tag-list__entry">
|
||||
<span class="phpdocumentor-tag__name">access</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
|
||||
<section class="phpdocumentor-description"><p>private</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
|
@ -453,7 +516,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">305</span>
|
||||
<span class="phpdocumentor-element-found-in__line">314</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Output the Description of a section. May be overwritten in any section.</p>
|
||||
|
|
@ -502,7 +565,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">205</span>
|
||||
<span class="phpdocumentor-element-found-in__line">214</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Displays the content of specific sub page.</p>
|
||||
|
|
@ -551,7 +614,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">48</span>
|
||||
<span class="phpdocumentor-element-found-in__line">57</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns a Priority index. Lower numbers have a higher Priority.</p>
|
||||
|
|
@ -600,7 +663,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">151</span>
|
||||
<span class="phpdocumentor-element-found-in__line">160</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Registers all sections for a sub page.</p>
|
||||
|
|
@ -649,7 +712,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">125</span>
|
||||
<span class="phpdocumentor-element-found-in__line">134</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Registers a sub page.</p>
|
||||
|
|
@ -698,7 +761,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">433</span>
|
||||
<span class="phpdocumentor-element-found-in__line">442</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for an input [type = checkbox].</p>
|
||||
|
|
@ -759,7 +822,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">511</span>
|
||||
<span class="phpdocumentor-element-found-in__line">520</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text] with color selection class.</p>
|
||||
|
|
@ -820,7 +883,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">380</span>
|
||||
<span class="phpdocumentor-element-found-in__line">389</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for an input/select label.</p>
|
||||
|
|
@ -890,7 +953,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">357</span>
|
||||
<span class="phpdocumentor-element-found-in__line">366</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns a line break to have a space between two lines.</p>
|
||||
|
|
@ -939,7 +1002,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">111</span>
|
||||
<span class="phpdocumentor-element-found-in__line">120</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns an array describing a meta box.</p>
|
||||
|
|
@ -1028,7 +1091,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">347</span>
|
||||
<span class="phpdocumentor-element-found-in__line">356</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns a line break to start a new line.</p>
|
||||
|
|
@ -1077,7 +1140,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">535</span>
|
||||
<span class="phpdocumentor-element-found-in__line">544</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for an input [type = num].</p>
|
||||
|
|
@ -1176,7 +1239,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">92</span>
|
||||
<span class="phpdocumentor-element-found-in__line">101</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns an array describing a sub page section.</p>
|
||||
|
|
@ -1265,7 +1328,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">461</span>
|
||||
<span class="phpdocumentor-element-found-in__line">470</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for a select box.</p>
|
||||
|
|
@ -1376,7 +1439,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">368</span>
|
||||
<span class="phpdocumentor-element-found-in__line">377</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns a simple text inside html <span> text.</p>
|
||||
|
|
@ -1437,7 +1500,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">408</span>
|
||||
<span class="phpdocumentor-element-found-in__line">417</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for an input [type = text].</p>
|
||||
|
|
@ -1525,7 +1588,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">493</span>
|
||||
<span class="phpdocumentor-element-found-in__line">502</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the html tag for a text area.</p>
|
||||
|
|
@ -1586,7 +1649,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">80</span>
|
||||
<span class="phpdocumentor-element-found-in__line">89</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns an array of all registered meta boxes.</p>
|
||||
|
|
@ -1635,7 +1698,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">72</span>
|
||||
<span class="phpdocumentor-element-found-in__line">81</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns an array of all registered sections for a sub page.</p>
|
||||
|
|
@ -1684,7 +1747,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">56</span>
|
||||
<span class="phpdocumentor-element-found-in__line">65</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the unique slug of the child sub page.</p>
|
||||
|
|
@ -1733,7 +1796,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">64</span>
|
||||
<span class="phpdocumentor-element-found-in__line">73</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Returns the title of the child sub page.</p>
|
||||
|
|
@ -1782,7 +1845,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">331</span>
|
||||
<span class="phpdocumentor-element-found-in__line">340</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Loads specific setting and returns an array with the keys [id, name, value].</p>
|
||||
|
|
@ -1910,7 +1973,7 @@ Removing this did not fix the quotation mark backslash escapement bug.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">192</span>
|
||||
<span class="phpdocumentor-element-found-in__line">201</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Append javascript and css files for specific sub page.</p>
|
||||
|
|
@ -1959,7 +2022,7 @@ Removing this did not fix the quotation mark backslash escapement bug.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">171</span>
|
||||
<span class="phpdocumentor-element-found-in__line">180</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Registers all Meta boxes for a sub page.</p>
|
||||
|
|
@ -2020,7 +2083,7 @@ Removing this did not fix the quotation mark backslash escapement bug.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-engine.php"><a href="files/src-admin-layout-class-footnotes-layout-engine.html"><abbr title="src/admin/layout/class-footnotes-layout-engine.php">class-footnotes-layout-engine.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">277</span>
|
||||
<span class="phpdocumentor-element-found-in__line">286</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Save all Plugin settings.</p>
|
||||
|
|
|
|||
Reference in a new issue