docs: update documentation
This commit is contained in:
parent
850ab084ff
commit
4e4f0b0a2e
15 changed files with 884 additions and 398 deletions
|
|
@ -165,9 +165,9 @@ and JavaScript.</p>
|
|||
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
||||
<a href="classes/Footnotes-Public.html#property_a_obj_task">$a_obj_task</a>
|
||||
<span>
|
||||
: <abbr title="\Task">Task</abbr> </span>
|
||||
: <abbr title="\Footnote_Parser">Footnote_Parser</abbr> </span>
|
||||
</dt>
|
||||
<dd>The Plugin task.</dd>
|
||||
<dd>The footnote parser.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -property -public">
|
||||
<a href="classes/Footnotes-Public.html#property_a_str_script_mode">$a_str_script_mode</a>
|
||||
|
|
@ -183,6 +183,13 @@ and JavaScript.</p>
|
|||
</dt>
|
||||
<dd>The ID of this plugin.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
||||
<a href="classes/Footnotes-Public.html#property_reference_container_widget">$reference_container_widget</a>
|
||||
<span>
|
||||
: <a href="classes/Footnotes-Widget-Reference-Container.html"><abbr title="\Footnotes_Widget_Reference_Container">Footnotes_Widget_Reference_Container</abbr></a> </span>
|
||||
</dt>
|
||||
<dd>The reference container widget.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
||||
<a href="classes/Footnotes-Public.html#property_version">$version</a>
|
||||
<span>
|
||||
|
|
@ -211,6 +218,13 @@ and JavaScript.</p>
|
|||
</dt>
|
||||
<dd>Register the stylesheets for the public-facing side of the site.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
||||
<a href="classes/Footnotes-Public.html#method_register_widgets">register_widgets()</a>
|
||||
<span>
|
||||
: mixed </span>
|
||||
</dt>
|
||||
<dd>Register the widget(s) for the public-facing side of the site.</dd>
|
||||
|
||||
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
||||
<a href="classes/Footnotes-Public.html#method_load_dependencies">load_dependencies()</a>
|
||||
<span>
|
||||
|
|
@ -246,7 +260,7 @@ and JavaScript.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">65</span>
|
||||
<span class="phpdocumentor-element-found-in__line">73</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Allows to determine whether alternative tooltips are enabled.</p>
|
||||
|
|
@ -303,7 +317,7 @@ and JavaScript.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">74</span>
|
||||
<span class="phpdocumentor-element-found-in__line">82</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Allows to determine whether AMP compatibility mode is enabled.</p>
|
||||
|
|
@ -361,7 +375,7 @@ and JavaScript.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">56</span>
|
||||
<span class="phpdocumentor-element-found-in__line">64</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Flag for using tooltips.</p>
|
||||
|
|
@ -418,14 +432,14 @@ and JavaScript.</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">47</span>
|
||||
<span class="phpdocumentor-element-found-in__line">55</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The Plugin task.</p>
|
||||
<p class="phpdocumentor-summary">The footnote parser.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__type"><abbr title="\Task">Task</abbr></span>
|
||||
<span class="phpdocumentor-signature__type"><abbr title="\Footnote_Parser">Footnote_Parser</abbr></span>
|
||||
<span class="phpdocumentor-signature__name">$a_obj_task</span>
|
||||
= <span class="phpdocumentor-signature__default-value">
|
||||
ull</span></code>
|
||||
|
|
@ -476,7 +490,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">84</span>
|
||||
<span class="phpdocumentor-element-found-in__line">92</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Allows to determine the script mode among jQuery or plain JS.</p>
|
||||
|
|
@ -572,6 +586,53 @@ ull</span></code>
|
|||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article
|
||||
class="
|
||||
phpdocumentor-element
|
||||
-property
|
||||
-private
|
||||
"
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="property_reference_container_widget">
|
||||
$reference_container_widget
|
||||
<a href="classes/Footnotes-Public.html#property_reference_container_widget" 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="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">46</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">The reference container widget.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">private</span>
|
||||
<span class="phpdocumentor-signature__type"><a href="classes/Footnotes-Widget-Reference-Container.html"><abbr title="\Footnotes_Widget_Reference_Container">Footnotes_Widget_Reference_Container</abbr></a></span>
|
||||
<span class="phpdocumentor-signature__name">$reference_container_widget</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">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
</article>
|
||||
<article
|
||||
class="
|
||||
|
|
@ -649,7 +710,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">93</span>
|
||||
<span class="phpdocumentor-element-found-in__line">101</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Initialize the class and set its properties.</p>
|
||||
|
|
@ -719,7 +780,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">206</span>
|
||||
<span class="phpdocumentor-element-found-in__line">216</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Register the JavaScript for the public-facing side of the site.</p>
|
||||
|
|
@ -808,7 +869,7 @@ ull</span></code>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">141</span>
|
||||
<span class="phpdocumentor-element-found-in__line">151</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Register the stylesheets for the public-facing side of the site.</p>
|
||||
|
|
@ -865,6 +926,65 @@ is true (set in <code class="prettyprint">footnotes.php</code>).</p>
|
|||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</article>
|
||||
<article
|
||||
class="phpdocumentor-element
|
||||
-method
|
||||
-public
|
||||
"
|
||||
>
|
||||
<h4 class="phpdocumentor-element__name" id="method_register_widgets">
|
||||
register_widgets()
|
||||
<a href="classes/Footnotes-Public.html#method_register_widgets" class="headerlink"><i class="fas fa-link"></i></a>
|
||||
</h4>
|
||||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">271</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Register the widget(s) for the public-facing side of the site.</p>
|
||||
|
||||
<code class="phpdocumentor-code phpdocumentor-signature ">
|
||||
<span class="phpdocumentor-signature__visibility">public</span>
|
||||
<span class="phpdocumentor-signature__name">register_widgets</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">since</span>
|
||||
</dt>
|
||||
<dd class="phpdocumentor-tag-list__definition">
|
||||
<span class="phpdocumentor-tag-link">1.5.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"></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">2.8.0</span>
|
||||
|
||||
<section class="phpdocumentor-description"><p>Moved to <code class="prettyprint">Footnotes_Public</code> class.</p>
|
||||
</section>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
||||
<span class="phpdocumentor-signature__response_type">mixed</span>
|
||||
—
|
||||
<section class="phpdocumentor-description"></section>
|
||||
|
||||
|
||||
</article>
|
||||
<article
|
||||
class="phpdocumentor-element
|
||||
|
|
@ -879,7 +999,7 @@ is true (set in <code class="prettyprint">footnotes.php</code>).</p>
|
|||
<aside class="phpdocumentor-element-found-in">
|
||||
<abbr class="phpdocumentor-element-found-in__file" title="src/public/class-footnotes-public.php"><a href="files/src-public-class-footnotes-public.html"><abbr title="src/public/class-footnotes-public.php">class-footnotes-public.php</abbr></a></abbr>
|
||||
:
|
||||
<span class="phpdocumentor-element-found-in__line">119</span>
|
||||
<span class="phpdocumentor-element-found-in__line">127</span>
|
||||
</aside>
|
||||
|
||||
<p class="phpdocumentor-summary">Load the required public-facing dependencies.</p>
|
||||
|
|
|
|||
Reference in a new issue