docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-04-27 08:42:43 +01:00
parent 8044fb8591
commit 748eda717b
58 changed files with 4308 additions and 432 deletions

View file

@ -59,7 +59,9 @@
<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-footnotesadminlayout.html"><abbr title="\footnotes\footnotesadminlayout">footnotesadminlayout</abbr></a></li>
<li><a href="packages/footnotes-footnotespublic.html"><abbr title="\footnotes\footnotespublic">footnotespublic</abbr></a></li>
<li><a href="packages/footnotes-footnotespublicwidget.html"><abbr title="\footnotes\footnotespublicwidget">footnotespublicwidget</abbr></a></li>
</ul>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
</section>
@ -278,7 +280,7 @@ and JavaScript.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Moved to <code class="prettyprint">Footnotes_Public</code> class.</p>
<section class="phpdocumentor-description"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
@ -336,7 +338,7 @@ and JavaScript.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Moved to <code class="prettyprint">Footnotes_Public</code> class.</p>
<section class="phpdocumentor-description"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
@ -393,7 +395,7 @@ and JavaScript.</p>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Moved to <code class="prettyprint">Footnotes_Public</code> class.</p>
<section class="phpdocumentor-description"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
@ -451,7 +453,7 @@ ull</span></code>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Moved to <code class="prettyprint">Footnotes_Public</code> class.</p>
<section class="phpdocumentor-description"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
@ -508,7 +510,7 @@ ull</span></code>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<section class="phpdocumentor-description"><p>Moved to <code class="prettyprint">Footnotes_Public</code> class.</p>
<section class="phpdocumentor-description"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
@ -717,7 +719,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">220</span>
<span class="phpdocumentor-element-found-in__line">206</span>
</aside>
<p class="phpdocumentor-summary">Register the JavaScript for the public-facing side of the site.</p>
@ -739,10 +741,50 @@ ull</span></code>
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<span class="phpdocumentor-tag-link">1.5.0</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">
<span class="phpdocumentor-tag-link">2.0.0</span>
<section class="phpdocumentor-description"><p>Add jQueryUI dependency.</p>
</section>
</dd>
<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.1.2</span>
<section class="phpdocumentor-description"><p>Add jQuery Tools dependency.</p>
</section>
</dd>
<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.5.6</span>
<section class="phpdocumentor-description"><p>Add jQuery dependency.</p>
</section>
</dd>
<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"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
</dl>
@ -766,7 +808,7 @@ ull</span></code>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">136</span>
<span class="phpdocumentor-element-found-in__line">141</span>
</aside>
<p class="phpdocumentor-summary">Register the stylesheets for the public-facing side of the site.</p>
@ -775,7 +817,9 @@ ull</span></code>
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">enqueue_styles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<section class="phpdocumentor-description"><p>Enables enqueuing the formatted individual stylesheets if <code class="prettyprint">PRODCUTION_ENV</code>
is true (set in <code class="prettyprint">footnotes.php</code>).</p>
</section>
@ -788,10 +832,30 @@ ull</span></code>
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">2.8.0</span>
<span class="phpdocumentor-tag-link">1.5.0</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">
<span class="phpdocumentor-tag-link">2.5.5</span>
<section class="phpdocumentor-description"><p>Change stylesheet scheme.</p>
</section>
</dd>
<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"><p>Moved from <code class="prettyprint">Footnotes</code> to <code class="prettyprint">Footnotes_Public</code> class.</p>
</section>
</dd>
</dl>
@ -828,9 +892,9 @@ ull</span></code>
of this plugin:</p>
<ul>
<li>
<code class="prettyprint">Footnotes_Task</code>. TODO</li>
<code class="prettyprint">Footnotes_Parser</code>. Parses Posts and Pages for footnote shortcodes.</li>
<li>
<code class="prettyprint">Footnotes_Widget_Reference_Container</code>. TODO</li>
<code class="prettyprint">Footnotes_Widget_Reference_Container</code>. Defines the Reference Container widget.</li>
</ul>
</section>