docs: update documentation
This commit is contained in:
parent
39072041c7
commit
94cfdf2969
107 changed files with 39813 additions and 6661 deletions
|
|
@ -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>
|
||||
|
|
@ -89,13 +85,45 @@
|
|||
<h3>Table of Contents</h3>
|
||||
<table class="phpdocumentor-table_of_contents">
|
||||
<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"><a href="reports/markers.html#src/includes/class-config.php">src/includes/class-config.php</a></td>
|
||||
<td class="phpdocumentor-cell">6</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-convert.php">src/includes/class-convert.php</a></td>
|
||||
<td class="phpdocumentor-cell">5</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-settings.php">src/includes/class-settings.php</a></td>
|
||||
<td class="phpdocumentor-cell">7</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/includes/class-template.php">src/includes/class-template.php</a></td>
|
||||
<td class="phpdocumentor-cell">7</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/class-wysiwyg.php">src/admin/class-wysiwyg.php</a></td>
|
||||
<td class="phpdocumentor-cell">2</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/admin/layout/class-engine.php">src/admin/layout/class-engine.php</a></td>
|
||||
<td class="phpdocumentor-cell">16</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/class-parser.php">src/public/class-parser.php</a></td>
|
||||
<td class="phpdocumentor-cell">8</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/widget/class-base.php">src/public/widget/class-base.php</a></td>
|
||||
<td class="phpdocumentor-cell">1</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell"><a href="reports/markers.html#src/public/widget/class-reference-container.php">src/public/widget/class-reference-container.php</a></td>
|
||||
<td class="phpdocumentor-cell">1</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>
|
||||
<a id="src/includes/class-config.php"></a>
|
||||
<h3><abbr title="src/includes/class-config.php">class-config.php</abbr></h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
|
|
@ -107,13 +135,377 @@
|
|||
<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>
|
||||
<td class="phpdocumentor-cell">46</td>
|
||||
<td class="phpdocumentor-cell">Remove.</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>
|
||||
<td class="phpdocumentor-cell">56</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">73</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">84</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">95</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">106</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/includes/class-convert.php"></a>
|
||||
<h3><abbr title="src/includes/class-convert.php">class-convert.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">60</td>
|
||||
<td class="phpdocumentor-cell">Replace with built-in char casting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">92</td>
|
||||
<td class="phpdocumentor-cell">Replace with built-in string formatting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">154</td>
|
||||
<td class="phpdocumentor-cell">Replace with built-in type casting.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">179</td>
|
||||
<td class="phpdocumentor-cell">Review.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">203</td>
|
||||
<td class="phpdocumentor-cell">Replace with proper logging/debug functions.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/includes/class-settings.php"></a>
|
||||
<h3><abbr title="src/includes/class-settings.php">class-settings.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">1350</td>
|
||||
<td class="phpdocumentor-cell">Remove?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">48</td>
|
||||
<td class="phpdocumentor-cell">Refactor to use sane typing.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">202</td>
|
||||
<td class="phpdocumentor-cell">The mouse-over content truncation should be enabled by default to raise
|
||||
awareness of the functionality, prevent the screen from being filled on
|
||||
mouse-over, and allow the use of ‘Continue Reading’ functionality.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">234</td>
|
||||
<td class="phpdocumentor-cell">In titles, footnotes are still buggy, because WordPress uses the
|
||||
title string in menus and in the title element, but Footnotes doesn't
|
||||
delete footnotes in them.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">293</td>
|
||||
<td class="phpdocumentor-cell">Un-deprecate.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">1082</td>
|
||||
<td class="phpdocumentor-cell">Review, remove?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">1142</td>
|
||||
<td class="phpdocumentor-cell">Review. Why are the constants just initialised with these values?
|
||||
At the very least, we should stop using ‘yes’ to mean `true` etc.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/includes/class-template.php"></a>
|
||||
<h3><abbr title="src/includes/class-template.php">class-template.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">28</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">85</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">111</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">134</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">146</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">159</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">183</td>
|
||||
<td class="phpdocumentor-cell">Refactor templating.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/admin/class-wysiwyg.php"></a>
|
||||
<h3><abbr title="src/admin/class-wysiwyg.php">class-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">60</td>
|
||||
<td class="phpdocumentor-cell">Should this be `static`?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">86</td>
|
||||
<td class="phpdocumentor-cell">Should this be `static`?</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/admin/layout/class-engine.php"></a>
|
||||
<h3><abbr title="src/admin/layout/class-engine.php">class-engine.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">137</td>
|
||||
<td class="phpdocumentor-cell">Refactor sections into their own class?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">167</td>
|
||||
<td class="phpdocumentor-cell">Refactor meta boxes into their own class?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">167</td>
|
||||
<td class="phpdocumentor-cell">Pass actual functions rather than strings?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">253</td>
|
||||
<td class="phpdocumentor-cell">Move to {@see}.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">266</td>
|
||||
<td class="phpdocumentor-cell">Review nonce verification.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">339</td>
|
||||
<td class="phpdocumentor-cell">Review nonce verification.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">368</td>
|
||||
<td class="phpdocumentor-cell">Required? Should be `abstract`?</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">409</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">424</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">456</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">484</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">506</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">541</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">564</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">564</td>
|
||||
<td class="phpdocumentor-cell">Use proper colorpicker element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">588</td>
|
||||
<td class="phpdocumentor-cell">Refactor HTML generation.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/public/class-parser.php"></a>
|
||||
<h3><abbr title="src/public/class-parser.php">class-parser.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">267</td>
|
||||
<td class="phpdocumentor-cell">Reorganise dependencies.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">267</td>
|
||||
<td class="phpdocumentor-cell">Move call to `register_hooks()` to {@see}.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">287</td>
|
||||
<td class="phpdocumentor-cell">Move to {@see}.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">380</td>
|
||||
<td class="phpdocumentor-cell">Refactor to enqueue stylesheets properly in {@see}.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">1144</td>
|
||||
<td class="phpdocumentor-cell">Refactor to parse DOM rather than using RegEx.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">155</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">164</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="phpdocumentor-cell">TODO</td>
|
||||
<td class="phpdocumentor-cell">173</td>
|
||||
<td class="phpdocumentor-cell">Remove.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/public/widget/class-base.php"></a>
|
||||
<h3><abbr title="src/public/widget/class-base.php">class-base.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">29</td>
|
||||
<td class="phpdocumentor-cell">Review implemenation of Widgets API.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<a id="src/public/widget/class-reference-container.php"></a>
|
||||
<h3><abbr title="src/public/widget/class-reference-container.php">class-reference-container.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">27</td>
|
||||
<td class="phpdocumentor-cell">Review implemenation of Widgets API.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
Reference in a new issue