docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-04-26 23:06:10 +01:00
parent e379da2687
commit 6d8232b69d
56 changed files with 8846 additions and 1623 deletions

View file

@ -51,9 +51,18 @@
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
</section>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h3>
<ul class="phpdocumentor-list">
<li><a href="packages/footnotes-footnotesincludes.html"><abbr title="\footnotes\footnotesincludes">footnotesincludes</abbr></a></li>
<li><a href="packages/footnotes-footnotesadmin.html"><abbr title="\footnotes\footnotesadmin">footnotesadmin</abbr></a></li>
<li><a href="packages/footnotes-footnotespublic.html"><abbr title="\footnotes\footnotespublic">footnotespublic</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -81,14 +90,20 @@
extends <a href="classes/Footnotes-Widget-Base.html"><abbr title="\Footnotes_Widget_Base">Footnotes_Widget_Base</abbr></a>
</span>
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
</ul>
</div>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/reference-container.php"><a href="files/src-class-widgets-reference-container.html"><abbr title="src/class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-reference-container.php"><a href="files/src-public-widget-class-footnotes-widget-reference-container.html"><abbr title="src/public/widget/class-footnotes-widget-reference-container.php">class-footnotes-widget-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">15</span>
<span class="phpdocumentor-element-found-in__line">17</span>
</aside>
<p class="phpdocumentor-summary">Registers a Widget to put the Reference Container to the widget area.</p>
@ -196,7 +211,7 @@
<a href="classes/Footnotes-Widget-Base.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/base.php"><a href="files/src-class-widgets-base.html"><abbr title="src/class/widgets/base.php">base.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-base.php"><a href="files/src-public-widget-class-footnotes-widget-base.html"><abbr title="src/public/widget/class-footnotes-widget-base.php">class-footnotes-widget-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
</aside>
@ -274,9 +289,9 @@
<a href="classes/Footnotes-Widget-Reference-Container.html#method_form" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/reference-container.php"><a href="files/src-class-widgets-reference-container.html"><abbr title="src/class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-reference-container.php"><a href="files/src-public-widget-class-footnotes-widget-reference-container.html"><abbr title="src/public/widget/class-footnotes-widget-reference-container.php">class-footnotes-widget-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
<span class="phpdocumentor-element-found-in__line">60</span>
</aside>
<p class="phpdocumentor-summary">Outputs the Settings of the Widget.</p>
@ -336,9 +351,9 @@
<a href="classes/Footnotes-Widget-Reference-Container.html#method_widget" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/reference-container.php"><a href="files/src-class-widgets-reference-container.html"><abbr title="src/class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-reference-container.php"><a href="files/src-public-widget-class-footnotes-widget-reference-container.html"><abbr title="src/public/widget/class-footnotes-widget-reference-container.php">class-footnotes-widget-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">69</span>
<span class="phpdocumentor-element-found-in__line">71</span>
</aside>
<p class="phpdocumentor-summary">Outputs the Content of the Widget.</p>
@ -406,9 +421,9 @@
<a href="classes/Footnotes-Widget-Reference-Container.html#method_get_description" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/reference-container.php"><a href="files/src-class-widgets-reference-container.html"><abbr title="src/class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-reference-container.php"><a href="files/src-public-widget-class-footnotes-widget-reference-container.html"><abbr title="src/public/widget/class-footnotes-widget-reference-container.php">class-footnotes-widget-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">45</span>
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
@ -456,9 +471,9 @@
<a href="classes/Footnotes-Widget-Reference-Container.html#method_get_id" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/reference-container.php"><a href="files/src-class-widgets-reference-container.html"><abbr title="src/class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-reference-container.php"><a href="files/src-public-widget-class-footnotes-widget-reference-container.html"><abbr title="src/public/widget/class-footnotes-widget-reference-container.php">class-footnotes-widget-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">23</span>
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
@ -505,9 +520,9 @@
<a href="classes/Footnotes-Widget-Reference-Container.html#method_get_name" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/reference-container.php"><a href="files/src-class-widgets-reference-container.html"><abbr title="src/class/widgets/reference-container.php">reference-container.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-reference-container.php"><a href="files/src-public-widget-class-footnotes-widget-reference-container.html"><abbr title="src/public/widget/class-footnotes-widget-reference-container.php">class-footnotes-widget-reference-container.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">33</span>
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">Returns the Public name of the Widget to be displayed in the Configuration page.</p>
@ -554,7 +569,7 @@
<a href="classes/Footnotes-Widget-Base.html#method_get_widget_width" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/class/widgets/base.php"><a href="files/src-class-widgets-base.html"><abbr title="src/class/widgets/base.php">base.php</abbr></a></abbr>
<abbr class="phpdocumentor-element-found-in__file" title="src/public/widget/class-footnotes-widget-base.php"><a href="files/src-public-widget-class-footnotes-widget-base.html"><abbr title="src/public/widget/class-footnotes-widget-base.php">class-footnotes-widget-base.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">53</span>
</aside>