Corrected minor errors that popped up in the documentation generation and made documentation a bit easier to read.

frankmayer · frankmayer · commit d009762625e1 · 2013-10-17T08:39:32.000+03:00
diff --git a/lib/triagens/ArangoDb/AdminHandler.php b/lib/triagens/ArangoDb/AdminHandler.php
@@ -13,8 +13,10 @@
 namespace triagens\ArangoDb;
 
 /**
- * An admin handler that utilizes the ArangoDB's Admin API. It does so by issuing the
- * appropriate HTTP requests to the server.
+ * Provides access to ArangoDB's administration interface
+ *
+ * The admin handler utilizes ArangoDB's Admin API.<br>
+ * <br>
  *
  * @package   triagens\ArangoDb
  * @since     1.2
diff --git a/lib/triagens/ArangoDb/AqlUserFunction.php b/lib/triagens/ArangoDb/AqlUserFunction.php
@@ -10,30 +10,36 @@
 namespace triagens\ArangoDb;
 
 /**
- * Class AqlUserFunction
- *
- * AqlUserFunction object
- * An AqlUserFunction is an object that is used to manage AQL User Functions.
- * It registers, unregisters and lists user functions on the server
- *
- * The object encapsulates:
- *
- * * the name of the function
- * * the actual javascript function
- *
+ * Provides management of user-functions
  *
+ * AqlUserFunction object<br>
+ * An AqlUserFunction is an object that is used to manage AQL User Functions.<br>
+ * It registers, unregisters and lists user functions on the server<br>
+ * <br>
+ * The object encapsulates:<br>
+ * <br>
+ * <ul>
+ * <li> the name of the function
+ * <li> the actual javascript function
+ * </ul>
+ * <br>
  * The object requires the connection object and can be initialized
- * with or without initial configuration.
- * Any configuration can be set and retrieved by the object's methods like this:
- *
- * $this->setName('myFunctions:myFunction');
+ * with or without initial configuration.<br>
+ * <br>
+ * Any configuration can be set and retrieved by the object's methods like this:<br>
+ * <br>
+ * <pre>
+ * $this->setName('myFunctions:myFunction');<br>
  * $this->setCode('function (){your code};');
+ * </pre>
  *
- * or like this:
- *
- * $this->name('myFunctions:myFunction');
+ * <br>
+ * or like this:<br>
+ * <br>
+ * <pre>
+ * $this->name('myFunctions:myFunction');<br>
  * $this->code('function (){your code};');
- *
+ * </pre>
  *
  * @property string $name - The name of the user function
  * @property string $code - The code of the user function
diff --git a/lib/triagens/ArangoDb/Autoloader.php b/lib/triagens/ArangoDb/Autoloader.php
@@ -11,9 +11,11 @@
 namespace triagens\ArangoDb;
 
 /**
- * Handles automatic loading of missing class files
+ * Handles automatic loading of missing class files.
+ *
  * The autoloader can be nested with other autoloaders. It will only
- * process classes from its own namespace and ignore all others.
+ * process classes from its own namespace and ignore all others.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Batch.php b/lib/triagens/ArangoDb/Batch.php
@@ -14,9 +14,10 @@
 /**
  * Provides batching functionality
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  * @example ArangoDb/examples/batch.php
- *
  */
 
 
diff --git a/lib/triagens/ArangoDb/BatchPart.php b/lib/triagens/ArangoDb/BatchPart.php
@@ -14,8 +14,9 @@
 /**
  * Provides batch part functionality
  *
- * @package triagens\ArangoDb
+ * <br>
  *
+ * @package triagens\ArangoDb
  */
 
 
diff --git a/lib/triagens/ArangoDb/BindVars.php b/lib/triagens/ArangoDb/BindVars.php
@@ -12,7 +12,9 @@
 
 /**
  * A simple container for bind variables
- * This container also handles validation of the bind values.
+ *
+ * This container also handles validation of the bind values.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/ClientException.php b/lib/triagens/ArangoDb/ClientException.php
@@ -11,8 +11,11 @@
 namespace triagens\ArangoDb;
 
 /**
+ * Client-Exception
+ *
  * This exception type will be thrown by the client when there is an error
- * on the client side, i.e. something the server is not involved in.
+ * on the client side, i.e. something the server is not involved in.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Collection.php b/lib/triagens/ArangoDb/Collection.php
@@ -13,6 +13,8 @@
 /**
  * Value object representing a collection
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 class Collection
diff --git a/lib/triagens/ArangoDb/CollectionHandler.php b/lib/triagens/ArangoDb/CollectionHandler.php
@@ -11,9 +11,11 @@
 namespace triagens\ArangoDb;
 
 /**
- * A collection handler that fetches collection data from the server and
- * creates collections on the server. It does so by issuing the
- * appropriate HTTP requests to the server.
+ * Provides management of collections
+ *
+ * The collection handler fetches collection data from the server and
+ * creates collections on the server.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/ConnectException.php b/lib/triagens/ArangoDb/ConnectException.php
@@ -11,8 +11,11 @@
 namespace triagens\ArangoDb;
 
 /**
+ * Connect-Exception
+ *
  * This exception type will be thrown by the client when there is an error
- * during connecting to the server
+ * during connecting to the server.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Connection.php b/lib/triagens/ArangoDb/Connection.php
@@ -12,10 +12,12 @@
 
 /**
  * Provides access to the ArangoDB server
+ *
  * As all access is done using HTTP, we do not need to establish a
- * persistent connection and keep its state.
+ * persistent connection and keep its state.<br>
  * Instead, connections are established on the fly for each request
- * and are destroyed afterwards.
+ * and are destroyed afterwards.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/ConnectionOptions.php b/lib/triagens/ArangoDb/ConnectionOptions.php
@@ -12,9 +12,11 @@
 
 /**
  * Simple container class for connection options.
+ *
  * This class also provides the default values for the connection
- * options and will perform a simple validation of them.
- * It provides array access to its members.
+ * options and will perform a simple validation of them.<br>
+ * It provides array access to its members.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Cursor.php b/lib/triagens/ArangoDb/Cursor.php
@@ -13,11 +13,12 @@
 /**
  * Provides access to the results of a read-only statement
  *
- * The cursor might not contain all results in the beginning.
+ * The cursor might not contain all results in the beginning.<br>
  *
  * If the result set is too big to be transferred in one go, the
  * cursor might issue additional HTTP requests to fetch the
- * remaining results from the server.
+ * remaining results from the server.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/DefaultValues.php b/lib/triagens/ArangoDb/DefaultValues.php
@@ -13,6 +13,8 @@
 /**
  * Contains default values used by the client
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 abstract class DefaultValues
diff --git a/lib/triagens/ArangoDb/Document.php b/lib/triagens/ArangoDb/Document.php
@@ -13,6 +13,8 @@
 /**
  * Value object representing a single collection-based document
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 class Document
@@ -215,7 +217,7 @@ public function toSerialized($options = array())
     /**
      * Returns the attributes with the hidden ones removed
      *
-     * @param array - attributes array
+     * @param array $attributes - attributes array
      *
      * @return array - attributes array
      */
diff --git a/lib/triagens/ArangoDb/DocumentHandler.php b/lib/triagens/ArangoDb/DocumentHandler.php
@@ -13,9 +13,13 @@
 
 
 /**
+ * A handler that manages documents
+ *
  * A document handler that fetches documents from the server and
  * persists them on the server. It does so by issuing the
- * appropriate HTTP requests to the server.
+ * appropriate HTTP requests to the server.<br>
+ *
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Edge.php b/lib/triagens/ArangoDb/Edge.php
@@ -13,6 +13,8 @@
 /**
  * Value object representing a single collection-based document
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 class Edge extends
diff --git a/lib/triagens/ArangoDb/EdgeHandler.php b/lib/triagens/ArangoDb/EdgeHandler.php
@@ -12,9 +12,13 @@
 namespace triagens\ArangoDb;
 
 /**
+ * A handler that manages edges
+ *
  * An edge-document handler that fetches edges from the server and
  * persists them on the server. It does so by issuing the
- * appropriate HTTP requests to the server.
+ * appropriate HTTP requests to the server.<br>
+ *
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Endpoint.php b/lib/triagens/ArangoDb/Endpoint.php
@@ -15,11 +15,15 @@
  *
  * An endpoint contains the server location the client connects to
  * the following endpoint types are currently supported (more to be added later):
- * - tcp://host:port for tcp connections
- * - unix://socket for UNIX sockets (provided the server supports this)
- * - ssl://host:port for SSL connections (provided the server supports this)
+ * <ul>
+ * <li> tcp://host:port for tcp connections
+ * <li> unix://socket for UNIX sockets (provided the server supports this)
+ * <li> ssl://host:port for SSL connections (provided the server supports this)
+ * </ul>
  *
- * Note: SSL support is added in ArangoDB server 1.1
+ * Note: SSL support is added in ArangoDB server 1.1<br>
+ *
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Exception.php b/lib/triagens/ArangoDb/Exception.php
@@ -13,6 +13,8 @@
 /**
  * Exception base class used to throw Arango specific exceptions
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 class Exception extends
diff --git a/lib/triagens/ArangoDb/Graph.php b/lib/triagens/ArangoDb/Graph.php
@@ -15,6 +15,8 @@
 /**
  * Value object representing a graph
  *
+ * <br>
+ *
  * @package   triagens\ArangoDb
  *
  * @since     1.2
diff --git a/lib/triagens/ArangoDb/GraphHandler.php b/lib/triagens/ArangoDb/GraphHandler.php
@@ -14,9 +14,9 @@
 namespace triagens\ArangoDb;
 
 /**
- * A graph handler that manages graphs.
- * It does so by issuing the
- * appropriate HTTP requests to the server.
+ * A handler that manages graphs.
+ *
+ * <br>
  *
  * @package triagens\ArangoDb
  * @since   1.2
@@ -103,8 +103,8 @@ public function createGraph(Graph $graph)
      *
      * @throws Exception
      *
-     * @param String - $graph - The name of the graph
-     * @param array  - $options - Options to pass to the method
+     * @param String $graph - The name of the graph
+     * @param array  $options - Options to pass to the method
      *
      * @return Graph - A graph object representing the graph
      * @since   1.2
diff --git a/lib/triagens/ArangoDb/Handler.php b/lib/triagens/ArangoDb/Handler.php
@@ -13,6 +13,8 @@
 /**
  * A base class for REST-based handlers
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 abstract class Handler
diff --git a/lib/triagens/ArangoDb/HttpHelper.php b/lib/triagens/ArangoDb/HttpHelper.php
@@ -13,6 +13,8 @@
 /**
  * Helper methods for HTTP request/response handling
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 class HttpHelper
diff --git a/lib/triagens/ArangoDb/HttpResponse.php b/lib/triagens/ArangoDb/HttpResponse.php
@@ -13,6 +13,8 @@
 /**
  * Container class for HTTP responses
  *
+ * <br>
+ *
  * @package triagens\ArangoDb
  */
 class HttpResponse
diff --git a/lib/triagens/ArangoDb/ServerException.php b/lib/triagens/ArangoDb/ServerException.php
@@ -11,13 +11,17 @@
 namespace triagens\ArangoDb;
 
 /**
+ * Server-Exception
+ *
  * This exception type will be thrown by the client when the server returns an
  * error in response to a client request.
  *
  * The exception code is the HTTP status code as returned by
- * the server. In case the server provides additional details
+ * the server.
+ * In case the server provides additional details
  * about the error, these details can be queried using the
- * getDetails() function.
+ * getDetails() function.<br>
+ * <br>
  *
  * @package triagens\ArangoDb
  */
diff --git a/lib/triagens/ArangoDb/Statement.php b/lib/triagens/ArangoDb/Statement.php
diff --git a/lib/triagens/ArangoDb/TraceRequest.php b/lib/triagens/ArangoDb/TraceRequest.php
diff --git a/lib/triagens/ArangoDb/TraceResponse.php b/lib/triagens/ArangoDb/TraceResponse.php
diff --git a/lib/triagens/ArangoDb/Transaction.php b/lib/triagens/ArangoDb/Transaction.php
diff --git a/lib/triagens/ArangoDb/UpdatePolicy.php b/lib/triagens/ArangoDb/UpdatePolicy.php
diff --git a/lib/triagens/ArangoDb/UrlHelper.php b/lib/triagens/ArangoDb/UrlHelper.php
diff --git a/lib/triagens/ArangoDb/Urls.php b/lib/triagens/ArangoDb/Urls.php
diff --git a/lib/triagens/ArangoDb/User.php b/lib/triagens/ArangoDb/User.php
diff --git a/lib/triagens/ArangoDb/UserHandler.php b/lib/triagens/ArangoDb/UserHandler.php
diff --git a/lib/triagens/ArangoDb/ValueValidator.php b/lib/triagens/ArangoDb/ValueValidator.php
diff --git a/lib/triagens/ArangoDb/Vertex.php b/lib/triagens/ArangoDb/Vertex.php
diff --git a/lib/triagens/ArangoDb/VertexHandler.php b/lib/triagens/ArangoDb/VertexHandler.php

Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,9 @@`
`14`	`14`	`/**`
`15`	`15`	`* Provides batch part functionality`
`16`	`16`	`*`
`17`		`- * @package triagens\ArangoDb`
	`17`	`+ * <br>`
`18`	`18`	`*`
	`19`	`+ * @package triagens\ArangoDb`
`19`	`20`	`*/`
`20`	`21`
`21`	`22`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`	`/**`
`14`	`14`	`* Value object representing a collection`
`15`	`15`	`*`
	`16`	`+ * <br>`
	`17`	`+ *`
`16`	`18`	`* @package triagens\ArangoDb`
`17`	`19`	`*/`
`18`	`20`	`class Collection`