docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-04-27 10:06:06 +01:00
parent a10090ff24
commit a8e85d4edd
8 changed files with 200 additions and 117 deletions

View file

@ -80,6 +80,8 @@
<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">
@ -94,6 +96,8 @@
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>
@ -103,7 +107,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">21</span>
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Base Class for all Plugin Widgets. Registers each Widget to WordPress.</p>
@ -136,6 +140,15 @@
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">subpackage</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>public_widget</p>
</section>
</dd>
</dl>
@ -211,7 +224,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">69</span>
<span class="phpdocumentor-element-found-in__line">72</span>
</aside>
<p class="phpdocumentor-summary">Class Constructor. Registers the child Widget to WordPress.</p>
@ -289,7 +302,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">45</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Returns the Description of the child widget.</p>
@ -338,7 +351,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">29</span>
<span class="phpdocumentor-element-found-in__line">32</span>
</aside>
<p class="phpdocumentor-summary">Returns an unique ID as string used for the Widget Base ID.</p>
@ -387,7 +400,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">37</span>
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Returns the Public name of child Widget to be displayed in the Configuration page.</p>
@ -436,7 +449,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">53</span>
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">Returns the width of the Widget. Default width is 250 pixel.</p>