Skip to content

Commit cb298bf

Browse files
author
a-brandt
committed
fixed docu warnings
1 parent e72d160 commit cb298bf

File tree

4 files changed

+10
-14
lines changed

4 files changed

+10
-14
lines changed

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

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -947,8 +947,6 @@ public <T> DocumentEntity<T> createDocument(final String collectionName, final T
947947
* the desired document key
948948
* @param value
949949
* An object containing the documents attributes
950-
* @param createCollection
951-
* if set to true the collection is created if it does not exist
952950
* @param waitForSync
953951
* if set to true the response is returned when the server has
954952
* finished.
@@ -975,8 +973,6 @@ public DocumentEntity<?> createDocument(
975973
* the desired document key
976974
* @param value
977975
* An object containing the documents attributes
978-
* @param createCollection
979-
* if set to true the collection is created if it does not exist
980976
* @param waitForSync
981977
* if set to true the response is returned when the server has
982978
* finished.
@@ -2936,7 +2932,7 @@ public UserEntity getUser(final String username) throws ArangoException {
29362932
* @param username
29372933
* the username as string
29382934
* @param database
2939-
* @return
2935+
* @return a DefaultEntity object
29402936
* @throws ArangoException
29412937
*/
29422938
public DefaultEntity grantDatabaseAccess(String username, String database) throws ArangoException {
@@ -4688,7 +4684,7 @@ public QueriesResultEntity getSlowQueries(final String database) throws ArangoEx
46884684
/**
46894685
* Clears the list of slow AQL queries of the default database
46904686
*
4691-
* @return
4687+
* @return a DefaultEntity object
46924688
* @throws ArangoException
46934689
*/
46944690
public DefaultEntity deleteSlowQueries() throws ArangoException {
@@ -4700,7 +4696,7 @@ public DefaultEntity deleteSlowQueries() throws ArangoException {
47004696
*
47014697
* @param database
47024698
* the database name or null
4703-
* @return
4699+
* @return a DefaultEntity object
47044700
* @throws ArangoException
47054701
*/
47064702
public DefaultEntity deleteSlowQueries(final String database) throws ArangoException {
@@ -4712,7 +4708,7 @@ public DefaultEntity deleteSlowQueries(final String database) throws ArangoExcep
47124708
*
47134709
* @param id
47144710
* the identifier of a query
4715-
* @return
4711+
* @return a DefaultEntity object
47164712
* @throws ArangoException
47174713
*/
47184714
public DefaultEntity killQuery(final String id) throws ArangoException {
@@ -4726,7 +4722,7 @@ public DefaultEntity killQuery(final String id) throws ArangoException {
47264722
* the identifier of a query
47274723
* @param database
47284724
* the database name or null
4729-
* @return
4725+
* @return a DefaultEntity object
47304726
* @throws ArangoException
47314727
*/
47324728
public DefaultEntity killQuery(final String database, final String id) throws ArangoException {
@@ -4749,8 +4745,6 @@ public HttpManager getHttpManager() {
47494745
* The name of the collection
47504746
* @param rawJsonString
47514747
* A string containing a JSON object
4752-
* @param createCollection
4753-
* if set to true the collection is created if it does not exist
47544748
* @param waitForSync
47554749
* if set to true the response is returned when the server has
47564750
* finished.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public void setId(String id) {
4646
/**
4747
* Returns the query string (potentially truncated)
4848
*
49-
* @return
49+
* @return the query string
5050
*/
5151
public String getQuery() {
5252
return query;

src/main/java/com/arangodb/util/GraphEdgesOptions.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,8 @@ public GraphEdgesOptions setLimit(Integer limit) {
205205
/**
206206
* Get include data
207207
*
208-
* @return
208+
* @return returns true, if the return values are compatible with older
209+
* versions of AnrangoDB
209210
*/
210211
public Boolean getIncludeData() {
211212
return includeData;

src/main/java/com/arangodb/util/ShortestPathOptions.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ public ShortestPathOptions setDefaultWeight(Long defaultWeight) {
151151
/**
152152
* Get include data
153153
*
154-
* @return
154+
* @return returns true, if the return values are compatible with older
155+
* versions of AnrangoDB
155156
*/
156157
public Boolean getIncludeData() {
157158
return includeData;

0 commit comments

Comments
 (0)