docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-05-01 21:39:33 +01:00
parent 39072041c7
commit 94cfdf2969
107 changed files with 39813 additions and 6661 deletions

View file

@ -52,18 +52,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>
@ -86,10 +82,86 @@
<div class="phpdocumentor-row">
<h2 class="phpdocumentor-content__title">Deprecated</h2>
<h3>Table of Contents</h3>
<table class="phpdocumentor-table_of_contents">
<tr>
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#src/includes/class-config.php">src/includes/class-config.php</a></td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#src/includes/class-settings.php">src/includes/class-settings.php</a></td>
</tr>
<tr>
<td class="phpdocumentor-cell"><a href="reports/deprecated.html#src/admin/layout/class-settings.php">src/admin/layout/class-settings.php</a></td>
</tr>
</table>
<div class="phpdocumentor-admonition phpdocumentor-admonition--success">
No deprecated elements have been found in this project.
</div>
<a id="src/includes/class-config.php"></a>
<h3><abbr title="src/includes/class-config.php">class-config.php</abbr></h3>
<table>
<tr>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Element</th>
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">46</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html"><abbr title="\footnotes\includes\Config">Config</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">56</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME"><abbr title="\footnotes\includes\Config::C_STR_PLUGIN_PUBLIC_NAME">Config::C_STR_PLUGIN_PUBLIC_NAME</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">73</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME"><abbr title="\footnotes\includes\Config::C_STR_PLUGIN_HEADING_NAME">Config::C_STR_PLUGIN_HEADING_NAME</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">84</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL"><abbr title="\footnotes\includes\Config::C_STR_LOVE_SYMBOL">Config::C_STR_LOVE_SYMBOL</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">95</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING"><abbr title="\footnotes\includes\Config::C_STR_LOVE_SYMBOL_HEADING">Config::C_STR_LOVE_SYMBOL_HEADING</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">106</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Config.html#constant_C_STR_NO_LOVE_SLUG"><abbr title="\footnotes\includes\Config::C_STR_NO_LOVE_SLUG">Config::C_STR_NO_LOVE_SLUG</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
</table>
<a id="src/includes/class-settings.php"></a>
<h3><abbr title="src/includes/class-settings.php">class-settings.php</abbr></h3>
<table>
<tr>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Element</th>
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">293</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-includes-Settings.html#constant_C_STR_FOOTNOTES_EXPERT_MODE"><abbr title="\footnotes\includes\Settings::C_STR_FOOTNOTES_EXPERT_MODE">Settings::C_STR_FOOTNOTES_EXPERT_MODE</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
</table>
<a id="src/admin/layout/class-settings.php"></a>
<h3><abbr title="src/admin/layout/class-settings.php">class-settings.php</abbr></h3>
<table>
<tr>
<th class="phpdocumentor-heading">Line</th>
<th class="phpdocumentor-heading">Element</th>
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">1108</td>
<td class="phpdocumentor-cell"><a href="classes/footnotes-admin-layout-Settings.html#method_custom_css_migration"><abbr title="\footnotes\admin\layout\Settings::custom_css_migration()">Settings::custom_css_migration()</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
</table>
</div>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">