Rumperuu/footnotes
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: update readme and PHPDoc settings (#120)

Browse source 
* update readme.txt

* Test

* Test

* docs: update documentation

* docs: add package tag

* docs: add PHPDoc config, alter Composer script

Co-authored-by: Rumperuu <me+footnotes@bengoldsworthy.net>
This commit is contained in:
Mark Cheret 2021-04-18 21:30:42 +02:00 • committed by GitHub
parent 226df694a2
commit 4dd3345685
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 10272 additions and 12004 deletions
Download patch file Download diff file Expand all files Collapse all files

286
docs/classes/MCI-Footnotes-Layout-Init.html
View file

@ -70,7 +70,7 @@
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="packages/Default.html">Default</a></li>
<li class="phpdocumentor-breadcrumb"><a href="packages/footnotes.html">footnotes</a></li>
</ul>
<article class="phpdocumentor-element -class">
@ -85,7 +85,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">17</span>
<span class="phpdocumentor-element-found-in__line">15</span>
</aside>
<p class="phpdocumentor-summary">Handles the Settings interface of the Plugin.</p>
@ -99,15 +99,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -132,23 +123,23 @@
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG">C_STR_MAIN_MENU_SLUG</a>
<span>
&nbsp;= &quot;mfmmf&quot; </span>
&nbsp;= &#039;footnotes&#039; </span>
</dt>
<dd>Slug for the Plugin main menu.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE">C_STR_MAIN_MENU_TITLE</a>
<span>
&nbsp;= &quot;ManFisher&quot; </span>
&nbsp;= &#039;ManFisher&#039; </span>
</dt>
<dd>Plugin main menu name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses">$a_arr_SubPageClasses</a>
<a href="classes/MCI-Footnotes-Layout-Init.html#property_settings_page">$settings_page</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd></dd>
<dd>Contains the settings layoutEngine</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method___construct">__construct()</a>
@ -158,39 +149,25 @@
<dd>Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins">displayOtherPlugins()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Displays other Plugins from the developers.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation">getPluginMetaInformation()</a>
<a href="classes/MCI-Footnotes-Layout-Init.html#method_get_plugin_meta_information">get_plugin_meta_information()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings">initializeSettings()</a>
<a href="classes/MCI-Footnotes-Layout-Init.html#method_initialize_settings">initialize_settings()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Initializes all sub pages and registers the settings.</dd>
<dd>Registers the settings and initialises the settings page.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu">registerMainMenu()</a>
<a href="classes/MCI-Footnotes-Layout-Init.html#method_register_options_submenu">register_options_submenu()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Registers the new main menu for the WordPress dashboard.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages">registerSubPages()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Registers all SubPages for this Plugin.</dd>
<dd>Registers the footnotes submenu page.</dd>
</dl>
@ -211,7 +188,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">26</span>
<span class="phpdocumentor-element-found-in__line">23</span>
</aside>
<p class="phpdocumentor-summary">Slug for the Plugin main menu.</p>
@ -220,7 +197,7 @@
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_SLUG</span>
= <span class="phpdocumentor-signature__default-value">&quot;mfmmf&quot;</span>
= <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</span>
</code>
@ -233,15 +210,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -262,7 +230,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<p class="phpdocumentor-summary">Plugin main menu name.</p>
@ -271,7 +239,7 @@
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_MAIN_MENU_TITLE</span>
= <span class="phpdocumentor-signature__default-value">&quot;ManFisher&quot;</span>
= <span class="phpdocumentor-signature__default-value">&#039;ManFisher&#039;</span>
</code>
@ -284,15 +252,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -319,24 +278,25 @@
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_a_arr_SubPageClasses">
$a_arr_SubPageClasses
<a href="classes/MCI-Footnotes-Layout-Init.html#property_a_arr_SubPageClasses" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="property_settings_page">
$settings_page
<a href="classes/MCI-Footnotes-Layout-Init.html#property_settings_page" 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="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
<span class="phpdocumentor-element-found-in__line">39</span>
</aside>
<p class="phpdocumentor-summary">Contains the settings layoutEngine</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$a_arr_SubPageClasses</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code>
<span class="phpdocumentor-signature__name">$settings_page</span>
</code>
<section class="phpdocumentor-description"></section>
@ -347,15 +307,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -387,7 +338,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">51</span>
<span class="phpdocumentor-element-found-in__line">46</span>
</aside>
<p class="phpdocumentor-summary">Class Constructor. Initializes all WordPress hooks for the Plugin Settings.</p>
@ -406,15 +357,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -438,79 +380,21 @@
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_displayOtherPlugins">
displayOtherPlugins()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_displayOtherPlugins" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="method_get_plugin_meta_information">
get_plugin_meta_information()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_get_plugin_meta_information" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">143</span>
</aside>
<p class="phpdocumentor-summary">Displays other Plugins from the developers.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">displayOtherPlugins</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getPluginMetaInformation">
getPluginMetaInformation()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_getPluginMetaInformation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">161</span>
<span class="phpdocumentor-element-found-in__line">91</span>
</aside>
<p class="phpdocumentor-summary">AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getPluginMetaInformation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">get_plugin_meta_information</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
@ -522,15 +406,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -554,21 +429,21 @@
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_initializeSettings">
initializeSettings()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_initializeSettings" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="method_initialize_settings">
initialize_settings()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_initialize_settings" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">78</span>
<span class="phpdocumentor-element-found-in__line">62</span>
</aside>
<p class="phpdocumentor-summary">Initializes all sub pages and registers the settings.</p>
<p class="phpdocumentor-summary">Registers the settings and initialises the settings page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">initializeSettings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">initialize_settings</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
@ -580,15 +455,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -612,24 +478,23 @@
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_registerMainMenu">
registerMainMenu()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerMainMenu" class="headerlink"><i class="fas fa-link"></i></a>
<h4 class="phpdocumentor-element__name" id="method_register_options_submenu">
register_options_submenu()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_register_options_submenu" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Registers the new main menu for the WordPress dashboard.</p>
<p class="phpdocumentor-summary">Registers the footnotes submenu page.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">registerMainMenu</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">register_options_submenu</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"><p>Registers all sub menu pages for the new main menu.</p>
</section>
<section class="phpdocumentor-description"></section>
@ -639,15 +504,6 @@
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</p>
</section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
@ -673,64 +529,6 @@
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_registerSubPages">
registerSubPages()
<a href="classes/MCI-Footnotes-Layout-Init.html#method_registerSubPages" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="class/dashboard/init.php"><a href="files/class-dashboard-init.html"><abbr title="class/dashboard/init.php">init.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">128</span>
</aside>
<p class="phpdocumentor-summary">Registers all SubPages for this Plugin.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">registerSubPages</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</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">author</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Stefan Herndler</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">1.5.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>