docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-04-27 09:54:23 +01:00
parent d3283bdb02
commit 2fac17b11d
3 changed files with 62 additions and 15 deletions

View file

@ -376,14 +376,14 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">49</span> <span class="phpdocumentor-element-found-in__line">51</span>
</aside> </aside>
<p class="phpdocumentor-summary">Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</p> <p class="phpdocumentor-summary">Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</p>
<code class="phpdocumentor-code phpdocumentor-signature "> <code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span> <span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$plugin_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code> <span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$plugin_name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
@ -391,9 +391,11 @@
<dl class="phpdocumentor-argument-list"> <dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry"> <dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$plugin_name</span> <span class="phpdocumentor-signature__argument__name">$plugin_name</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span> : <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt> </dt>
<dd class="phpdocumentor-argument-list__definition"> <dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>The name of the plugin.</p>
</section>
</dd> </dd>
</dl> </dl>
@ -445,7 +447,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">129</span> <span class="phpdocumentor-element-found-in__line">131</span>
</aside> </aside>
<p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</p> <p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</p>
@ -494,7 +496,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">100</span> <span class="phpdocumentor-element-found-in__line">102</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers the settings and initialises the settings page.</p> <p class="phpdocumentor-summary">Registers the settings and initialises the settings page.</p>
@ -543,7 +545,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">111</span> <span class="phpdocumentor-element-found-in__line">113</span>
</aside> </aside>
<p class="phpdocumentor-summary">Registers the footnotes submenu page.</p> <p class="phpdocumentor-summary">Registers the footnotes submenu page.</p>
@ -601,7 +603,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/layout/class-footnotes-layout-init.php"><a href="files/src-admin-layout-class-footnotes-layout-init.html"><abbr title="src/admin/layout/class-footnotes-layout-init.php">class-footnotes-layout-init.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">78</span> <span class="phpdocumentor-element-found-in__line">80</span>
</aside> </aside>
<p class="phpdocumentor-summary">Load the required dependencies for this plugin.</p> <p class="phpdocumentor-summary">Load the required dependencies for this plugin.</p>

View file

@ -328,7 +328,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">81</span> <span class="phpdocumentor-element-found-in__line">85</span>
</aside> </aside>
<p class="phpdocumentor-summary">AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</p> <p class="phpdocumentor-summary">AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.</p>
@ -378,7 +378,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">70</span> <span class="phpdocumentor-element-found-in__line">74</span>
</aside> </aside>
<p class="phpdocumentor-summary">Includes the Plugins WYSIWYG editor script.</p> <p class="phpdocumentor-summary">Includes the Plugins WYSIWYG editor script.</p>
@ -416,6 +416,15 @@
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Does this need to be <code class="prettyprint">static</code>?</p>
</section>
</dd> </dd>
</dl> </dl>
@ -439,7 +448,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">56</span> <span class="phpdocumentor-element-found-in__line">58</span>
</aside> </aside>
<p class="phpdocumentor-summary">Add a new button to the plain text editor.</p> <p class="phpdocumentor-summary">Add a new button to the plain text editor.</p>
@ -488,7 +497,7 @@
<aside class="phpdocumentor-element-found-in"> <aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr> <abbr class="phpdocumentor-element-found-in__file" title="src/admin/class-footnotes-wysiwyg.php"><a href="files/src-admin-class-footnotes-wysiwyg.html"><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></a></abbr>
: :
<span class="phpdocumentor-element-found-in__line">46</span> <span class="phpdocumentor-element-found-in__line">48</span>
</aside> </aside>
<p class="phpdocumentor-summary">Append a new Button to the WYSIWYG editor of Posts and Pages.</p> <p class="phpdocumentor-summary">Append a new Button to the WYSIWYG editor of Posts and Pages.</p>
@ -526,6 +535,15 @@
<section class="phpdocumentor-description"></section> <section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Does this need to be <code class="prettyprint">static</code>?</p>
</section>
</dd> </dd>
</dl> </dl>

View file

@ -88,10 +88,37 @@
<div class="phpdocumentor-row"> <div class="phpdocumentor-row">
<h2 class="phpdocumentor-content__title">Markers</h2> <h2 class="phpdocumentor-content__title">Markers</h2>
<div class="phpdocumentor-admonition phpdocumentor-admonition--success"> <h3>Table of Contents</h3>
No markers have been found in this project. <table class="phpdocumentor-table_of_contents">
</div> <tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/class-footnotes-wysiwyg.php">src/admin/class-footnotes-wysiwyg.php</a></td>
<td class="phpdocumentor-cell">2</td>
</tr>
</table>
<a id="src/admin/class-footnotes-wysiwyg.php"></a>
<h3><abbr title="src/admin/class-footnotes-wysiwyg.php">class-footnotes-wysiwyg.php</abbr></h3>
<table>
<thead>
<tr>
<th class="phpdocumentor-heading">Type</th>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">48</td>
<td class="phpdocumentor-cell">Does this need to be `static`?</td>
</tr>
<tr>
<td class="phpdocumentor-cell">TODO</td>
<td class="phpdocumentor-cell">74</td>
<td class="phpdocumentor-cell">Does this need to be `static`?</td>
</tr>
</tbody>
</table>
</div> </div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden"> <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog"> <section class="phpdocumentor-search-results__dialog">