fixed warnings

Author: Achim Brandt

src/main/java/com/arangodb/ArangoConfigure.java

@@ -402,9 +402,9 @@ public int getProxyPort() {
 	 * Don't use this method. Please use {@link #setArangoHost(ArangoHost)
 	 * setArangoHost}
 	 * 
-	 * @deprecated
-	 * @param port
+	 * @param clientPort
 	 *            the port number
+	 * @deprecated
 	 */
 	@Deprecated
 	public void setClinetPort(int clientPort) {

src/main/java/com/arangodb/ArangoDriver.java

@@ -31,7 +31,7 @@ public ArangoException() {
 	}
 
 	public ArangoException(BaseEntity entity) {
-		super((entity.getErrorNumber() == 0 ? "" : "[" + entity.getErrorNumber() + "]") + entity.getErrorMessage());
+		super((entity.getErrorNumber() == 0 ? "" : "[" + entity.getErrorNumber() + "] ") + entity.getErrorMessage());
 		this.entity = entity;
 	}
 

src/main/java/com/arangodb/ArangoException.java

@@ -92,8 +92,9 @@ protected void validateDocumentHandle(String documentHandle) throws ArangoExcept
 	 * @param database
 	 * @param allowNull
 	 * @throws ArangoException
-	 * @see http 
-	 *      ://www.arangodb.com/manuals/current/NamingConventions.html#DatabaseNames
+	 * @see <a
+	 *      href="http://www.arangodb.com/manuals/current/NamingConventions.html#DatabaseNames">DatabaseNames
+	 *      documentation</a>
 	 */
 	protected void validateDatabaseName(String database, boolean allowNull) throws ArangoException {
 		boolean valid = false;
@@ -169,12 +170,17 @@ protected ReplicationDumpHeader toReplicationDumpHeader(HttpResponseEntity res)
 	}
 
 	/**
-	 * HTTPレスポンスから指定した型へ変換する。 レスポンスがエラーであるかを確認して、エラーの場合は例外を投げる。
+	 * Creates an entity object
 	 * 
 	 * @param res
-	 * @param type
+	 *            the response of the database
+	 * @param clazz
+	 *            the class of the entity object
+	 * @param pclazz
+	 *            the class of the object wrapped in the entity object
 	 * @param validate
-	 * @return
+	 *            true for validation
+	 * @return the result entity object of class T (T extends BaseEntity)
 	 * @throws ArangoException
 	 */
 	protected <T extends BaseEntity> T createEntity(

src/main/java/com/arangodb/BaseArangoDriver.java

@@ -51,14 +51,22 @@ <T, S extends DocumentEntity<T>> DocumentCursorResult<T, S> executeBaseCursorQue
 	 * Get the shortest path from a vertex to another vertex
 	 * 
 	 * @param database
+	 *            the database name
 	 * @param graphName
+	 *            the graph name
 	 * @param startVertexExample
+	 *            a start vertex example object (or null)
 	 * @param endVertexExample
+	 *            a start vertex example object (or null)
 	 * @param shortestPathOptions
+	 *            shortest path options
 	 * @param aqlQueryOptions
+	 *            AQL query options
 	 * @param vertexClass
+	 *            the vertex class
 	 * @param edgeClass
-	 * @return
+	 *            the edge class
+	 * @return a ShortestPathEntity object
 	 * @throws ArangoException
 	 */
 	public <V, E> ShortestPathEntity<V, E> getShortesPath(

src/main/java/com/arangodb/InternalCursorDriver.java

@@ -250,7 +250,7 @@ <T> VertexEntity<T> createVertex(
 	 * @param clazz
 	 * @param ifMatchRevision
 	 * @param ifNoneMatchRevision
-	 * @return
+	 * @return a VertexEntity object
 	 * @throws ArangoException
 	 */
 	<T> VertexEntity<T> getVertex(
@@ -301,7 +301,7 @@ <T> VertexEntity<T> replaceVertex(
 	 * @param waitForSync
 	 * @param ifMatchRevision
 	 * @param ifNoneMatchRevision
-	 * @return
+	 * @return a VertexEntity object
 	 * @throws ArangoException
 	 */
 	<T> VertexEntity<T> updateVertex(
@@ -326,7 +326,7 @@ <T> VertexEntity<T> updateVertex(
 	 * @param waitForSync
 	 * @param ifMatchRevision
 	 * @param ifNoneMatchRevision
-	 * @return
+	 * @return a DeletedEntity object
 	 * @throws ArangoException
 	 */
 	DeletedEntity deleteVertex(
@@ -349,7 +349,7 @@ DeletedEntity deleteVertex(
 	 * @param toHandle
 	 * @param value
 	 * @param waitForSync
-	 * @return <T> EdgeEntity<T>
+	 * @return a EdgeEntity object
 	 * @throws ArangoException
 	 */
 	<T> EdgeEntity<T> createEdge(
@@ -370,10 +370,9 @@ <T> EdgeEntity<T> createEdge(
 	 * @param edgeCollectionName
 	 * @param key
 	 * @param clazz
-	 * @param rev
 	 * @param ifNoneMatchRevision
 	 * @param ifMatchRevision
-	 * @return <T> EdgeEntity<T>
+	 * @return a EdgeEntity object
 	 * @throws ArangoException
 	 */
 	<T> EdgeEntity<T> getEdge(
@@ -474,7 +473,7 @@ <T> EdgeEntity<T> updateEdge(
 	 * @param labels
 	 * @param driver
 	 * @param properties
-	 * @return
+	 * @return a CursorEntity object
 	 * @throws ArangoException
 	 */
 	@Deprecated

src/main/java/com/arangodb/InternalGraphDriver.java

@@ -21,10 +21,12 @@
  *
  * @author tamtam180 - kirscheless at gmail.com
  * 
- * @Deprecated As of release 2.5.4, replaced by {@link com.arangodb.Direction}
+ * @deprecated As of release 2.5.4, replaced by {@link com.arangodb.Direction}
  *
  */
 @Deprecated
 public enum Direction {
-	ANY, IN, OUT
+	ANY,
+	IN,
+	OUT
 }

src/main/java/com/arangodb/entity/Direction.java

@@ -3,8 +3,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import com.arangodb.ArangoException;
-
 public class EdgeDefinitionsEntity {
 
 	/**
@@ -40,7 +38,7 @@ public int getSize() {
 	/**
 	 * get all edge definitions
 	 * 
-	 * @return
+	 * @return a list of EdgeDefinitionEntity objects
 	 */
 	public List<EdgeDefinitionEntity> getEdgeDefinitions() {
 		return edgeDefinitions;
@@ -62,7 +60,6 @@ public void setEdgeDefinitions(List<EdgeDefinitionEntity> edgeDefinitions) {
 	 * 
 	 * @param edgeDefinition
 	 *            the edge definition to be added
-	 * @throws ArangoException
 	 */
 	public void addEdgeDefinition(EdgeDefinitionEntity edgeDefinition) {
 		if (!this.edgeCollections.contains(edgeDefinition.getCollection())) {

src/main/java/com/arangodb/entity/EdgeDefinitionsEntity.java

@@ -641,7 +641,7 @@ public static class DeserializeSingleEntry {
 		 * desirializes any jsonElement
 		 *
 		 * @param jsonElement
-		 * @return
+		 * @return a object
 		 */
 		public static Object deserializeJsonElement(JsonElement jsonElement) {
 			if (jsonElement.getClass() == JsonPrimitive.class) {
@@ -1908,7 +1908,6 @@ public EdgeEntity<?> deserialize(JsonElement json, Type typeOfT, JsonDeserializa
 	}
 
 	public static class TraversalEntityDeserializer implements JsonDeserializer<TraversalEntity<?, ?>> {
-		@SuppressWarnings("unchecked")
 		@Override
 		public TraversalEntity<?, ?> deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)
 				throws JsonParseException {

src/main/java/com/arangodb/entity/EntityDeserializers.java

@@ -195,7 +195,7 @@ public static <T> String toJsonString(T obj, boolean includeNullValue) {
 	/**
 	 * @param obj
 	 * @param includeNullValue
-	 * @return
+	 * @return a JsonElement object
 	 * @since 1.4.0
 	 */
 	public static <T> JsonElement toJsonElement(T obj, boolean includeNullValue) {