Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucassouzavieira
lucassouzavieira committed May 15, 2024
1 parent afd77a3 commit 2fb0b1c
Show file tree
Hide file tree
Showing 43 changed files with 427 additions and 533 deletions.
1 change: 0 additions & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ build/
cache/
coverage.xml
*.phar
docs/

# Ignore documentation generation script
documentation.php
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/ArangoDB-AQL-AQL.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -355,9 +355,9 @@ <h4 class="phpdocumentor-element__name" id="method_functions">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/AQL.php"><a href="files/src-aql-aql.html"><abbr title="src/AQL/AQL.php">AQL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>
<span class="phpdocumentor-element-found-in__line">62</span>

<a href="classes/ArangoDB-AQL-AQL.html#source-view.63" class="phpdocumentor-element-found-in__source" data-line="63" data-modal="source-view" data-src="files/src/AQL/AQL.php.txt"></a>
<a href="classes/ArangoDB-AQL-AQL.html#source-view.62" class="phpdocumentor-element-found-in__source" data-line="62" data-modal="source-view" data-src="files/src/AQL/AQL.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Returns all registered AQL user functions.</p>
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/ArangoDB-AQL-BindContainer.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ <h4 id="toc-methods">
<span>
&nbsp;: mixed </span>
</dt>
<dd>Get a value by it&#039;s key</dd>
<dd>Get a value by its key</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/ArangoDB-AQL-BindContainer.html#method_getAll">getAll()</a>
Expand Down Expand Up @@ -705,11 +705,11 @@ <h4 class="phpdocumentor-element__name" id="method_get">
<a href="classes/ArangoDB-AQL-BindContainer.html#source-view.76" class="phpdocumentor-element-found-in__source" data-line="76" data-modal="source-view" data-src="files/src/DataStructures/ArrayList.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Get a value by it&#039;s key</p>
<p class="phpdocumentor-summary">Get a value by its key</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href=""></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<span class="phpdocumentor-signature__name">get</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>

<div class="phpdocumentor-label-line">
</div>
Expand All @@ -718,7 +718,7 @@ <h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$key</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href=""></a></span>
: <span class="phpdocumentor-signature__argument__return-type">int|string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Key to verify on list.</p>
Expand Down
52 changes: 26 additions & 26 deletions docs/classes/ArangoDB-AQL-Functions-AQLFunction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ <h2 class="phpdocumentor-content__title">
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.19" class="phpdocumentor-element-found-in__source" data-line="19" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Represents an user defined aql function on server.</p>
<p class="phpdocumentor-summary">Represents a user defined AQL function on server.</p>



Expand Down Expand Up @@ -436,9 +436,9 @@ <h4 class="phpdocumentor-element__name" id="method___construct">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">74</span>
<span class="phpdocumentor-element-found-in__line">62</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.74" class="phpdocumentor-element-found-in__source" data-line="74" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.62" class="phpdocumentor-element-found-in__source" data-line="62" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">AQLFunction constructor.</p>
Expand Down Expand Up @@ -517,9 +517,9 @@ <h4 class="phpdocumentor-element__name" id="method_delete">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">186</span>
<span class="phpdocumentor-element-found-in__line">173</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.186" class="phpdocumentor-element-found-in__source" data-line="186" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.173" class="phpdocumentor-element-found-in__source" data-line="173" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Removes an AQL function from server, if possible</p>
Expand Down Expand Up @@ -573,9 +573,9 @@ <h4 class="phpdocumentor-element__name" id="method_getCode">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
<span class="phpdocumentor-element-found-in__line">97</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.109" class="phpdocumentor-element-found-in__source" data-line="109" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.97" class="phpdocumentor-element-found-in__source" data-line="97" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Returns the AQL function code.</p>
Expand Down Expand Up @@ -610,9 +610,9 @@ <h4 class="phpdocumentor-element__name" id="method_getDeletionData">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">129</span>
<span class="phpdocumentor-element-found-in__line">117</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.129" class="phpdocumentor-element-found-in__source" data-line="129" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.117" class="phpdocumentor-element-found-in__source" data-line="117" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">If the object has performed a delete operation, this method will return the deletion data.</p>
Expand Down Expand Up @@ -647,9 +647,9 @@ <h4 class="phpdocumentor-element__name" id="method_getName">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">99</span>
<span class="phpdocumentor-element-found-in__line">87</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.99" class="phpdocumentor-element-found-in__source" data-line="99" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.87" class="phpdocumentor-element-found-in__source" data-line="87" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Returns the AQL function name.</p>
Expand Down Expand Up @@ -684,9 +684,9 @@ <h4 class="phpdocumentor-element__name" id="method_hasConnection">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">139</span>
<span class="phpdocumentor-element-found-in__line">127</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.139" class="phpdocumentor-element-found-in__source" data-line="139" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.127" class="phpdocumentor-element-found-in__source" data-line="127" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">If this AQL function has a connection set or not.</p>
Expand All @@ -705,7 +705,7 @@ <h4 class="phpdocumentor-element__name" id="method_hasConnection">
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"><p>True if has a connection object. False otherwise.</p>
<section class="phpdocumentor-description"><p>True if it has a connection object. False otherwise.</p>
</section>

</section>
Expand All @@ -725,9 +725,9 @@ <h4 class="phpdocumentor-element__name" id="method_isDeterministic">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">119</span>
<span class="phpdocumentor-element-found-in__line">107</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.119" class="phpdocumentor-element-found-in__source" data-line="119" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.107" class="phpdocumentor-element-found-in__source" data-line="107" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Indicates if the function results are deterministic. &lt;br&gt;</p>
Expand Down Expand Up @@ -762,9 +762,9 @@ <h4 class="phpdocumentor-element__name" id="method_isNew">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">89</span>
<span class="phpdocumentor-element-found-in__line">77</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.89" class="phpdocumentor-element-found-in__source" data-line="89" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.77" class="phpdocumentor-element-found-in__source" data-line="77" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">If the AQLFunction object is a new created AQLFunction (and not exists on server) &lt;br&gt;
Expand Down Expand Up @@ -800,9 +800,9 @@ <h4 class="phpdocumentor-element__name" id="method_jsonSerialize">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">224</span>
<span class="phpdocumentor-element-found-in__line">210</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.224" class="phpdocumentor-element-found-in__source" data-line="224" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.210" class="phpdocumentor-element-found-in__source" data-line="210" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Return a JSON representation of AQL function object.</p>
Expand Down Expand Up @@ -837,9 +837,9 @@ <h4 class="phpdocumentor-element__name" id="method_save">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">161</span>
<span class="phpdocumentor-element-found-in__line">149</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.161" class="phpdocumentor-element-found-in__source" data-line="161" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.149" class="phpdocumentor-element-found-in__source" data-line="149" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Saves the AQL function on server.</p>
Expand Down Expand Up @@ -893,9 +893,9 @@ <h4 class="phpdocumentor-element__name" id="method_setConnection">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">149</span>
<span class="phpdocumentor-element-found-in__line">137</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.149" class="phpdocumentor-element-found-in__source" data-line="149" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.137" class="phpdocumentor-element-found-in__source" data-line="137" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Sets a connection to use.</p>
Expand Down Expand Up @@ -938,9 +938,9 @@ <h4 class="phpdocumentor-element__name" id="method_toArray">
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/Functions/AQLFunction.php"><a href="files/src-aql-functions-aqlfunction.html"><abbr title="src/AQL/Functions/AQLFunction.php">AQLFunction.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">210</span>
<span class="phpdocumentor-element-found-in__line">196</span>

<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.210" class="phpdocumentor-element-found-in__source" data-line="210" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
<a href="classes/ArangoDB-AQL-Functions-AQLFunction.html#source-view.196" class="phpdocumentor-element-found-in__source" data-line="196" data-modal="source-view" data-src="files/src/AQL/Functions/AQLFunction.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Returns a array representation of AQL function object.</p>
Expand Down
Loading

0 comments on commit 2fb0b1c

Please sign in to comment.