Skip to content

Commit b65a353

Browse files
frankmayerfrankmayer
committed
More documentation work...
- Changed method ordering in classes, so it's easier to read in the generated docs - Added some DocBlock tags to some methods for better docs generation - Added 'Deprecated' and 'Todo' views
1 parent 6741f07 commit b65a353

File tree

114 files changed

+8378
-7272
lines changed

Some content is hidden

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

114 files changed

+8378
-7272
lines changed

‎docs/404.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@
4141
<span>Deprecated</span>
4242
</a>
4343
</li>
44+
<li>
45+
<a href="annotation-group-todo.html" title="List of elements with todo annotation">
46+
<span>Todo</span>
47+
</a>
48+
</li>
4449

4550

4651
</ul>

‎docs/annotation-group-deprecated.html

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@
3838
<li class="active">
3939
<span>Deprecated</span>
4040
</li>
41+
<li>
42+
<a href="annotation-group-todo.html" title="List of elements with todo annotation">
43+
<span>Todo</span>
44+
</a>
45+
</li>
4146

4247

4348
</ul>
@@ -148,23 +153,23 @@ <h1>Deprecated</h1>
148153
</tr>
149154
<tr>
150155
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
151-
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_getCount">getCount()</a></code></td>
156+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_add">add()</a></code></td>
152157
<td>
153-
to be removed in version 2.0 - This function is being replaced by count()<br>
158+
to be removed in version 2.0 - This function is being replaced by create()<br>
154159
</td>
155160
</tr>
156161
<tr>
157162
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
158-
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_getFigures">getFigures()</a></code></td>
163+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_getCount">getCount()</a></code></td>
159164
<td>
160-
to be removed in version 2.0 - This function is being replaced by figures()<br>
165+
to be removed in version 2.0 - This function is being replaced by count()<br>
161166
</td>
162167
</tr>
163168
<tr>
164169
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
165-
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_add">add()</a></code></td>
170+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_getFigures">getFigures()</a></code></td>
166171
<td>
167-
to be removed in version 2.0 - This function is being replaced by create()<br>
172+
to be removed in version 2.0 - This function is being replaced by figures()<br>
168173
</td>
169174
</tr>
170175
<tr>
@@ -209,6 +214,13 @@ <h1>Deprecated</h1>
209214
to be removed in version 2.0 - This function is being replaced by removeById()<br>
210215
</td>
211216
</tr>
217+
<tr>
218+
<td class="name"><a href="class-triagens.ArangoDb.EdgeHandler.html">triagens\ArangoDb\EdgeHandler</a></td>
219+
<td class="name"><code><a href="class-triagens.ArangoDb.EdgeHandler.html#_add">add()</a></code></td>
220+
<td>
221+
to be removed in version 3.1<br>
222+
</td>
223+
</tr>
212224
<tr>
213225
<td class="name"><a href="class-triagens.ArangoDb.Graph.html">triagens\ArangoDb\Graph</a></td>
214226
<td class="name"><code><a href="class-triagens.ArangoDb.Graph.html#_setVerticesCollection">setVerticesCollection()</a></code></td>

‎docs/annotation-group-todo.html

Lines changed: 269 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,269 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
6+
<title>Todo | ArangoDB-PHP API Documentation</title>
7+
8+
<link rel="stylesheet" href="resources/bootstrap.min.css?973e37a8502921d56bc02bb55321f45b072b6f71">
9+
<link rel="stylesheet" href="resources/style.css?49f43d3208c5d7e33fa16d36107a345bf11cc00d">
10+
11+
</head>
12+
13+
<body>
14+
<nav id="navigation" class="navbar navbar-default navbar-fixed-top">
15+
<div class="container-fluid">
16+
<div class="navbar-header">
17+
<a href="index.html" class="navbar-brand">ArangoDB-PHP API Documentation</a>
18+
</div>
19+
<div class="collapse navbar-collapse">
20+
21+
<form id="search" class="navbar-form navbar-left" role="search">
22+
<input type="hidden" name="cx" value="">
23+
<input type="hidden" name="ie" value="UTF-8">
24+
<div class="form-group">
25+
<input type="text" name="q" class="search-query form-control" placeholder="Search">
26+
</div>
27+
</form>
28+
29+
<ul class="nav navbar-nav">
30+
<li>
31+
<span>Namespace</span> </li>
32+
<li>
33+
<span>Class</span> </li>
34+
35+
<li class="divider-vertical"></li>
36+
37+
38+
<li>
39+
<a href="annotation-group-deprecated.html" title="List of elements with deprecated annotation">
40+
<span>Deprecated</span>
41+
</a>
42+
</li>
43+
<li class="active">
44+
<span>Todo</span>
45+
</li>
46+
47+
48+
</ul>
49+
</div>
50+
</div>
51+
</nav>
52+
53+
<div id="left">
54+
<div id="menu">
55+
56+
<div id="groups">
57+
<h3>Namespaces</h3>
58+
<ul>
59+
<li>
60+
<a href="namespace-triagens.html">
61+
triagens<span></span>
62+
</a>
63+
<ul>
64+
<li>
65+
<a href="namespace-triagens.ArangoDb.html">
66+
ArangoDb </a>
67+
</li>
68+
</ul></li>
69+
</ul>
70+
</div>
71+
72+
73+
<div id="elements">
74+
<h3>Classes</h3>
75+
<ul>
76+
<li><a href="class-triagens.ArangoDb.AdminHandler.html">triagens\ArangoDb\AdminHandler</a></li>
77+
<li><a href="class-triagens.ArangoDb.AqlUserFunction.html">triagens\ArangoDb\AqlUserFunction</a></li>
78+
<li><a href="class-triagens.ArangoDb.Autoloader.html">triagens\ArangoDb\Autoloader</a></li>
79+
<li><a href="class-triagens.ArangoDb.Batch.html">triagens\ArangoDb\Batch</a></li>
80+
<li><a href="class-triagens.ArangoDb.BatchPart.html">triagens\ArangoDb\BatchPart</a></li>
81+
<li><a href="class-triagens.ArangoDb.BindVars.html">triagens\ArangoDb\BindVars</a></li>
82+
<li><a href="class-triagens.ArangoDb.Collection.html">triagens\ArangoDb\Collection</a></li>
83+
<li><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></li>
84+
<li><a href="class-triagens.ArangoDb.Connection.html">triagens\ArangoDb\Connection</a></li>
85+
<li><a href="class-triagens.ArangoDb.ConnectionOptions.html">triagens\ArangoDb\ConnectionOptions</a></li>
86+
<li><a href="class-triagens.ArangoDb.Cursor.html">triagens\ArangoDb\Cursor</a></li>
87+
<li><a href="class-triagens.ArangoDb.Database.html">triagens\ArangoDb\Database</a></li>
88+
<li><a href="class-triagens.ArangoDb.DefaultValues.html">triagens\ArangoDb\DefaultValues</a></li>
89+
<li><a href="class-triagens.ArangoDb.Document.html">triagens\ArangoDb\Document</a></li>
90+
<li><a href="class-triagens.ArangoDb.DocumentHandler.html">triagens\ArangoDb\DocumentHandler</a></li>
91+
<li><a href="class-triagens.ArangoDb.Edge.html">triagens\ArangoDb\Edge</a></li>
92+
<li><a href="class-triagens.ArangoDb.EdgeDefinition.html">triagens\ArangoDb\EdgeDefinition</a></li>
93+
<li><a href="class-triagens.ArangoDb.EdgeHandler.html">triagens\ArangoDb\EdgeHandler</a></li>
94+
<li><a href="class-triagens.ArangoDb.Endpoint.html">triagens\ArangoDb\Endpoint</a></li>
95+
<li><a href="class-triagens.ArangoDb.Export.html">triagens\ArangoDb\Export</a></li>
96+
<li><a href="class-triagens.ArangoDb.ExportCursor.html">triagens\ArangoDb\ExportCursor</a></li>
97+
<li><a href="class-triagens.ArangoDb.Graph.html">triagens\ArangoDb\Graph</a></li>
98+
<li><a href="class-triagens.ArangoDb.GraphHandler.html">triagens\ArangoDb\GraphHandler</a></li>
99+
<li><a href="class-triagens.ArangoDb.Handler.html">triagens\ArangoDb\Handler</a></li>
100+
<li><a href="class-triagens.ArangoDb.HttpHelper.html">triagens\ArangoDb\HttpHelper</a></li>
101+
<li><a href="class-triagens.ArangoDb.HttpResponse.html">triagens\ArangoDb\HttpResponse</a></li>
102+
<li><a href="class-triagens.ArangoDb.QueryCacheHandler.html">triagens\ArangoDb\QueryCacheHandler</a></li>
103+
<li><a href="class-triagens.ArangoDb.QueryHandler.html">triagens\ArangoDb\QueryHandler</a></li>
104+
<li><a href="class-triagens.ArangoDb.Statement.html">triagens\ArangoDb\Statement</a></li>
105+
<li><a href="class-triagens.ArangoDb.TraceRequest.html">triagens\ArangoDb\TraceRequest</a></li>
106+
<li><a href="class-triagens.ArangoDb.TraceResponse.html">triagens\ArangoDb\TraceResponse</a></li>
107+
<li><a href="class-triagens.ArangoDb.Transaction.html">triagens\ArangoDb\Transaction</a></li>
108+
<li><a href="class-triagens.ArangoDb.Traversal.html">triagens\ArangoDb\Traversal</a></li>
109+
<li><a href="class-triagens.ArangoDb.UpdatePolicy.html">triagens\ArangoDb\UpdatePolicy</a></li>
110+
<li><a href="class-triagens.ArangoDb.UrlHelper.html">triagens\ArangoDb\UrlHelper</a></li>
111+
<li><a href="class-triagens.ArangoDb.Urls.html">triagens\ArangoDb\Urls</a></li>
112+
<li><a href="class-triagens.ArangoDb.User.html">triagens\ArangoDb\User</a></li>
113+
<li><a href="class-triagens.ArangoDb.UserHandler.html">triagens\ArangoDb\UserHandler</a></li>
114+
<li><a href="class-triagens.ArangoDb.ValueValidator.html">triagens\ArangoDb\ValueValidator</a></li>
115+
<li><a href="class-triagens.ArangoDb.Vertex.html">triagens\ArangoDb\Vertex</a></li>
116+
<li><a href="class-triagens.ArangoDb.VertexHandler.html">triagens\ArangoDb\VertexHandler</a></li>
117+
</ul>
118+
119+
120+
121+
<h3>Exceptions</h3>
122+
<ul>
123+
<li><a href="class-triagens.ArangoDb.ClientException.html">triagens\ArangoDb\ClientException</a></li>
124+
<li><a href="class-triagens.ArangoDb.ConnectException.html">triagens\ArangoDb\ConnectException</a></li>
125+
<li><a href="class-triagens.ArangoDb.Exception.html">triagens\ArangoDb\Exception</a></li>
126+
<li><a href="class-triagens.ArangoDb.ServerException.html">triagens\ArangoDb\ServerException</a></li>
127+
</ul>
128+
129+
130+
</div>
131+
</div>
132+
</div>
133+
134+
<div id="splitter"></div>
135+
136+
<div id="right">
137+
<div id="rightInner">
138+
<div id="content">
139+
<h1>Todo</h1>
140+
141+
142+
143+
144+
145+
<div class="panel panel-default">
146+
<div class="panel-heading"><h2>Methods summary</h2></div>
147+
<table class="summary table table-bordered table-striped" id="methods">
148+
<tr>
149+
<td class="name"><a href="class-triagens.ArangoDb.AdminHandler.html">triagens\ArangoDb\AdminHandler</a></td>
150+
<td class="name"><code><a href="class-triagens.ArangoDb.AdminHandler.html#_flushServerModuleCache">flushServerModuleCache()</a></code></td>
151+
<td>
152+
remove in version 3.1<br>
153+
</td>
154+
</tr>
155+
<tr>
156+
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
157+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_add">add()</a></code></td>
158+
<td>
159+
remove in version 3.1<br>
160+
</td>
161+
</tr>
162+
<tr>
163+
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
164+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_getCount">getCount()</a></code></td>
165+
<td>
166+
remove in version 3.1<br>
167+
</td>
168+
</tr>
169+
<tr>
170+
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
171+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_getFigures">getFigures()</a></code></td>
172+
<td>
173+
remove in version 3.1<br>
174+
</td>
175+
</tr>
176+
<tr>
177+
<td class="name"><a href="class-triagens.ArangoDb.CollectionHandler.html">triagens\ArangoDb\CollectionHandler</a></td>
178+
<td class="name"><code><a href="class-triagens.ArangoDb.CollectionHandler.html#_delete">delete()</a></code></td>
179+
<td>
180+
remove in version 3.1<br>
181+
</td>
182+
</tr>
183+
<tr>
184+
<td class="name"><a href="class-triagens.ArangoDb.DocumentHandler.html">triagens\ArangoDb\DocumentHandler</a></td>
185+
<td class="name"><code><a href="class-triagens.ArangoDb.DocumentHandler.html#_getAllIds">getAllIds()</a></code></td>
186+
<td>
187+
remove in version 3.1<br>
188+
</td>
189+
</tr>
190+
<tr>
191+
<td class="name"><a href="class-triagens.ArangoDb.DocumentHandler.html">triagens\ArangoDb\DocumentHandler</a></td>
192+
<td class="name"><code><a href="class-triagens.ArangoDb.DocumentHandler.html#_getByExample">getByExample()</a></code></td>
193+
<td>
194+
remove in version 3.1<br>
195+
</td>
196+
</tr>
197+
<tr>
198+
<td class="name"><a href="class-triagens.ArangoDb.DocumentHandler.html">triagens\ArangoDb\DocumentHandler</a></td>
199+
<td class="name"><code><a href="class-triagens.ArangoDb.DocumentHandler.html#_add">add()</a></code></td>
200+
<td>
201+
remove in version 3.1<br>
202+
</td>
203+
</tr>
204+
<tr>
205+
<td class="name"><a href="class-triagens.ArangoDb.DocumentHandler.html">triagens\ArangoDb\DocumentHandler</a></td>
206+
<td class="name"><code><a href="class-triagens.ArangoDb.DocumentHandler.html#_delete">delete()</a></code></td>
207+
<td>
208+
remove in version 3.1<br>
209+
</td>
210+
</tr>
211+
<tr>
212+
<td class="name"><a href="class-triagens.ArangoDb.DocumentHandler.html">triagens\ArangoDb\DocumentHandler</a></td>
213+
<td class="name"><code><a href="class-triagens.ArangoDb.DocumentHandler.html#_deleteById">deleteById()</a></code></td>
214+
<td>
215+
remove in version 3.1<br>
216+
</td>
217+
</tr>
218+
<tr>
219+
<td class="name"><a href="class-triagens.ArangoDb.EdgeHandler.html">triagens\ArangoDb\EdgeHandler</a></td>
220+
<td class="name"><code><a href="class-triagens.ArangoDb.EdgeHandler.html#_add">add()</a></code></td>
221+
<td>
222+
remove in version 3.1<br>
223+
</td>
224+
</tr>
225+
<tr>
226+
<td class="name"><a href="class-triagens.ArangoDb.Graph.html">triagens\ArangoDb\Graph</a></td>
227+
<td class="name"><code><a href="class-triagens.ArangoDb.Graph.html#_setVerticesCollection">setVerticesCollection()</a></code></td>
228+
<td>
229+
remove in version 3.1<br>
230+
</td>
231+
</tr>
232+
<tr>
233+
<td class="name"><a href="class-triagens.ArangoDb.Graph.html">triagens\ArangoDb\Graph</a></td>
234+
<td class="name"><code><a href="class-triagens.ArangoDb.Graph.html#_getVerticesCollection">getVerticesCollection()</a></code></td>
235+
<td>
236+
remove in version 3.1<br>
237+
</td>
238+
</tr>
239+
<tr>
240+
<td class="name"><a href="class-triagens.ArangoDb.Graph.html">triagens\ArangoDb\Graph</a></td>
241+
<td class="name"><code><a href="class-triagens.ArangoDb.Graph.html#_setEdgesCollection">setEdgesCollection()</a></code></td>
242+
<td>
243+
remove in version 3.1<br>
244+
</td>
245+
</tr>
246+
<tr>
247+
<td class="name"><a href="class-triagens.ArangoDb.Graph.html">triagens\ArangoDb\Graph</a></td>
248+
<td class="name"><code><a href="class-triagens.ArangoDb.Graph.html#_getEdgesCollection">getEdgesCollection()</a></code></td>
249+
<td>
250+
remove in version 3.1<br>
251+
</td>
252+
</tr>
253+
</table>
254+
</div>
255+
256+
257+
258+
259+
</div>
260+
</div>
261+
262+
<div id="footer">
263+
ArangoDB-PHP API Documentation API documentation generated by <a href="http://apigen.org">ApiGen</a>
264+
</div>
265+
</div>
266+
<script src="resources/combined.js"></script>
267+
<script src="elementlist.js"></script>
268+
</body>
269+
</html>

0 commit comments

Comments
 (0)