docs: update documentation

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

View file

@ -51,18 +51,12 @@
<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">
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -79,8 +73,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-includes.html">includes</a></li>
</ul>
<article class="phpdocumentor-element -class">
@ -88,13 +80,6 @@
Footnotes_Activator
<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-includes.html">includes</a></li>
</ul>
</div>
</h2>
@ -102,10 +87,10 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-activator.php"><a href="files/src-includes-class-footnotes-activator.html"><abbr title="src/includes/class-footnotes-activator.php">class-footnotes-activator.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">20</span>
<span class="phpdocumentor-element-found-in__line">21</span>
</aside>
<p class="phpdocumentor-summary">Fired during plugin activation.</p>
<p class="phpdocumentor-summary">Class providing action(s) on plugin activation.</p>
<section class="phpdocumentor-description"><p>This class defines all code necessary to run during the plugin's activation.</p>
</section>
@ -117,15 +102,6 @@
</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">subpackage</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -133,6 +109,15 @@
<section class="phpdocumentor-description"><p>includes</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"></section>
</dd>
</dl>
@ -152,7 +137,7 @@
<span>
&nbsp;: mixed </span>
</dt>
<dd>Runs when the Plugin is deactivated.</dd>
<dd>Runs when the plugin is deactivated.</dd>
</dl>
@ -180,10 +165,10 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-activator.php"><a href="files/src-includes-class-footnotes-activator.html"><abbr title="src/includes/class-footnotes-activator.php">class-footnotes-activator.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
<span class="phpdocumentor-element-found-in__line">30</span>
</aside>
<p class="phpdocumentor-summary">Runs when the Plugin is deactivated.</p>
<p class="phpdocumentor-summary">Runs when the plugin is deactivated.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>