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-02 21:27:53 +01:00
parent ebcba982e6
commit 5afd55dba6
56 changed files with 5566 additions and 5217 deletions
Download patch file Download diff file Expand all files Collapse all files

198
docs/classes/footnotes-admin-Admin.html
View file

@ -59,6 +59,14 @@
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="packages/Default.html"><abbr title="\Default">Default</abbr></a></h3>
<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>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
@ -84,6 +92,12 @@
Admin
<div class="phpdocumentor-element__package">
in package
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
</ul>
</div>
</h2>
@ -91,7 +105,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">27</span>
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Class provide all admin-specific functionality of the plugin.</p>
@ -135,20 +149,6 @@ and JavaScript.</p>
</dt>
<dd>The WYSIWYG editor integration object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-admin-Admin.html#property_plugin_name">$plugin_name</a>
<span>
&nbsp;: string </span>
</dt>
<dd>The ID of this plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/footnotes-admin-Admin.html#property_version">$version</a>
<span>
&nbsp;: string </span>
</dt>
<dd>The version of this plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-Admin.html#method___construct">__construct()</a>
<span>
@ -166,21 +166,21 @@ and JavaScript.</p>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-Admin.html#method_enqueue_scripts">enqueue_scripts()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Register the JavaScript for the admin area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/footnotes-admin-Admin.html#method_enqueue_styles">enqueue_styles()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Register the stylesheets for the admin area.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/footnotes-admin-Admin.html#method_load_dependencies">load_dependencies()</a>
<span>
&nbsp;: mixed </span>
&nbsp;: void </span>
</dt>
<dd>Load the required admin-specific dependencies.</dd>
@ -212,7 +212,7 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">The WYSIWYG editor integration object.</p>
@ -242,136 +242,6 @@ and JavaScript.</p>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_plugin_name">
$plugin_name
<a href="classes/footnotes-admin-Admin.html#property_plugin_name" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">The ID of this plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$plugin_name</span>
</code>
<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">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">
<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"><abbr title="\footnotes\includes\Footnotes::$plugin_name">Footnotes::$plugin_name</abbr></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_version">
$version
<a href="classes/footnotes-admin-Admin.html#property_version" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">The version of this plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$version</span>
</code>
<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">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">
<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"><abbr title="\footnotes\includes\Footnotes::$version">Footnotes::$version</abbr></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
</section>
@ -393,7 +263,7 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
@ -411,18 +281,14 @@ and JavaScript.</p>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of this plugin.</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$version</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The version of this plugin.</p>
</section>
</dd>
</dl>
@ -463,7 +329,7 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">153</span>
<span class="phpdocumentor-element-found-in__line">119</span>
</aside>
<p class="phpdocumentor-summary">Appends the Plugin links for display in the dashboard Plugins page.</p>
@ -535,14 +401,14 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Register the JavaScript for the admin area.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">enqueue_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">enqueue_scripts</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -565,7 +431,7 @@ and JavaScript.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -584,14 +450,14 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">108</span>
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Register the stylesheets for the admin area.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<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>
<span class="phpdocumentor-signature__name">enqueue_styles</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
@ -614,7 +480,7 @@ and JavaScript.</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
@ -633,14 +499,14 @@ and JavaScript.</p>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-admin.php"><a href="files/src-admin-class-admin.html"><abbr title="src/admin/class-admin.php">class-admin.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
<span class="phpdocumentor-element-found-in__line">141</span>
</aside>
<p class="phpdocumentor-summary">Load the required admin-specific dependencies.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">load_dependencies</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Includes the following files that provide the admin-specific functionality
of this plugin:</p>
@ -680,7 +546,7 @@ of this plugin:</p>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>