docs: update documentation
This commit is contained in:
parent
39072041c7
commit
94cfdf2969
107 changed files with 39813 additions and 6661 deletions
|
|
@ -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>
|
||||
<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>
|
||||
<li><a href="namespaces/footnotes-general.html"><abbr title="\footnotes\general">general</abbr></a></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
|
||||
<section class="phpdocumentor-sidebar__category">
|
||||
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
|
||||
|
|
@ -79,7 +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>
|
||||
</ul>
|
||||
|
||||
<article class="phpdocumentor-element -file">
|
||||
|
|
@ -96,23 +91,23 @@
|
|||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_activate_footnotes">activate_footnotes()</a>
|
||||
<a href="namespaces/footnotes.html#function_activate_footnotes">activate_footnotes()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>The code that runs during plugin activation.</dd>
|
||||
<dd>Handles the activation of the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_deactivate_plugin_name">deactivate_plugin_name()</a>
|
||||
<a href="namespaces/footnotes.html#function_deactivate_footnotes">deactivate_footnotes()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>The code that runs during plugin deactivation.</dd>
|
||||
<dd>Handles the deactivation of the plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_run_footnotes">run_footnotes()</a>
|
||||
<a href="namespaces/footnotes.html#function_run_footnotes">run_footnotes()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
: void </span>
|
||||
</dt>
|
||||
<dd>Begins execution of the plugin.</dd>
|
||||
|
||||
|
|
@ -129,73 +124,118 @@
|
|||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_activate_footnotes">
|
||||
activate_footnotes()
|
||||
<a href="namespaces/default.html#function_activate_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<a href="namespaces/footnotes.html#function_activate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">56</span>
|
||||
<span class="phpdocumentor-element-found-in__line">69</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The code that runs during plugin activation.</p>
|
||||
<p class="phpdocumentor-summary">Handles the activation of the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
<span class="phpdocumentor-signature__name">activate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>This action is documented in includes/class-plugin-name-activator.php</p>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
Tags
|
||||
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</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">see</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Activator.html#method_activate"><abbr title="\footnotes\includes\Activator::activate()">Activator::activate()</abbr></a></span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_deactivate_plugin_name">
|
||||
deactivate_plugin_name()
|
||||
<a href="namespaces/default.html#function_deactivate_plugin_name" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<h4 class="phpdocumentor-element__name" id="function_deactivate_footnotes">
|
||||
deactivate_footnotes()
|
||||
<a href="namespaces/footnotes.html#function_deactivate_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">65</span>
|
||||
<span class="phpdocumentor-element-found-in__line">86</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The code that runs during plugin deactivation.</p>
|
||||
<p class="phpdocumentor-summary">Handles the deactivation of the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">deactivate_plugin_name</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
<span class="phpdocumentor-signature__name">deactivate_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>This action is documented in includes/class-plugin-name-deactivator.php</p>
|
||||
</section>
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
|
||||
<h5 class="phpdocumentor-tag-list__heading" id="tags">
|
||||
Tags
|
||||
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</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">see</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link"><a href="classes/footnotes-includes-Deactivator.html#method_deactivate"><abbr title="\footnotes\includes\Deactivator::deactivate()">Deactivator::deactivate()</abbr></a></span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
</article>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_run_footnotes">
|
||||
run_footnotes()
|
||||
<a href="namespaces/default.html#function_run_footnotes" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
<a href="namespaces/footnotes.html#function_run_footnotes" 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/footnotes.php"><a href="files/src-footnotes.html"><abbr title="src/footnotes.php">footnotes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">88</span>
|
||||
<span class="phpdocumentor-element-found-in__line">114</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Begins execution of the plugin.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
<span class="phpdocumentor-signature__name">run_footnotes</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks,
|
||||
then kicking off the plugin from this point in the file does
|
||||
not affect the page life cycle.</p>
|
||||
<section class="phpdocumentor-description"><p>Since everything within the plugin is registered via hooks, then kicking off
|
||||
the plugin from this point in the file does not affect the page life cycle.</p>
|
||||
</section>
|
||||
|
||||
|
||||
|
|
|
|||
Reference in a new issue