Skip to content

Commit 88cc4e5

Browse files
committed
rebuild docs
1 parent 8243353 commit 88cc4e5

10 files changed

+555
-39
lines changed

docs/classes/FortAwesome-FontAwesome-API-Controller.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ <h4 class="phpdocumentor-element__name" id="method_get_query_body">
220220
<aside class="phpdocumentor-element-found-in">
221221
<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>
222222
:
223-
<span class="phpdocumentor-element-found-in__line">169</span>
223+
<span class="phpdocumentor-element-found-in__line">228</span>
224224

225225
</aside>
226226

docs/classes/FortAwesome-FontAwesome.html

Lines changed: 65 additions & 27 deletions
Large diffs are not rendered by default.

docs/classes/FortAwesome-SelfhostSetupException.html

Lines changed: 446 additions & 0 deletions
Large diffs are not rendered by default.

docs/files/includes-class-fontawesome-exception.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h4 id="toc-classes">
128128
changed between the time that options would have been valid upon saving and
129129
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
130130
the data has an invalid schema. This would probably indicate a programming
131-
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>
131+
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>
132132

133133

134134

docs/files/includes-class-fontawesome.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ <h4 class="phpdocumentor-element__name" id="function_fa">
157157
<aside class="phpdocumentor-element-found-in">
158158
<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>
159159
:
160-
<span class="phpdocumentor-element-found-in__line">3265</span>
160+
<span class="phpdocumentor-element-found-in__line">3127</span>
161161

162162
</aside>
163163

docs/js/searchIndex.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,11 @@ Search.appendIndex(
170170
"name": "UpgradeException",
171171
"summary": "Indicates\u0020a\u0020problem\u0020during\u0020upgrade\u0020process.",
172172
"url": "classes/FortAwesome-UpgradeException.html"
173+
}, {
174+
"fqsen": "\\FortAwesome\\SelfhostSetupException",
175+
"name": "SelfhostSetupException",
176+
"summary": "Thrown\u0020on\u0020one\u0020of\u0020several\u0020errors\u0020conditions\u0020when\u0020setting\u0020up\u0020assets\u0020for\u0020self\u002Dhosting.",
177+
"url": "classes/FortAwesome-SelfhostSetupException.html"
173178
}, {
174179
"fqsen": "\\FortAwesome\\FontAwesome_REST_Response",
175180
"name": "FontAwesome_REST_Response",
@@ -275,6 +280,11 @@ Search.appendIndex(
275280
"name": "query",
276281
"summary": "Runs\u0020a\u0020GraphQL\u0020query\u0020against\u0020the\u0020Font\u0020Awesome\u0020GraphQL\u0020API.",
277282
"url": "classes/FortAwesome-FontAwesome.html#method_query"
283+
}, {
284+
"fqsen": "\\FortAwesome\\FontAwesome\u003A\u003Amaybe_enqueue_conflict_detection\u0028\u0029",
285+
"name": "maybe_enqueue_conflict_detection",
286+
"summary": "",
287+
"url": "classes/FortAwesome-FontAwesome.html#method_maybe_enqueue_conflict_detection"
278288
}, {
279289
"fqsen": "\\FortAwesome\\FontAwesome\u003A\u003ASHORTCODE_TAG",
280290
"name": "SHORTCODE_TAG",

docs/namespaces/fortawesome.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h4 id="toc-classes">
126126
changed between the time that options would have been valid upon saving and
127127
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
128128
the data has an invalid schema. This would probably indicate a programming
129-
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
129+
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
130130
client code to register with this plugin, to receive notifications about runtime
131131
configuration, or to query the runtime configuration.</dd> </dl>
132132

@@ -169,7 +169,7 @@ <h4 class="phpdocumentor-element__name" id="function_fa">
169169
<aside class="phpdocumentor-element-found-in">
170170
<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>
171171
:
172-
<span class="phpdocumentor-element-found-in__line">3265</span>
172+
<span class="phpdocumentor-element-found-in__line">3127</span>
173173

174174
</aside>
175175

docs/packages/Application.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h4 id="toc-classes">
126126
changed between the time that options would have been valid upon saving and
127127
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
128128
the data has an invalid schema. This would probably indicate a programming
129-
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
129+
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
130130
client code to register with this plugin, to receive notifications about runtime
131131
configuration, or to query the runtime configuration.</dd> </dl>
132132

@@ -387,7 +387,7 @@ <h4 class="phpdocumentor-element__name" id="function_fa">
387387
<aside class="phpdocumentor-element-found-in">
388388
<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>
389389
:
390-
<span class="phpdocumentor-element-found-in__line">3265</span>
390+
<span class="phpdocumentor-element-found-in__line">3127</span>
391391

392392
</aside>
393393

docs/reports/deprecated.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ <h3><abbr title="includes/class-fontawesome.php">class-fontawesome.php</abbr></h
108108
<th class="phpdocumentor-heading">Reason</th>
109109
</tr>
110110
<tr>
111-
<td class="phpdocumentor-cell">749</td>
111+
<td class="phpdocumentor-cell">778</td>
112112
<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>
113113
<td class="phpdocumentor-cell"></td>
114114
</tr>
115115
<tr>
116-
<td class="phpdocumentor-cell">1536</td>
116+
<td class="phpdocumentor-cell">1505</td>
117117
<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>
118118
<td class="phpdocumentor-cell"></td>
119119
</tr>

docs/reports/markers.html

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,10 +92,32 @@ <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Fil
9292
<div class="phpdocumentor-row">
9393
<h2 class="phpdocumentor-content__title">Markers</h2>
9494

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

103+
<a id="includes/class-fontawesome-api-controller.php"></a>
104+
<h3><abbr title="includes/class-fontawesome-api-controller.php">class-fontawesome-api-controller.php</abbr></h3>
105+
<table>
106+
<thead>
107+
<tr>
108+
<th class="phpdocumentor-heading">Type</th>
109+
<th class="phpdocumentor-heading">Line</th>
110+
<th class="phpdocumentor-heading">Description</th>
111+
</tr>
112+
</thead>
113+
<tbody>
114+
<tr>
115+
<td class="phpdocumentor-cell">TODO</td>
116+
<td class="phpdocumentor-cell">195</td>
117+
<td class="phpdocumentor-cell">make a real error response.</td>
118+
</tr>
119+
</tbody>
120+
</table>
99121
</div>
100122
</section>
101123
</div>

0 commit comments

Comments
 (0)