Skip to content

Commit 2ddb4db

Browse files
gecampbellgecampbell
committed
regenerated API docs`
1 parent 40637d4 commit 2ddb4db

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+6649
-31402
lines changed

‎docs/api/asyncresponse.html‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ <h4>Methods</h4>
160160
<a style="font-style: italic;" href="#AsyncResponse::to_string()">to_string</a>,
161161
<div class="method">
162162
<a id="AsyncResponse::Action()"></a><h3>Action<span class="nb-faded-text">(
163-
\OpenCloud\$object
163+
164164

165165
$object,
166166

@@ -182,9 +182,10 @@ <h4>Description</h4>
182182
</tr></thead>
183183
<tbody><tr>
184184
<td>$object</td>
185-
<td style="white-space: normal;">\OpenCloud\$object</td>
185+
<td style="white-space: normal;">n/a</td>
186186
<td><ul>
187-
<li>this will be encoded as json, and we handle all the JSON error-checking in one place</li>
187+
<li>this will be encoded as json, and we handle all the JSON
188+
error-checking in one place</li>
188189
</ul>
189190
</td>
190191
<td></td>
@@ -559,7 +560,8 @@ <h4>Description</h4>
559560
<td>$type</td>
560561
<td style="white-space: normal;">string</td>
561562
<td><ul>
562-
<li>'self' is most common; use 'bookmark' for the version-independent one</li>
563+
<li>'self' is most common; use 'bookmark' for
564+
the version-independent one</li>
563565
</ul>
564566
</td>
565567
<td>'self'</td>
@@ -1539,7 +1541,10 @@ <h4>Description</h4>
15391541
<tr>
15401542
<td>$callback</td>
15411543
<td style="white-space: normal;">callable</td>
1542-
<td><p>a callback function that is invoked with each repetition of the polling sequence. This can be used, for example, to update a status display or to permit other operations to continue</p></td>
1544+
<td><p>a callback function that is invoked with
1545+
each repetition of the polling sequence. This can be used, for
1546+
example, to update a status display or to permit other operations
1547+
to continue</p></td>
15431548
<td>NULL</td>
15441549
</tr>
15451550
<tr>
@@ -1761,7 +1766,8 @@ <h4>Description</h4>
17611766
<tr>
17621767
<td>$msg</td>
17631768
<td style="white-space: normal;">string</td>
1764-
<td><p>The message string (required); can be in sprintf() format.</p>
1769+
<td><p>The message string (required); can be in
1770+
sprintf() format.</p>
17651771
</td>
17661772
<td></td>
17671773
</tr>
@@ -2024,7 +2030,7 @@ <h4>Properties</h4>
20242030
<div style="clear: both"></div>
20252031
</div>
20262032
</div>
2027-
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a10</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
2033+
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
20282034
$(function() {
20292035

20302036
var is_chrome = /chrome/.test( navigator.userAgent.toLowerCase() );
@@ -2192,7 +2198,9 @@ <h1>Namespaces</h1>
21922198
<li><span class="class"><a href="dnsobject.html#DnsObject">DnsObject</a><br><small>The DnsObject class is an extension of the PersistentObject class that
21932199
permits the asynchronous responses used by Cloud DNS</small></span></li>
21942200
<li><span class="class"><a href="domain.html#Domain">Domain</a><br><small>The Domain class represents a single domain</small></span></li>
2201+
<li><span class="class"><a href="ptrrecord.html#PtrRecord">PtrRecord</a><br><small>PTR records are used for reverse DNS</small></span></li>
21952202
<li><span class="class"><a href="record.html#Record">Record</a><br><small>The Record class represents a single domain record</small></span></li>
2203+
<li><span class="class"><a href="exceptions.html#RecordTypeError">RecordTypeError</a><br><small></small></span></li>
21962204
<li><span class="class"><a href="domain.html#Subdomain">Subdomain</a><br><small>The Subdomain is basically another domain, albeit one that is a child of
21972205
a parent domain.</small></span></li>
21982206
</ul>

‎docs/api/base.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h1>Properties</h1>
7878
</div>
7979
<label class="property-key">Abstract</label><div class="property-value">Yes 
8080
</div>
81-
<label class="property-key">Final</label><div class="property-value">Yes 
81+
<label class="property-key">Final</label><div class="property-value">No 
8282
</div>
8383
</div>
8484
<h4>Description</h4>
@@ -487,7 +487,8 @@ <h4>Description</h4>
487487
<tr>
488488
<td>$msg</td>
489489
<td style="white-space: normal;">string</td>
490-
<td><p>The message string (required); can be in sprintf() format.</p>
490+
<td><p>The message string (required); can be in
491+
sprintf() format.</p>
491492
</td>
492493
<td></td>
493494
</tr>
@@ -606,7 +607,7 @@ <h4>Properties</h4>
606607
<div style="clear: both"></div>
607608
</div>
608609
</div>
609-
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a10</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
610+
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
610611
$(function() {
611612

612613
var is_chrome = /chrome/.test( navigator.userAgent.toLowerCase() );
@@ -774,7 +775,9 @@ <h1>Namespaces</h1>
774775
<li><span class="class"><a href="dnsobject.html#DnsObject">DnsObject</a><br><small>The DnsObject class is an extension of the PersistentObject class that
775776
permits the asynchronous responses used by Cloud DNS</small></span></li>
776777
<li><span class="class"><a href="domain.html#Domain">Domain</a><br><small>The Domain class represents a single domain</small></span></li>
778+
<li><span class="class"><a href="ptrrecord.html#PtrRecord">PtrRecord</a><br><small>PTR records are used for reverse DNS</small></span></li>
777779
<li><span class="class"><a href="record.html#Record">Record</a><br><small>The Record class represents a single domain record</small></span></li>
780+
<li><span class="class"><a href="exceptions.html#RecordTypeError">RecordTypeError</a><br><small></small></span></li>
778781
<li><span class="class"><a href="domain.html#Subdomain">Subdomain</a><br><small>The Subdomain is basically another domain, albeit one that is a child of
779782
a parent domain.</small></span></li>
780783
</ul>

‎docs/api/cloud.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ <h1>Properties</h1>
6161
</div>
6262
<h2>Description</h2>A convenience file that loads all the other components<br><br><a name="includes"></a><h2>Includes</h2> <span class="nb-faded-text">(Require Once)</span><br> <span class="nb-faded-text">(Require Once)</span><br> <span class="nb-faded-text">(Require Once)</span><br> <span class="nb-faded-text">(Require Once)</span><br>
6363
</div>
64-
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a10</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
64+
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
6565
$(function() {
6666

6767
var is_chrome = /chrome/.test( navigator.userAgent.toLowerCase() );
@@ -229,7 +229,9 @@ <h1>Namespaces</h1>
229229
<li><span class="class"><a href="dnsobject.html#DnsObject">DnsObject</a><br><small>The DnsObject class is an extension of the PersistentObject class that
230230
permits the asynchronous responses used by Cloud DNS</small></span></li>
231231
<li><span class="class"><a href="domain.html#Domain">Domain</a><br><small>The Domain class represents a single domain</small></span></li>
232+
<li><span class="class"><a href="ptrrecord.html#PtrRecord">PtrRecord</a><br><small>PTR records are used for reverse DNS</small></span></li>
232233
<li><span class="class"><a href="record.html#Record">Record</a><br><small>The Record class represents a single domain record</small></span></li>
234+
<li><span class="class"><a href="exceptions.html#RecordTypeError">RecordTypeError</a><br><small></small></span></li>
233235
<li><span class="class"><a href="domain.html#Subdomain">Subdomain</a><br><small>The Subdomain is basically another domain, albeit one that is a child of
234236
a parent domain.</small></span></li>
235237
</ul>

‎docs/api/collection.html‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,10 @@ <h4>Description</h4>
509509
<tbody><tr>
510510
<td>$testfunc</td>
511511
<td style="white-space: normal;">callable</td>
512-
<td><p>a callback function that is passed each item in turn. Note that <code>Select()</code> performs an explicit test for <code>FALSE</code>, so functions like <code>strpos()</code> need to be cast into a boolean value (and not just return the integer).</p>
512+
<td><p>a callback function that is passed each item
513+
in turn. Note that <code>Select()</code> performs an explicit test for
514+
<code>FALSE</code>, so functions like <code>strpos()</code> need to be cast into a
515+
boolean value (and not just return the integer).</p>
513516
</td>
514517
<td></td>
515518
</tr></tbody>
@@ -601,7 +604,8 @@ <h4>Description</h4>
601604
<tr>
602605
<td>$callback</td>
603606
<td style="white-space: normal;">callable</td>
604-
<td><p>the name of the function (or array of object, function name)</p>
607+
<td><p>the name of the function (or array of
608+
object, function name)</p>
605609
</td>
606610
<td></td>
607611
</tr>
@@ -872,7 +876,8 @@ <h4>Description</h4>
872876
<td>$itemclass</td>
873877
<td style="white-space: normal;">string</td>
874878
<td><ul>
875-
<li>the Class of each item in the collection (assumed to be the name of the factory method)</li>
879+
<li>the Class of each item in the collection
880+
(assumed to be the name of the factory method)</li>
876881
</ul>
877882
</td>
878883
<td></td>
@@ -1013,7 +1018,8 @@ <h4>Description</h4>
10131018
<tr>
10141019
<td>$msg</td>
10151020
<td style="white-space: normal;">string</td>
1016-
<td><p>The message string (required); can be in sprintf() format.</p>
1021+
<td><p>The message string (required); can be in
1022+
sprintf() format.</p>
10171023
</td>
10181024
<td></td>
10191025
</tr>
@@ -1284,7 +1290,7 @@ <h4>Properties</h4>
12841290
<div style="clear: both"></div>
12851291
</div>
12861292
</div>
1287-
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a10</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
1293+
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
12881294
$(function() {
12891295

12901296
var is_chrome = /chrome/.test( navigator.userAgent.toLowerCase() );
@@ -1452,7 +1458,9 @@ <h1>Namespaces</h1>
14521458
<li><span class="class"><a href="dnsobject.html#DnsObject">DnsObject</a><br><small>The DnsObject class is an extension of the PersistentObject class that
14531459
permits the asynchronous responses used by Cloud DNS</small></span></li>
14541460
<li><span class="class"><a href="domain.html#Domain">Domain</a><br><small>The Domain class represents a single domain</small></span></li>
1461+
<li><span class="class"><a href="ptrrecord.html#PtrRecord">PtrRecord</a><br><small>PTR records are used for reverse DNS</small></span></li>
14551462
<li><span class="class"><a href="record.html#Record">Record</a><br><small>The Record class represents a single domain record</small></span></li>
1463+
<li><span class="class"><a href="exceptions.html#RecordTypeError">RecordTypeError</a><br><small></small></span></li>
14561464
<li><span class="class"><a href="domain.html#Subdomain">Subdomain</a><br><small>The Subdomain is basically another domain, albeit one that is a child of
14571465
a parent domain.</small></span></li>
14581466
</ul>

‎docs/api/compute.html‎

Lines changed: 45 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,8 @@ <h4>Description</h4>
311311
<tr>
312312
<td>$parm</td>
313313
<td style="white-space: normal;">array</td>
314-
<td><p>(optional) array of key/value pairs to use as query strings</p>
314+
<td><p>(optional) array of key/value pairs to use as
315+
query strings</p>
315316
</td>
316317
<td>array()</td>
317318
</tr>
@@ -414,7 +415,8 @@ <h4>Description</h4>
414415
<td>$id</td>
415416
<td style="white-space: normal;">string</td>
416417
<td><ul>
417-
<li>if supplied, the Flavor identified by this is retrieved</li>
418+
<li>if supplied, the Flavor identified by this is
419+
retrieved</li>
418420
</ul>
419421
</td>
420422
<td>NULL</td>
@@ -480,7 +482,9 @@ <h4>Description</h4>
480482
<td>$details</td>
481483
<td style="white-space: normal;">boolean</td>
482484
<td><ul>
483-
<li>if TRUE (the default), returns full details. Set to FALSE to retrieve minimal details and possibly improve performance.</li>
485+
<li>if TRUE (the default), returns full details.
486+
Set to FALSE to retrieve minimal details and possibly improve
487+
performance.</li>
484488
</ul>
485489
</td>
486490
<td>TRUE</td>
@@ -489,7 +493,8 @@ <h4>Description</h4>
489493
<td>$filter</td>
490494
<td style="white-space: normal;">array</td>
491495
<td><ul>
492-
<li>optional key/value pairs for creating query strings</li>
496+
<li>optional key/value pairs for creating query
497+
strings</li>
493498
</ul>
494499
</td>
495500
<td>array()</td>
@@ -621,7 +626,8 @@ <h4>Description</h4>
621626
<tbody><tr>
622627
<td>$resource</td>
623628
<td style="white-space: normal;">string</td>
624-
<td><p>The resource requested; should NOT have slashes at the beginning or end</p></td>
629+
<td><p>The resource requested; should NOT have slashes
630+
at the beginning or end</p></td>
625631
<td></td>
626632
</tr></tbody>
627633
</table>
@@ -740,7 +746,9 @@ <h4>Description</h4>
740746
<td>$details</td>
741747
<td style="white-space: normal;">boolean</td>
742748
<td><ul>
743-
<li>if TRUE (the default), returns complete image details. Set to FALSE to improve performance, but only return a minimal set of data</li>
749+
<li>if TRUE (the default), returns complete image
750+
details. Set to FALSE to improve performance, but only return a
751+
minimal set of data</li>
744752
</ul>
745753
</td>
746754
<td>TRUE</td>
@@ -749,7 +757,11 @@ <h4>Description</h4>
749757
<td>$filter</td>
750758
<td style="white-space: normal;">array</td>
751759
<td><ul>
752-
<li>key/value pairs to pass to the images resource. The actual values available here are determined by the OpenStack code and any extensions installed by your cloud provider; see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html for current filters available.</li>
760+
<li>key/value pairs to pass to the images resource.
761+
The actual values available here are determined by the OpenStack
762+
code and any extensions installed by your cloud provider;
763+
see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html
764+
for current filters available.</li>
753765
</ul>
754766
</td>
755767
<td>array()</td>
@@ -1125,7 +1137,8 @@ <h4>Description</h4>
11251137
<td>$headers</td>
11261138
<td style="white-space: normal;">array</td>
11271139
<td><ul>
1128-
<li>an associative array of headers to pass to the request</li>
1140+
<li>an associative array of headers to pass to
1141+
the request</li>
11291142
</ul>
11301143
</td>
11311144
<td>array()</td>
@@ -1258,7 +1271,10 @@ <h4>Description</h4>
12581271
<td>$details</td>
12591272
<td style="white-space: normal;">boolean</td>
12601273
<td><ul>
1261-
<li>if TRUE, full server details are returned; if FALSE, just the minimal set of info is listed. Defaults to TRUE; you might set this to FALSE to improve performance at the risk of not having all the information you need.</li>
1274+
<li>if TRUE, full server details are returned; if
1275+
FALSE, just the minimal set of info is listed. Defaults to TRUE;
1276+
you might set this to FALSE to improve performance at the risk of
1277+
not having all the information you need.</li>
12621278
</ul>
12631279
</td>
12641280
<td>TRUE</td>
@@ -1267,7 +1283,8 @@ <h4>Description</h4>
12671283
<td>$filter</td>
12681284
<td style="white-space: normal;">array</td>
12691285
<td><ul>
1270-
<li>a set of key/value pairs that is passed to the servers list for filtering</li>
1286+
<li>a set of key/value pairs that is passed to the
1287+
servers list for filtering</li>
12711288
</ul>
12721289
</td>
12731290
<td>array()</td>
@@ -1423,15 +1440,18 @@ <h4>Description</h4>
14231440
<td>$resource</td>
14241441
<td style="white-space: normal;">string</td>
14251442
<td><ul>
1426-
<li>an optional child resource. For example, passing 'details' would return .../servers/details. Should <em>not</em> be prefixed with a slash (/).</li>
1443+
<li>an optional child resource. For example,
1444+
passing 'details' would return .../servers/details. Should <em>not</em> be
1445+
prefixed with a slash (/).</li>
14271446
</ul>
14281447
</td>
14291448
<td>'servers'</td>
14301449
</tr>
14311450
<tr>
14321451
<td>$args</td>
14331452
<td style="white-space: normal;">array</td>
1434-
<td><p>(optional) an array of key-value pairs for query strings to append to the URL</p>
1453+
<td><p>(optional) an array of key-value pairs for query
1454+
strings to append to the URL</p>
14351455
</td>
14361456
<td>array()</td>
14371457
</tr>
@@ -1512,7 +1532,8 @@ <h4>Description</h4>
15121532
<td>$serviceName</td>
15131533
<td style="white-space: normal;">string</td>
15141534
<td><ul>
1515-
<li>identifies the name of the service in the catalog</li>
1535+
<li>identifies the name of the service in the
1536+
catalog</li>
15161537
</ul>
15171538
</td>
15181539
<td></td>
@@ -1521,7 +1542,8 @@ <h4>Description</h4>
15211542
<td>$serviceRegion</td>
15221543
<td style="white-space: normal;">string</td>
15231544
<td><ul>
1524-
<li>identifies the region of this Compute service</li>
1545+
<li>identifies the region of this Compute
1546+
service</li>
15251547
</ul>
15261548
</td>
15271549
<td></td>
@@ -1530,7 +1552,8 @@ <h4>Description</h4>
15301552
<td>$urltype</td>
15311553
<td style="white-space: normal;">string</td>
15321554
<td><ul>
1533-
<li>identifies the URL type ("publicURL", "privateURL")</li>
1555+
<li>identifies the URL type ("publicURL",
1556+
"privateURL")</li>
15341557
</ul>
15351558
</td>
15361559
<td></td>
@@ -1672,7 +1695,8 @@ <h4>Description</h4>
16721695
<tr>
16731696
<td>$msg</td>
16741697
<td style="white-space: normal;">string</td>
1675-
<td><p>The message string (required); can be in sprintf() format.</p>
1698+
<td><p>The message string (required); can be in
1699+
sprintf() format.</p>
16761700
</td>
16771701
<td></td>
16781702
</tr>
@@ -1784,7 +1808,8 @@ <h4>Description</h4>
17841808
<tr>
17851809
<td>$type</td>
17861810
<td style="white-space: normal;">string</td>
1787-
<td><p>The OpenStack service type ("compute" or "object-store", for example</p>
1811+
<td><p>The OpenStack service type ("compute" or
1812+
"object-store", for example</p>
17881813
</td>
17891814
<td></td>
17901815
</tr>
@@ -2065,7 +2090,7 @@ <h4>Properties</h4>
20652090
<div style="clear: both"></div>
20662091
</div>
20672092
</div>
2068-
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a10</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
2093+
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
20692094
$(function() {
20702095

20712096
var is_chrome = /chrome/.test( navigator.userAgent.toLowerCase() );
@@ -2233,7 +2258,9 @@ <h1>Namespaces</h1>
22332258
<li><span class="class"><a href="dnsobject.html#DnsObject">DnsObject</a><br><small>The DnsObject class is an extension of the PersistentObject class that
22342259
permits the asynchronous responses used by Cloud DNS</small></span></li>
22352260
<li><span class="class"><a href="domain.html#Domain">Domain</a><br><small>The Domain class represents a single domain</small></span></li>
2261+
<li><span class="class"><a href="ptrrecord.html#PtrRecord">PtrRecord</a><br><small>PTR records are used for reverse DNS</small></span></li>
22362262
<li><span class="class"><a href="record.html#Record">Record</a><br><small>The Record class represents a single domain record</small></span></li>
2263+
<li><span class="class"><a href="exceptions.html#RecordTypeError">RecordTypeError</a><br><small></small></span></li>
22372264
<li><span class="class"><a href="domain.html#Subdomain">Subdomain</a><br><small>The Subdomain is basically another domain, albeit one that is a child of
22382265
a parent domain.</small></span></li>
22392266
</ul>

0 commit comments

Comments
 (0)