Skip to content

Commit 89b65c6

Browse files
lucassouzavieiralucassouzavieira
committed
chore[docs]: update documentation
1 parent 30b5560 commit 89b65c6

File tree

345 files changed

+10190
-37519
lines changed

Some content is hidden

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

345 files changed

+10190
-37519
lines changed

‎docs/classes/ArangoDB-AQL-AQL.html‎

Lines changed: 13 additions & 195 deletions
Large diffs are not rendered by default.

‎docs/classes/ArangoDB-AQL-BindContainer.html‎

Lines changed: 13 additions & 979 deletions
Large diffs are not rendered by default.

‎docs/classes/ArangoDB-AQL-Contracts-QueryInterface.html‎

Lines changed: 12 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Ara
5454
Menu
5555
</label>
5656
<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
57-
<section class="phpdocumentor-sidebar__category">
57+
<section class="phpdocumentor-sidebar__category -namespaces">
5858
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
5959
<h4 class="phpdocumentor-sidebar__root-namespace">
6060
<a href="namespaces/arangodb.html" class="">ArangoDB</a>
@@ -135,7 +135,7 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
135135
</ul>
136136

137137
</section>
138-
<section class="phpdocumentor-sidebar__category">
138+
<section class="phpdocumentor-sidebar__category -packages">
139139
<h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
140140
<h4 class="phpdocumentor-sidebar__root-namespace">
141141
<a href="packages/ArangoDB.html" class="">ArangoDB</a>
@@ -217,14 +217,14 @@ <h4 class="phpdocumentor-sidebar__root-namespace">
217217

218218
</section>
219219

220-
<section class="phpdocumentor-sidebar__category">
220+
<section class="phpdocumentor-sidebar__category -reports">
221221
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
222222
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
223223
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
224224
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
225225
</section>
226226

227-
<section class="phpdocumentor-sidebar__category">
227+
<section class="phpdocumentor-sidebar__category -indices">
228228
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
229229
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
230230
</section>
@@ -253,15 +253,16 @@ <h2 class="phpdocumentor-content__title">
253253
<aside class="phpdocumentor-element-found-in">
254254
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Contracts/QueryInterface.php"><a href="files/src-aql-contracts-queryinterface.html"><abbr title="src/AQL/Contracts/QueryInterface.php">QueryInterface.php</abbr></a></abbr>
255255
:
256-
<span class="phpdocumentor-element-found-in__line">15</span>
256+
<span class="phpdocumentor-element-found-in__line">16</span>
257257

258-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#source-view.15" class="phpdocumentor-element-found-in__source" data-line="15" data-modal="source-view" data-src="files/src/AQL/Contracts/QueryInterface.php.txt"></a>
258+
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#source-view.16" class="phpdocumentor-element-found-in__source" data-line="16" data-modal="source-view" data-src="files/src/AQL/Contracts/QueryInterface.php.txt"></a>
259259
</aside>
260260

261261
<p class="phpdocumentor-summary">QueryInterface</p>
262262

263263

264264

265+
265266
<h5 class="phpdocumentor-tag-list__heading" id="tags">
266267
Tags
267268
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#tags" class="headerlink"><i class="fas fa-link"></i></a>
@@ -281,6 +282,8 @@ <h5 class="phpdocumentor-tag-list__heading" id="tags">
281282

282283

283284

285+
286+
284287
<h3 id="toc">
285288
Table of Contents
286289
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
@@ -296,135 +299,13 @@ <h3 id="toc">
296299

297300

298301

299-
<h4 id="toc-methods">
300-
Methods
301-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>
302-
303-
</h4>
304-
<dl class="phpdocumentor-table-of-contents">
305-
<dt class="phpdocumentor-table-of-contents__entry -method -public">
306-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_execute">execute()</a>
307-
<span>
308-
&nbsp;: <a href="classes/ArangoDB-Cursor-Base.html"><abbr title="\ArangoDB\Cursor\Base">Base</abbr></a> </span>
309-
</dt>
310-
<dd>Execute an statment on server and returns a cursor</dd>
311-
312-
<dt class="phpdocumentor-table-of-contents__entry -method -public">
313-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_query">query()</a>
314-
<span>
315-
&nbsp;: <a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a> </span>
316-
</dt>
317-
<dd>Instantiate a new StatementInterface object with the specified query</dd>
318-
319-
</dl>
320302

321303

322304

323305

324306

325307

326-
<section class="phpdocumentor-methods">
327-
<h3 class="phpdocumentor-elements__header" id="methods">
328-
Methods
329-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
330-
331-
</h3>
332-
<article
333-
class="phpdocumentor-element
334-
-method
335-
-public
336-
"
337-
>
338-
<h4 class="phpdocumentor-element__name" id="method_execute">
339-
execute()
340-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_execute" class="headerlink"><i class="fas fa-link"></i></a>
341-
342-
</h4>
343-
<aside class="phpdocumentor-element-found-in">
344-
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Contracts/QueryInterface.php"><a href="files/src-aql-contracts-queryinterface.html"><abbr title="src/AQL/Contracts/QueryInterface.php">QueryInterface.php</abbr></a></abbr>
345-
:
346-
<span class="phpdocumentor-element-found-in__line">33</span>
347-
348-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#source-view.33" class="phpdocumentor-element-found-in__source" data-line="33" data-modal="source-view" data-src="files/src/AQL/Contracts/QueryInterface.php.txt"></a>
349-
</aside>
350-
351-
<p class="phpdocumentor-summary">Execute an statment on server and returns a cursor</p>
352-
353-
<code class="phpdocumentor-code phpdocumentor-signature ">
354-
<span class="phpdocumentor-signature__visibility">public</span>
355-
<span class="phpdocumentor-signature__name">execute</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statement</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-Cursor-Base.html"><abbr title="\ArangoDB\Cursor\Base">Base</abbr></a></span></code>
356-
357-
<div class="phpdocumentor-label-line">
358-
</div>
359-
360-
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
361-
<dl class="phpdocumentor-argument-list">
362-
<dt class="phpdocumentor-argument-list__entry">
363-
<span class="phpdocumentor-signature__argument__name">$statement</span>
364-
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a></span>
365-
</dt>
366-
<dd class="phpdocumentor-argument-list__definition">
367-
368-
</dd>
369-
</dl>
370-
371-
372-
373-
<section>
374-
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
375-
<span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-Cursor-Base.html"><abbr title="\ArangoDB\Cursor\Base">Base</abbr></a></span>
376-
</section>
377-
378-
</article>
379-
<article
380-
class="phpdocumentor-element
381-
-method
382-
-public
383-
"
384-
>
385-
<h4 class="phpdocumentor-element__name" id="method_query">
386-
query()
387-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_query" class="headerlink"><i class="fas fa-link"></i></a>
388-
389-
</h4>
390-
<aside class="phpdocumentor-element-found-in">
391-
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Contracts/QueryInterface.php"><a href="files/src-aql-contracts-queryinterface.html"><abbr title="src/AQL/Contracts/QueryInterface.php">QueryInterface.php</abbr></a></abbr>
392-
:
393-
<span class="phpdocumentor-element-found-in__line">24</span>
394-
395-
<a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#source-view.24" class="phpdocumentor-element-found-in__source" data-line="24" data-modal="source-view" data-src="files/src/AQL/Contracts/QueryInterface.php.txt"></a>
396-
</aside>
397-
398-
<p class="phpdocumentor-summary">Instantiate a new StatementInterface object with the specified query</p>
399-
400-
<code class="phpdocumentor-code phpdocumentor-signature ">
401-
<span class="phpdocumentor-signature__visibility">public</span>
402-
<span class="phpdocumentor-signature__name">query</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$query</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a></span></code>
403-
404-
<div class="phpdocumentor-label-line">
405-
</div>
406-
407-
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
408-
<dl class="phpdocumentor-argument-list">
409-
<dt class="phpdocumentor-argument-list__entry">
410-
<span class="phpdocumentor-signature__argument__name">$query</span>
411-
: <span class="phpdocumentor-signature__argument__return-type">string</span>
412-
</dt>
413-
<dd class="phpdocumentor-argument-list__definition">
414-
415-
</dd>
416-
</dl>
417-
418-
419-
420-
<section>
421-
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
422-
<span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a></span>
423-
</section>
424-
425-
</article>
426-
</section>
427-
308+
428309
<div class="phpdocumentor-modal" id="source-view">
429310
<div class="phpdocumentor-modal-bg" data-exit-button></div>
430311
<div class="phpdocumentor-modal-container">
@@ -461,6 +342,8 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
461342
if (xhr.status < 400 && xhr.responseText) {
462343
code.textContent = xhr.responseText;
463344
Prism.highlightElement(code);
345+
d=document.getElementsByClassName("line-numbers");
346+
d[0].scrollTop = d[0].children[1].offsetTop;
464347
return;
465348
}
466349

@@ -532,13 +415,6 @@ <h5 class="phpdocumentor-return-value__heading">Return values</h5>
532415
<li><a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#toc-methods">Methods</a></li>
533416
</ul>
534417
</li>
535-
<li class="phpdocumentor-on-this-page-section__title">Methods</li>
536-
<li>
537-
<ul class="phpdocumentor-list -clean">
538-
<li><a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_execute">execute()</a></li>
539-
<li><a href="classes/ArangoDB-AQL-Contracts-QueryInterface.html#method_query">query()</a></li>
540-
</ul>
541-
</li>
542418

543419
</ul>
544420
</section>

0 commit comments

Comments
 (0)