docs: update documentation
This commit is contained in:
parent
a79846c63d
commit
15a35893d9
40 changed files with 10242 additions and 12114 deletions
|
|
@ -90,10 +90,8 @@
|
|||
<dd>Converts data types and Footnotes specific values.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Init.html"><abbr title="\MCI_Footnotes_Layout_Init">MCI_Footnotes_Layout_Init</abbr></a></dt>
|
||||
<dd>Handles the Settings interface of the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-LayoutEngine.html"><abbr title="\MCI_Footnotes_LayoutEngine">MCI_Footnotes_LayoutEngine</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Engine.html"><abbr title="\MCI_Footnotes_Layout_Engine">MCI_Footnotes_Layout_Engine</abbr></a></dt>
|
||||
<dd>Layout Engine for the administration dashboard.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Diagnostics.html"><abbr title="\MCI_Footnotes_Layout_Diagnostics">MCI_Footnotes_Layout_Diagnostics</abbr></a></dt>
|
||||
<dd>Displays Diagnostics of the web server, PHP and WordPress.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Layout-Settings.html"><abbr title="\MCI_Footnotes_Layout_Settings">MCI_Footnotes_Layout_Settings</abbr></a></dt>
|
||||
<dd>Displays and handles all Settings of the Plugin.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Hooks.html"><abbr title="\MCI_Footnotes_Hooks">MCI_Footnotes_Hooks</abbr></a></dt>
|
||||
|
|
@ -105,103 +103,23 @@
|
|||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Settings.html"><abbr title="\MCI_Footnotes_Settings">MCI_Footnotes_Settings</abbr></a></dt>
|
||||
<dd>Loads the settings values, sets to default values if undefined.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Task.html"><abbr title="\MCI_Footnotes_Task">MCI_Footnotes_Task</abbr></a></dt>
|
||||
<dd>Searches and replaces the footnotes.</dd>
|
||||
<dd>Searches and replaces the footnotes and generates the reference container.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Template.html"><abbr title="\MCI_Footnotes_Template">MCI_Footnotes_Template</abbr></a></dt>
|
||||
<dd>Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WidgetBase.html"><abbr title="\MCI_Footnotes_WidgetBase">MCI_Footnotes_WidgetBase</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Base.html"><abbr title="\MCI_Footnotes_Widget_Base">MCI_Footnotes_Widget_Base</abbr></a></dt>
|
||||
<dd>Base Class for all Plugin Widgets. Registers each Widget to WordPress.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-ReferenceContainer.html"><abbr title="\MCI_Footnotes_Widget_ReferenceContainer">MCI_Footnotes_Widget_ReferenceContainer</abbr></a></dt>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-Widget-Reference-Container.html"><abbr title="\MCI_Footnotes_Widget_Reference_Container">MCI_Footnotes_Widget_Reference_Container</abbr></a></dt>
|
||||
<dd>Registers a Widget to put the Reference Container to the widget area.</dd>
|
||||
<dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/MCI-Footnotes-WYSIWYG.html"><abbr title="\MCI_Footnotes_WYSIWYG">MCI_Footnotes_WYSIWYG</abbr></a></dt>
|
||||
<dd></dd>
|
||||
<dd>Handles the WSYIWYG-Buttons.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
<h3 id="toc">
|
||||
Table of Contents
|
||||
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
|
||||
<dl class="phpdocumentor-table-of-contents">
|
||||
<dt class="phpdocumentor-table-of-contents__entry -function -">
|
||||
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles">MCI_Footnotes_requirePhpFiles()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
</dt>
|
||||
<dd>Requires (require_once) all *.php files inside a specific Directory.</dd>
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<section class="phpdocumentor-functions">
|
||||
<h3 class="phpdocumentor-elements__header" id="functions">
|
||||
Functions
|
||||
<a href="namespaces/default.html#functions" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h3>
|
||||
<article class="phpdocumentor-element -function - ">
|
||||
<h4 class="phpdocumentor-element__name" id="function_MCI_Footnotes_requirePhpFiles">
|
||||
MCI_Footnotes_requirePhpFiles()
|
||||
<a href="namespaces/default.html#function_MCI_Footnotes_requirePhpFiles" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="includes.php"><a href="files/includes.html"><abbr title="includes.php">includes.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">17</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Requires (require_once) all *.php files inside a specific Directory.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility"></span>
|
||||
<span class="phpdocumentor-signature__name">MCI_Footnotes_requirePhpFiles</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$p_str_Directory</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
||||
<dl class="phpdocumentor-argument-list">
|
||||
<dt class="phpdocumentor-argument-list__entry">
|
||||
<span class="phpdocumentor-signature__argument__name">$p_str_Directory</span>
|
||||
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-argument-list__definition">
|
||||
<section class="phpdocumentor-description"><p>Absolute Directory path to lookup for *.php files</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
</article>
|
||||
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
|
||||
<section class="phpdocumentor-search-results__dialog">
|
||||
|
|
|
|||
Reference in a new issue