Skip to content

Commit

Permalink
rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mlwilkerson
mlwilkerson committed Aug 5, 2024
1 parent 8243353 commit 88cc4e5
Show file tree
Hide file tree
Showing 10 changed files with 555 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/classes/FortAwesome-FontAwesome-API-Controller.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_query_body">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes/class-fontawesome-api-controller.php"><a href="files/includes-class-fontawesome-api-controller.html"><abbr title="includes/class-fontawesome-api-controller.php">class-fontawesome-api-controller.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">169</span>
<span class="phpdocumentor-element-found-in__line">228</span>

</aside>

Expand Down
92 changes: 65 additions & 27 deletions docs/classes/FortAwesome-FontAwesome.html
View file

Large diffs are not rendered by default.

446 changes: 446 additions & 0 deletions docs/classes/FortAwesome-SelfhostSetupException.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/files/includes-class-fontawesome-exception.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h4 id="toc-classes">
changed between the time that options would have been valid upon saving and
the time that the page load occurs and those options are found to be invalid.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionSchemaException.html"><abbr title="\FortAwesome\ConflictDetectionSchemaException">ConflictDetectionSchemaException</abbr></a></dt><dd>Thrown when the conflict detection scanner posts data to a REST endpoint and
the data has an invalid schema. This would probably indicate a programming
error in this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionStorageException.html"><abbr title="\FortAwesome\ConflictDetectionStorageException">ConflictDetectionStorageException</abbr></a></dt><dd>Thrown when there&#039;s a failure to store conflict detection data as a transient.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ClientPreferencesSchemaException.html"><abbr title="\FortAwesome\ClientPreferencesSchemaException">ClientPreferencesSchemaException</abbr></a></dt><dd>Indicates that an incorrect array schema has been provided by a registerd client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-UpgradeException.html"><abbr title="\FortAwesome\UpgradeException">UpgradeException</abbr></a></dt><dd>Indicates a problem during upgrade process.</dd> </dl>
error in this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionStorageException.html"><abbr title="\FortAwesome\ConflictDetectionStorageException">ConflictDetectionStorageException</abbr></a></dt><dd>Thrown when there&#039;s a failure to store conflict detection data as a transient.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ClientPreferencesSchemaException.html"><abbr title="\FortAwesome\ClientPreferencesSchemaException">ClientPreferencesSchemaException</abbr></a></dt><dd>Indicates that an incorrect array schema has been provided by a registerd client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-UpgradeException.html"><abbr title="\FortAwesome\UpgradeException">UpgradeException</abbr></a></dt><dd>Indicates a problem during upgrade process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-SelfhostSetupException.html"><abbr title="\FortAwesome\SelfhostSetupException">SelfhostSetupException</abbr></a></dt><dd>Thrown on one of several errors conditions when setting up assets for self-hosting.</dd> </dl>



Expand Down
2 changes: 1 addition & 1 deletion docs/files/includes-class-fontawesome.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h4 class="phpdocumentor-element__name" id="function_fa">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes/class-fontawesome.php"><a href="files/includes-class-fontawesome.html"><abbr title="includes/class-fontawesome.php">class-fontawesome.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">3265</span>
<span class="phpdocumentor-element-found-in__line">3127</span>

</aside>

Expand Down
10 changes: 10 additions & 0 deletions docs/js/searchIndex.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,11 @@ Search.appendIndex(
"name": "UpgradeException",
"summary": "Indicates\u0020a\u0020problem\u0020during\u0020upgrade\u0020process.",
"url": "classes/FortAwesome-UpgradeException.html"
}, {
"fqsen": "\\FortAwesome\\SelfhostSetupException",
"name": "SelfhostSetupException",
"summary": "Thrown\u0020on\u0020one\u0020of\u0020several\u0020errors\u0020conditions\u0020when\u0020setting\u0020up\u0020assets\u0020for\u0020self\u002Dhosting.",
"url": "classes/FortAwesome-SelfhostSetupException.html"
}, {
"fqsen": "\\FortAwesome\\FontAwesome_REST_Response",
"name": "FontAwesome_REST_Response",
Expand Down Expand Up @@ -275,6 +280,11 @@ Search.appendIndex(
"name": "query",
"summary": "Runs\u0020a\u0020GraphQL\u0020query\u0020against\u0020the\u0020Font\u0020Awesome\u0020GraphQL\u0020API.",
"url": "classes/FortAwesome-FontAwesome.html#method_query"
}, {
"fqsen": "\\FortAwesome\\FontAwesome\u003A\u003Amaybe_enqueue_conflict_detection\u0028\u0029",
"name": "maybe_enqueue_conflict_detection",
"summary": "",
"url": "classes/FortAwesome-FontAwesome.html#method_maybe_enqueue_conflict_detection"
}, {
"fqsen": "\\FortAwesome\\FontAwesome\u003A\u003ASHORTCODE_TAG",
"name": "SHORTCODE_TAG",
Expand Down
4 changes: 2 additions & 2 deletions docs/namespaces/fortawesome.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h4 id="toc-classes">
changed between the time that options would have been valid upon saving and
the time that the page load occurs and those options are found to be invalid.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionSchemaException.html"><abbr title="\FortAwesome\ConflictDetectionSchemaException">ConflictDetectionSchemaException</abbr></a></dt><dd>Thrown when the conflict detection scanner posts data to a REST endpoint and
the data has an invalid schema. This would probably indicate a programming
error in this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionStorageException.html"><abbr title="\FortAwesome\ConflictDetectionStorageException">ConflictDetectionStorageException</abbr></a></dt><dd>Thrown when there&#039;s a failure to store conflict detection data as a transient.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ClientPreferencesSchemaException.html"><abbr title="\FortAwesome\ClientPreferencesSchemaException">ClientPreferencesSchemaException</abbr></a></dt><dd>Indicates that an incorrect array schema has been provided by a registerd client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-UpgradeException.html"><abbr title="\FortAwesome\UpgradeException">UpgradeException</abbr></a></dt><dd>Indicates a problem during upgrade process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome-REST-Response.html"><abbr title="\FortAwesome\FontAwesome_REST_Response">FontAwesome_REST_Response</abbr></a></dt><dd>Handles FontAwesome-specific enhancements to a REST response.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome.html"><abbr title="\FortAwesome\FontAwesome">FontAwesome</abbr></a></dt><dd>Main plugin class, a Singleton. Exposes all API methods and hooks that may be used by
error in this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionStorageException.html"><abbr title="\FortAwesome\ConflictDetectionStorageException">ConflictDetectionStorageException</abbr></a></dt><dd>Thrown when there&#039;s a failure to store conflict detection data as a transient.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ClientPreferencesSchemaException.html"><abbr title="\FortAwesome\ClientPreferencesSchemaException">ClientPreferencesSchemaException</abbr></a></dt><dd>Indicates that an incorrect array schema has been provided by a registerd client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-UpgradeException.html"><abbr title="\FortAwesome\UpgradeException">UpgradeException</abbr></a></dt><dd>Indicates a problem during upgrade process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-SelfhostSetupException.html"><abbr title="\FortAwesome\SelfhostSetupException">SelfhostSetupException</abbr></a></dt><dd>Thrown on one of several errors conditions when setting up assets for self-hosting.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome-REST-Response.html"><abbr title="\FortAwesome\FontAwesome_REST_Response">FontAwesome_REST_Response</abbr></a></dt><dd>Handles FontAwesome-specific enhancements to a REST response.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome.html"><abbr title="\FortAwesome\FontAwesome">FontAwesome</abbr></a></dt><dd>Main plugin class, a Singleton. Exposes all API methods and hooks that may be used by
client code to register with this plugin, to receive notifications about runtime
configuration, or to query the runtime configuration.</dd> </dl>

Expand Down Expand Up @@ -169,7 +169,7 @@ <h4 class="phpdocumentor-element__name" id="function_fa">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes/class-fontawesome.php"><a href="files/includes-class-fontawesome.html"><abbr title="includes/class-fontawesome.php">class-fontawesome.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">3265</span>
<span class="phpdocumentor-element-found-in__line">3127</span>

</aside>

Expand Down
4 changes: 2 additions & 2 deletions docs/packages/Application.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h4 id="toc-classes">
changed between the time that options would have been valid upon saving and
the time that the page load occurs and those options are found to be invalid.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionSchemaException.html"><abbr title="\FortAwesome\ConflictDetectionSchemaException">ConflictDetectionSchemaException</abbr></a></dt><dd>Thrown when the conflict detection scanner posts data to a REST endpoint and
the data has an invalid schema. This would probably indicate a programming
error in this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionStorageException.html"><abbr title="\FortAwesome\ConflictDetectionStorageException">ConflictDetectionStorageException</abbr></a></dt><dd>Thrown when there&#039;s a failure to store conflict detection data as a transient.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ClientPreferencesSchemaException.html"><abbr title="\FortAwesome\ClientPreferencesSchemaException">ClientPreferencesSchemaException</abbr></a></dt><dd>Indicates that an incorrect array schema has been provided by a registerd client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-UpgradeException.html"><abbr title="\FortAwesome\UpgradeException">UpgradeException</abbr></a></dt><dd>Indicates a problem during upgrade process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome-REST-Response.html"><abbr title="\FortAwesome\FontAwesome_REST_Response">FontAwesome_REST_Response</abbr></a></dt><dd>Handles FontAwesome-specific enhancements to a REST response.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome.html"><abbr title="\FortAwesome\FontAwesome">FontAwesome</abbr></a></dt><dd>Main plugin class, a Singleton. Exposes all API methods and hooks that may be used by
error in this plugin.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ConflictDetectionStorageException.html"><abbr title="\FortAwesome\ConflictDetectionStorageException">ConflictDetectionStorageException</abbr></a></dt><dd>Thrown when there&#039;s a failure to store conflict detection data as a transient.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-ClientPreferencesSchemaException.html"><abbr title="\FortAwesome\ClientPreferencesSchemaException">ClientPreferencesSchemaException</abbr></a></dt><dd>Indicates that an incorrect array schema has been provided by a registerd client.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-UpgradeException.html"><abbr title="\FortAwesome\UpgradeException">UpgradeException</abbr></a></dt><dd>Indicates a problem during upgrade process.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-SelfhostSetupException.html"><abbr title="\FortAwesome\SelfhostSetupException">SelfhostSetupException</abbr></a></dt><dd>Thrown on one of several errors conditions when setting up assets for self-hosting.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome-REST-Response.html"><abbr title="\FortAwesome\FontAwesome_REST_Response">FontAwesome_REST_Response</abbr></a></dt><dd>Handles FontAwesome-specific enhancements to a REST response.</dd> <dt class="phpdocumentor-table-of-contents__entry -class"><a href="classes/FortAwesome-FontAwesome.html"><abbr title="\FortAwesome\FontAwesome">FontAwesome</abbr></a></dt><dd>Main plugin class, a Singleton. Exposes all API methods and hooks that may be used by
client code to register with this plugin, to receive notifications about runtime
configuration, or to query the runtime configuration.</dd> </dl>

Expand Down Expand Up @@ -387,7 +387,7 @@ <h4 class="phpdocumentor-element__name" id="function_fa">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="includes/class-fontawesome.php"><a href="files/includes-class-fontawesome.html"><abbr title="includes/class-fontawesome.php">class-fontawesome.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">3265</span>
<span class="phpdocumentor-element-found-in__line">3127</span>

</aside>

Expand Down
4 changes: 2 additions & 2 deletions docs/reports/deprecated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,12 @@ <h3><abbr title="includes/class-fontawesome.php">class-fontawesome.php</abbr></h
<th class="phpdocumentor-heading">Reason</th>
</tr>
<tr>
<td class="phpdocumentor-cell">749</td>
<td class="phpdocumentor-cell">778</td>
<td class="phpdocumentor-cell"><a href="classes/FortAwesome-FontAwesome.html#method_latest_version"><abbr title="\FortAwesome\FontAwesome::latest_version()">FontAwesome::latest_version()</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
<tr>
<td class="phpdocumentor-cell">1536</td>
<td class="phpdocumentor-cell">1505</td>
<td class="phpdocumentor-cell"><a href="classes/FortAwesome-FontAwesome.html#method_v4_compatibility"><abbr title="\FortAwesome\FontAwesome::v4_compatibility()">FontAwesome::v4_compatibility()</abbr></a></td>
<td class="phpdocumentor-cell"></td>
</tr>
Expand Down
28 changes: 25 additions & 3 deletions docs/reports/markers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,32 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil
<div class="phpdocumentor-row">
<h2 class="phpdocumentor-content__title">Markers</h2>

<div class="phpdocumentor-admonition phpdocumentor-admonition--success">
No markers have been found in this project.
</div>
<h3>Table of Contents</h3>
<table class="phpdocumentor-table_of_contents">
<tr>
<td class="phpdocumentor-cell"><a href="reports/markers.html#includes/class-fontawesome-api-controller.php">includes/class-fontawesome-api-controller.php</a></td>
<td class="phpdocumentor-cell">1</td>
</tr>
</table>

<a id="includes/class-fontawesome-api-controller.php"></a>
<h3><abbr title="includes/class-fontawesome-api-controller.php">class-fontawesome-api-controller.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">195</td>
<td class="phpdocumentor-cell">make a real error response.</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
Expand Down

0 comments on commit 88cc4e5

Please sign in to comment.