Skip to content

Commit df0609f

Browse files
jsteemannjsteemann
committed
updated documentation
1 parent ed2be2f commit df0609f

37 files changed

+5603
-3917
lines changed

‎docs/classes.svg

Lines changed: 181 additions & 181 deletions
Loading

‎docs/classes/triagens.ArangoDb.Autoloader.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h2>Class file extension</h2>
169169
<div class="row"><footer class="span12">
170170
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
171171
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
172-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
172+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
173173
</div>
174174
</body>
175175
</html>

‎docs/classes/triagens.ArangoDb.BindVars.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ <h2>Current bind values</h2>
177177
<div class="row"><footer class="span12">
178178
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
179179
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
180-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
180+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
181181
</div>
182182
</body>
183183
</html>

‎docs/classes/triagens.ArangoDb.ClientException.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
271271
<div class="row"><footer class="span12">
272272
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
273273
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
274-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
274+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
275275
</div>
276276
</body>
277277
</html>

‎docs/classes/triagens.ArangoDb.Collection.html

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@
6767
Returns the collection as JSON-encoded string</span><pre>__toString()</pre></a></li>
6868
<li class="method public "><a href="#method_createFromArray" title="createFromArray :: Factory method to construct a new collection"><span class="description">Factory method to construct a new collection</span><pre>createFromArray()</pre></a></li>
6969
<li class="method public "><a href="#method_getAll" title="getAll :: Get all collection attributes"><span class="description">Get all collection attributes</span><pre>getAll()</pre></a></li>
70+
<li class="method public "><a href="#method_getDefaultType" title="getDefaultType :: Get the default collection type"><span class="description">Get the default collection type</span><pre>getDefaultType()</pre></a></li>
7071
<li class="method public "><a href="#method_getId" title="getId :: Get the collection id (if already known)
7172
Collection ids are generated on the server only."><span class="description">Get the collection id (if already known)
7273
Collection ids are generated on the server only.</span><pre>getId()</pre></a></li>
@@ -104,6 +105,8 @@
104105
<li class="constant "><a href="#constant_ENTRY_TYPE" title="ENTRY_TYPE :: Collection type index"><span class="description">Collection type index</span><pre>ENTRY_TYPE</pre></a></li>
105106
<li class="constant "><a href="#constant_ENTRY_WAIT_SYNC" title="ENTRY_WAIT_SYNC :: Collection 'waitForSync' index"><span class="description">Collection 'waitForSync' index</span><pre>ENTRY_WAIT_SYNC</pre></a></li>
106107
<li class="constant "><a href="#constant_OPTION_PROPERTIES" title="OPTION_PROPERTIES :: properties option"><span class="description">properties option</span><pre>OPTION_PROPERTIES</pre></a></li>
108+
<li class="constant "><a href="#constant_TYPE_DOCUMENT" title="TYPE_DOCUMENT :: document collection type"><span class="description">document collection type</span><pre>TYPE_DOCUMENT</pre></a></li>
109+
<li class="constant "><a href="#constant_TYPE_EDGE" title="TYPE_EDGE :: edge collection type"><span class="description">edge collection type</span><pre>TYPE_EDGE</pre></a></li>
107110
</ul>
108111
</li>
109112
</ul>
@@ -189,6 +192,17 @@ <h3>Returns</h3>
189192
<code>array</code>- array of all collection attributes</div>
190193
</div></div>
191194
</div>
195+
<a id="method_getDefaultType"></a><div class="element clickable method public method_getDefaultType" data-toggle="collapse" data-target=".method_getDefaultType .collapse">
196+
<h2>Get the default collection type</h2>
197+
<pre>getDefaultType() : string</pre>
198+
<div class="labels"><span class="label">Static</span></div>
199+
<div class="row collapse"><div class="detail-description">
200+
<div class="long_description"></div>
201+
<h3>Returns</h3>
202+
<div class="subelement response">
203+
<code>string</code>- name</div>
204+
</div></div>
205+
</div>
192206
<a id="method_getId"></a><div class="element clickable method public method_getId" data-toggle="collapse" data-target=".method_getId .collapse">
193207
<h2>Get the collection id (if already known)
194208
Collection ids are generated on the server only.</h2>
@@ -420,14 +434,26 @@ <h2>properties option</h2>
420434
<div class="labels"></div>
421435
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
422436
</div>
437+
<a id="constant_TYPE_DOCUMENT"> </a><div class="element clickable constant constant_TYPE_DOCUMENT" data-toggle="collapse" data-target=".constant_TYPE_DOCUMENT .collapse">
438+
<h2>document collection type</h2>
439+
<pre>TYPE_DOCUMENT </pre>
440+
<div class="labels"></div>
441+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
442+
</div>
443+
<a id="constant_TYPE_EDGE"> </a><div class="element clickable constant constant_TYPE_EDGE" data-toggle="collapse" data-target=".constant_TYPE_EDGE .collapse">
444+
<h2>edge collection type</h2>
445+
<pre>TYPE_EDGE </pre>
446+
<div class="labels"></div>
447+
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
448+
</div>
423449
</div>
424450
</div>
425451
</div>
426452
</div>
427453
<div class="row"><footer class="span12">
428454
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
429455
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
430-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
456+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
431457
</div>
432458
</body>
433459
</html>

‎docs/classes/triagens.ArangoDb.CollectionHandler.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ <h2>truncate option</h2>
618618
<div class="row"><footer class="span12">
619619
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
620620
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
621-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
621+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
622622
</div>
623623
</body>
624624
</html>

‎docs/classes/triagens.ArangoDb.ConnectException.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ <h2>getTraceAsString()
271271
<div class="row"><footer class="span12">
272272
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
273273
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
274-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
274+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
275275
</div>
276276
</body>
277277
</html>

‎docs/classes/triagens.ArangoDb.Connection.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ <h2>Flag if keep-alive connections are used</h2>
405405
<div class="row"><footer class="span12">
406406
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
407407
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
408-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
408+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
409409
</div>
410410
</body>
411411
</html>

‎docs/classes/triagens.ArangoDb.ConnectionOptions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ <h2>Wait for sync index constant</h2>
409409
<div class="row"><footer class="span12">
410410
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
411411
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
412-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
412+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
413413
</div>
414414
</body>
415415
</html>

‎docs/classes/triagens.ArangoDb.Cursor.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ <h2>sanitize option entry</h2>
413413
<div class="row"><footer class="span12">
414414
Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
415415
Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a10</a> and<br>
416-
generated on 2012-10-15T07:43:08+03:00.<br></footer></div>
416+
generated on 2012-10-15T10:57:55+02:00.<br></footer></div>
417417
</div>
418418
</body>
419419
</html>

0 commit comments

Comments
 (0)