Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update documentation

Browse source
This commit is contained in:
Ben Goldsworthy 2021-05-01 21:39:33 +01:00
parent 39072041c7
commit 94cfdf2969
107 changed files with 39813 additions and 6661 deletions
Download patch file Download diff file Expand all files Collapse all files

132
docs/classes/Footnotes-Widget-Reference-Container.html
View file

@ -51,18 +51,14 @@
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
</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-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
<li><a href="packages/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="packages/footnotes-public.html"><abbr title="\footnotes\public">public</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/footnotes.html"><abbr title="\footnotes">footnotes</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/footnotes-admin.html"><abbr title="\footnotes\admin">admin</abbr></a></li>
<li><a href="namespaces/footnotes-includes.html"><abbr title="\footnotes\includes">includes</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -79,9 +75,6 @@
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-public.html">public</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-public-widget.html">widget</a></li>
</ul>
<article class="phpdocumentor-element -class">
@ -92,14 +85,6 @@
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>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-public.html">public</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes-public-widget.html">widget</a></li>
</ul>
</div>
</h2>
@ -107,7 +92,7 @@
<aside class="phpdocumentor-element-found-in">
<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">21</span>
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Registers a Widget to put the Reference Container to the widget area.</p>
@ -130,11 +115,20 @@
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">subpackage</span>
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-Widget-Base.html"><abbr title="\Footnotes_Widget_Base">Footnotes_Widget_Base</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>public_widget</p>
<section class="phpdocumentor-description"><p>Review implemenation of Widgets API.</p>
</section>
</dd>
@ -168,7 +162,7 @@
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/Footnotes-Widget-Reference-Container.html#method_form">form()</a>
<span>
&nbsp;: void </span>
&nbsp;: mixed </span>
</dt>
<dd>Outputs the Settings of the Widget.</dd>
@ -235,7 +229,7 @@
<aside class="phpdocumentor-element-found-in">
<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">30</span>
<span class="phpdocumentor-element-found-in__line">33</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</p>
@ -255,6 +249,15 @@
</h5>
<dl class="phpdocumentor-tag-list">
<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>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -264,12 +267,12 @@
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">access</span>
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>private</p>
</section>
<span class="phpdocumentor-tag-link"><abbr title="\Footnotes::$plugin_name">Footnotes::$plugin_name</abbr></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
@ -295,7 +298,7 @@
<aside class="phpdocumentor-element-found-in">
<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">38</span>
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
@ -356,14 +359,14 @@
<aside class="phpdocumentor-element-found-in">
<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">84</span>
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">Outputs the Settings of the Widget.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">form</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$instance</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<span class="phpdocumentor-signature__name">form</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$instance</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
@ -387,6 +390,14 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://developer.wordpress.org/reference/classes/wp_widget/form/"> <p><code class="prettyprint">WP_Widget::form()</code></p>
</a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -398,10 +409,9 @@
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"><p>Edit: curly quotes 2.2.0</p>
</section>
<section class="phpdocumentor-description"></section>
</article>
@ -418,7 +428,7 @@
<aside class="phpdocumentor-element-found-in">
<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">95</span>
<span class="phpdocumentor-element-found-in__line">104</span>
</aside>
<p class="phpdocumentor-summary">Outputs the Content of the Widget.</p>
@ -458,6 +468,14 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">link</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<a class="phpdocumentor-tag-link" href="https://developer.wordpress.org/reference/classes/wp_widget/widget/"> <p><code class="prettyprint">WP_Widget::widget()</code></p>
</a>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -488,7 +506,7 @@
<aside class="phpdocumentor-element-found-in">
<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">71</span>
<span class="phpdocumentor-element-found-in__line">79</span>
</aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
@ -507,6 +525,15 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-Widget-Base.html#method_get_description"><abbr title="\Footnotes_Widget_Base::get_description()">Footnotes_Widget_Base::get_description()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -520,8 +547,7 @@
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>Edit: curly quotes 2.2.0</p>
</section>
<section class="phpdocumentor-description"></section>
</article>
@ -538,7 +564,7 @@
<aside class="phpdocumentor-element-found-in">
<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">49</span>
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
@ -557,6 +583,15 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-Widget-Base.html#method_get_id"><abbr title="\Footnotes_Widget_Base::get_id()">Footnotes_Widget_Base::get_id()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -587,7 +622,7 @@
<aside class="phpdocumentor-element-found-in">
<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">59</span>
<span class="phpdocumentor-element-found-in__line">67</span>
</aside>
<p class="phpdocumentor-summary">Returns the Public name of the Widget to be displayed in the Configuration page.</p>
@ -606,6 +641,15 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/Footnotes-Widget-Base.html#method_get_name"><abbr title="\Footnotes_Widget_Base::get_name()">Footnotes_Widget_Base::get_name()</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -636,7 +680,7 @@
<aside class="phpdocumentor-element-found-in">
<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">56</span>
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p>