Skip to content

Commit

Permalink
Updated phpDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
KBurkholder committed May 24, 2024
1 parent 5176093 commit 87a1f34
Show file tree
Hide file tree
Showing 100 changed files with 2,428 additions and 259 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down Expand Up @@ -264,7 +268,7 @@ <h3 id="toc">
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
<a href="classes/EarthAsylumConsulting-Extensions-eacDoojigger-registration.html#constant_VERSION">VERSION</a>
<span>
&nbsp;= &#039;23.0602.1&#039; </span>
&nbsp;= &#039;24.0516.1&#039; </span>
</dt>
<dd></dd>

Expand Down Expand Up @@ -648,7 +652,7 @@ <h4 class="phpdocumentor-element__name" id="constant_VERSION">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">VERSION</span>
= <span class="phpdocumentor-signature__default-value">&#039;23.0602.1&#039;</span>
= <span class="phpdocumentor-signature__default-value">&#039;24.0516.1&#039;</span>
</code>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
4 changes: 4 additions & 0 deletions docs/classes/EarthAsylumConsulting-Helpers-LogLevel.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
219 changes: 145 additions & 74 deletions docs/classes/EarthAsylumConsulting-Plugin-eacDoojigger.html

Large diffs are not rendered by default.

8 changes: 6 additions & 2 deletions docs/classes/EarthAsylumConsulting-Traits-code-editor.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down Expand Up @@ -306,7 +310,7 @@ <h4 class="phpdocumentor-element__name" id="method_codeedit_get_codemirror">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="eacDoojigger/EarthAsylumConsulting/Traits/code_editor.trait.php"><a href="files/eacdoojigger-earthasylumconsulting-traits-code-editor-trait.html"><abbr title="eacDoojigger/EarthAsylumConsulting/Traits/code_editor.trait.php">code_editor.trait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">157</span>
<span class="phpdocumentor-element-found-in__line">162</span>

</aside>

Expand Down Expand Up @@ -389,7 +393,7 @@ <h4 class="phpdocumentor-element__name" id="method_codeedit_get_wpeditor">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="eacDoojigger/EarthAsylumConsulting/Traits/code_editor.trait.php"><a href="files/eacdoojigger-earthasylumconsulting-traits-code-editor-trait.html"><abbr title="eacDoojigger/EarthAsylumConsulting/Traits/code_editor.trait.php">code_editor.trait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
<span class="phpdocumentor-element-found-in__line">193</span>

</aside>

Expand Down
4 changes: 4 additions & 0 deletions docs/classes/EarthAsylumConsulting-Traits-datetime.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
4 changes: 4 additions & 0 deletions docs/classes/EarthAsylumConsulting-Traits-plugin-help.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
71 changes: 7 additions & 64 deletions docs/classes/EarthAsylumConsulting-Traits-plugin-loader.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down Expand Up @@ -261,13 +265,6 @@ <h3 id="toc">
</dt>
<dd>Load object (once) for automatic updates.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/EarthAsylumConsulting-Traits-plugin-loader.html#method_plugin_updater_filter">plugin_updater_filter()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Filter for automatic updates.</dd>

</dl>


Expand Down Expand Up @@ -407,7 +404,7 @@ <h4 class="phpdocumentor-element__name" id="method_isPHP">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="eacDoojigger/EarthAsylumConsulting/Traits/plugin_loader.trait.php"><a href="files/eacdoojigger-earthasylumconsulting-traits-plugin-loader-trait.html"><abbr title="eacDoojigger/EarthAsylumConsulting/Traits/plugin_loader.trait.php">plugin_loader.trait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">253</span>
<span class="phpdocumentor-element-found-in__line">256</span>

</aside>

Expand Down Expand Up @@ -492,7 +489,7 @@ <h4 class="phpdocumentor-element__name" id="method_loadPluginUpdater">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="eacDoojigger/EarthAsylumConsulting/Traits/plugin_loader.trait.php"><a href="files/eacdoojigger-earthasylumconsulting-traits-plugin-loader-trait.html"><abbr title="eacDoojigger/EarthAsylumConsulting/Traits/plugin_loader.trait.php">plugin_loader.trait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">188</span>
<span class="phpdocumentor-element-found-in__line">192</span>

</aside>

Expand All @@ -502,63 +499,9 @@ <h4 class="phpdocumentor-element__name" id="method_loadPluginUpdater">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">loadPluginUpdater</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pluginFile</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$updateType</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>

<section class="phpdocumentor-description"><p>Uses 'pre_set_site_transient_update_plugins' and 'plugins_api_args' filter so we only do this when needed.</p>
</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">$pluginFile</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>plugin file pathname ($plugin_detail['PluginFile'])</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$updateType</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>auto-update type ('self' | 'wp') ($plugin_detail['AutoUpdate'])</p>
<section class="phpdocumentor-description"><p>Now (as of v2.6) only used by extensions.</p>
</section>

</dd>
</dl>



<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;


</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_plugin_updater_filter">
plugin_updater_filter()
<a href="classes/EarthAsylumConsulting-Traits-plugin-loader.html#method_plugin_updater_filter" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="eacDoojigger/EarthAsylumConsulting/Traits/plugin_loader.trait.php"><a href="files/eacdoojigger-earthasylumconsulting-traits-plugin-loader-trait.html"><abbr title="eacDoojigger/EarthAsylumConsulting/Traits/plugin_loader.trait.php">plugin_loader.trait.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">214</span>

</aside>

<p class="phpdocumentor-summary">Filter for automatic updates.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">plugin_updater_filter</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$pluginFile</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$updateType</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
4 changes: 4 additions & 0 deletions docs/classes/EarthAsylumConsulting-Traits-plugin-update.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
4 changes: 4 additions & 0 deletions docs/classes/EarthAsylumConsulting-Traits-zip-archive.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojigger.html" class="">eacDoojigger</a>

</li>
<li>
<a href="packages/eacDoojiggerUtilities-eacDoojiggerPluginUpdater.html" class="">eacDoojiggerPluginUpdater</a>

</li>
</ul>

Expand Down
Loading

0 comments on commit 87a1f34

Please sign in to comment.