docs: update documentation

This commit is contained in:
Ben Goldsworthy 2021-04-27 09:41:35 +01:00
parent 850ab084ff
commit 4e4f0b0a2e
15 changed files with 884 additions and 398 deletions

View file

@ -165,13 +165,6 @@
</dt>
<dd>Public Plugin name for dashboard heading</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_NAME">C_STR_PLUGIN_NAME</a>
<span>
&nbsp;= &#039;footnotes&#039; </span>
</dt>
<dd>Internal Plugin name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME">C_STR_PLUGIN_PUBLIC_NAME</a>
<span>
@ -198,7 +191,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">56</span>
<span class="phpdocumentor-element-found-in__line">48</span>
</aside>
<p class="phpdocumentor-summary">Html tag for the LOVE symbol.</p>
@ -240,7 +233,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">64</span>
<span class="phpdocumentor-element-found-in__line">56</span>
</aside>
<p class="phpdocumentor-summary">HTML code for the &#039;love&#039; symbol used in dashboard heading</p>
@ -282,7 +275,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">72</span>
<span class="phpdocumentor-element-found-in__line">64</span>
</aside>
<p class="phpdocumentor-summary">Short code to DON&#039;T display the &#039;LOVE ME&#039; slug on certain pages.</p>
@ -324,7 +317,7 @@
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">48</span>
<span class="phpdocumentor-element-found-in__line">40</span>
</aside>
<p class="phpdocumentor-summary">Public Plugin name for dashboard heading</p>
@ -361,48 +354,6 @@ that isnt translated, and dropping the logo in another, translatable heading.
</dd>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_NAME">
C_STR_PLUGIN_NAME
<a href="classes/Footnotes-Config.html#constant_C_STR_PLUGIN_NAME" 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/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">24</span>
</aside>
<p class="phpdocumentor-summary">Internal Plugin name.</p>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">C_STR_PLUGIN_NAME</span>
= <span class="phpdocumentor-signature__default-value">&#039;footnotes&#039;</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>
</dl>
</article>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_C_STR_PLUGIN_PUBLIC_NAME">
@ -413,7 +364,7 @@ that isnt translated, and dropping the logo in another, translatable heading.
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/includes/class-footnotes-config.php"><a href="files/src-includes-class-footnotes-config.html"><abbr title="src/includes/class-footnotes-config.php">class-footnotes-config.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
<span class="phpdocumentor-element-found-in__line">26</span>
</aside>
<p class="phpdocumentor-summary">Public Plugin name.</p>