added derived files

js/apps/system/aardvark/frontend/js/bootstrap/errors.js

@@ -76,7 +76,7 @@
     "ERROR_ARANGO_COLLECTION_NOT_FOUND" : { "code" : 1203, "message" : "collection not found" }, 
     "ERROR_ARANGO_COLLECTION_PARAMETER_MISSING" : { "code" : 1204, "message" : "parameter 'collection' not found" }, 
     "ERROR_ARANGO_DOCUMENT_HANDLE_BAD" : { "code" : 1205, "message" : "illegal document handle" }, 
-    "ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL" : { "code" : 1206, "message" : "maixmal size of journal too small" }, 
+    "ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL" : { "code" : 1206, "message" : "maximal size of journal too small" }, 
     "ERROR_ARANGO_DUPLICATE_NAME"  : { "code" : 1207, "message" : "duplicate name" }, 
     "ERROR_ARANGO_ILLEGAL_NAME"    : { "code" : 1208, "message" : "illegal name" }, 
     "ERROR_ARANGO_NO_INDEX"        : { "code" : 1209, "message" : "no suitable index known" }, 

js/apps/system/aardvark/frontend/js/modules/org/arangodb/arango-collection-common.js

@@ -56,11 +56,6 @@ var SimpleQueryFulltext = simple.SimpleQueryFulltext;
 // --SECTION--                                                         constants
 // -----------------------------------------------------------------------------
 
-////////////////////////////////////////////////////////////////////////////////
-/// @addtogroup ArangoShell
-/// @{
-////////////////////////////////////////////////////////////////////////////////
-
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief collection is corrupted
 ////////////////////////////////////////////////////////////////////////////////
@@ -116,19 +111,10 @@ ArangoCollection.TYPE_DOCUMENT = 2;
 
 ArangoCollection.TYPE_EDGE = 3;
 
-////////////////////////////////////////////////////////////////////////////////
-/// @}
-////////////////////////////////////////////////////////////////////////////////
-
 // -----------------------------------------------------------------------------
 // --SECTION--                                                   private methods
 // -----------------------------------------------------------------------------
 
-////////////////////////////////////////////////////////////////////////////////
-/// @addtogroup ArangoShell
-/// @{
-////////////////////////////////////////////////////////////////////////////////
-
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief prints a collection
 ////////////////////////////////////////////////////////////////////////////////
@@ -174,19 +160,10 @@ ArangoCollection.prototype.toString = function () {
   return "[ArangoCollection: " + this._id + "]";
 };
 
-////////////////////////////////////////////////////////////////////////////////
-/// @}
-////////////////////////////////////////////////////////////////////////////////
-
 // -----------------------------------------------------------------------------
 // --SECTION--                                                    public methods
 // -----------------------------------------------------------------------------
 
-////////////////////////////////////////////////////////////////////////////////
-/// @addtogroup ArangoShell
-/// @{
-////////////////////////////////////////////////////////////////////////////////
-
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief constructs an all query for a collection
 /// @startDocuBlock collectionAll
@@ -201,14 +178,27 @@ ArangoCollection.prototype.toString = function () {
 /// Use *toArray* to get all documents at once:
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{collectionAll}
-///   db.five.all();
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
+///   db.five.all().toArray();
+/// ~ db._drop("five");
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
-/// Use *next* to loop over all documents:
+/// Use *limit* to restrict the documents:
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{collectionAllNext}
-///   var a = db.five.all().toArray();
+/// ~ db._create("five");
-///   while (a.hasNext()) print(a.next());
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
+///   db.five.all().limit(2).toArray();
+/// ~ db._drop("five");
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// @endDocuBlock
@@ -269,10 +259,13 @@ ArangoCollection.prototype.all = function () {
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{collectionByExample}
 /// ~ db._create("users");
+/// ~ db.users.save({ name: "Gerhard" });
+/// ~ db.users.save({ name: "Helmut" });
+/// ~ db.users.save({ name: "Angela" });
 ///   db.users.all().toArray();
-///   db.users.byExample({ "id" : 323 }).toArray();
+///   db.users.byExample({ "_id" : "users/20" }).toArray();
-///   db.users.byExample({ "name" : "Peter" }).toArray();
+///   db.users.byExample({ "name" : "Gerhard" }).toArray();
-///   db.users.byExample({ "name" : "Peter", "id" : 535 }).toArray();
+///   db.users.byExample({ "name" : "Helmut", "_id" : "users/15" }).toArray();
 /// ~ db._drop("users");
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
@@ -280,7 +273,10 @@ ArangoCollection.prototype.all = function () {
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{collectionByExampleNext}
 /// ~ db._create("users");
-///   var a = db.users.byExample( {"name" : "Peter" } );
+/// ~ db.users.save({ name: "Gerhard" });
+/// ~ db.users.save({ name: "Helmut" });
+/// ~ db.users.save({ name: "Angela" });
+///   var a = db.users.byExample( {"name" : "Angela" } );
 ///   while (a.hasNext()) print(a.next());
 /// ~ db._drop("users");
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
@@ -517,9 +513,13 @@ ArangoCollection.prototype.byConditionBitarray = function (index, condition) {
 /// Use *toArray* to get all documents at once:
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{collectionRange}
-/// ~ db._create("example");
+/// ~ db._create("old");
-///   l = db.example.range("age", 10, 13).toArray();
+/// ~ db.old.ensureSkiplist("age");
-/// ~ db._drop("example")
+/// ~ db.old.save({ age: 15 });
+/// ~ db.old.save({ age: 25 });
+/// ~ db.old.save({ age: 35 });
+///   db.old.range("age", 10, 30).toArray();
+/// ~ db._drop("old")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// @endDocuBlock
@@ -772,9 +772,23 @@ ArangoCollection.prototype.within = function (lat, lon, radius) {
 ///
 /// To find all documents which contain the terms *text* and *word*:
 ///
-/// @EXAMPLE_ARANGOSH_OUTPUT{collectionFulltext}
+/// ```
-///   db.emails.fulltext("text", "word").toArray();
+/// arango> db.emails.fulltext("text", "word").toArray();
-/// @END_EXAMPLE_ARANGOSH_OUTPUT
+/// [ 
+///   { 
+///     "_id" : "emails/1721603", 
+///     "_key" : "1721603", 
+///     "_rev" : "1721603", 
+///     "text" : "this document contains a word" 
+///   },  
+///   {
+///     "_id" : "emails/1783231",
+///     "_key" : "1783231", 
+///     "_rev" : "1783231", 
+///     "text" : "this document also contains a word" 
+///   } 
+/// ]
+/// ``` 
 /// @endDocuBlock
 ////////////////////////////////////////////////////////////////////////////////
 
@@ -801,12 +815,12 @@ ArangoCollection.prototype.fulltext = function (attribute, query, iid) {
 ///
 /// @EXAMPLES
 ///
-/// @code
+/// ```
 /// arango> db.example.getIndexes().map(function(x) { return x.id; });
 /// ["93013/0"]
 /// arango> db.example.index("93013/0");
 /// { "id" : "93013/0", "type" : "primary", "fields" : ["_id"] }
-/// @endcode
+/// ```
 /// @endDocuBlock
 ////////////////////////////////////////////////////////////////////////////////
 
@@ -881,19 +895,10 @@ ArangoCollection.prototype.iterate = function (iterator, options) {
   }
 };
 
-////////////////////////////////////////////////////////////////////////////////
-/// @}
-////////////////////////////////////////////////////////////////////////////////
-
 // -----------------------------------------------------------------------------
 // --SECTION--                                                  document methods
 // -----------------------------------------------------------------------------
 
-////////////////////////////////////////////////////////////////////////////////
-/// @addtogroup ArangoShell
-/// @{
-////////////////////////////////////////////////////////////////////////////////
-
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief removes documents matching an example
 /// @startDocuBlock documentsCollectionRemoveByExample
@@ -1033,10 +1038,6 @@ ArangoCollection.prototype.updateByExample = function (example, newValue, keepNu
   throw "cannot call abstract updateExample function";
 };
 
-////////////////////////////////////////////////////////////////////////////////
-/// @}
-////////////////////////////////////////////////////////////////////////////////
-
 // -----------------------------------------------------------------------------
 // --SECTION--                                                       END-OF-FILE
 // -----------------------------------------------------------------------------

js/apps/system/aardvark/frontend/js/modules/org/arangodb/simple-query-common.js

@@ -326,16 +326,26 @@ SimpleQuery.prototype.clone = function () {
 /// lead to the same result:
 /// 
 /// @EXAMPLE_ARANGOSH_OUTPUT{executeQuery}
+/// ~ db._create("users");
+/// ~ db.users.save({ name: "Gerhard" });
+/// ~ db.users.save({ name: "Helmut" });
+/// ~ db.users.save({ name: "Angela" });
 ///   result = db.users.all().toArray();
 ///   q = db.users.all(); q.execute(); result = [ ]; while (q.hasNext()) { result.push(q.next()); }
+/// ~ db._drop("users")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// The following two alternatives both use a batchSize and return the same
 /// result:
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{executeQueryBatchSize}
+/// ~ db._create("users");
+/// ~ db.users.save({ name: "Gerhard" });
+/// ~ db.users.save({ name: "Helmut" });
+/// ~ db.users.save({ name: "Angela" });
 ///   q = db.users.all(); q.setBatchSize(20); q.execute(); while (q.hasNext()) { print(q.next()); }
 ///   q = db.users.all(); q.execute(20); while (q.hasNext()) { print(q.next()); }
+/// ~ db._drop("users")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// @endDocuBlock
@@ -373,8 +383,15 @@ SimpleQuery.prototype.execute = function () {
 /// @EXAMPLES
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{queryLimit}
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
 ///   db.five.all().toArray();
 ///   db.five.all().limit(2).toArray();
+/// ~ db._drop("five")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// @endDocuBlock
@@ -411,8 +428,15 @@ SimpleQuery.prototype.limit = function (limit) {
 /// @EXAMPLES
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{querySkip}
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
 ///   db.five.all().toArray();
 ///   db.five.all().skip(3).toArray();
+/// ~ db._drop("five")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// @endDocuBlock
@@ -529,13 +553,27 @@ SimpleQuery.prototype.setBatchSize = function (value) {
 /// Ignore any limit:
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{cursorCount}
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
 ///   db.five.all().limit(2).count();
+/// ~ db._drop("five")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// Counting any limit or skip:
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{cursorCountLimit}
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
 ///   db.five.all().limit(2).count(true);
+/// ~ db._drop("five")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 ///
 /// @endDocuBlock
@@ -563,8 +601,15 @@ SimpleQuery.prototype.count = function (applyPagination) {
 /// @EXAMPLES
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{cursorHasNext}
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
 ///   var a = db.five.all();
 ///   while (a.hasNext()) print(a.next());
+/// ~ db._drop("five")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 /// @endDocuBlock
 ////////////////////////////////////////////////////////////////////////////////
@@ -589,7 +634,14 @@ SimpleQuery.prototype.hasNext = function () {
 /// @EXAMPLES
 ///
 /// @EXAMPLE_ARANGOSH_OUTPUT{cursorNext}
+/// ~ db._create("five");
+/// ~ db.five.save({ name : "one" });
+/// ~ db.five.save({ name : "two" });
+/// ~ db.five.save({ name : "three" });
+/// ~ db.five.save({ name : "four" });
+/// ~ db.five.save({ name : "five" });
 ///   db.five.all().next();
+/// ~ db._drop("five")
 /// @END_EXAMPLE_ARANGOSH_OUTPUT
 /// @endDocuBlock
 ////////////////////////////////////////////////////////////////////////////////

js/common/bootstrap/errors.js

@@ -76,7 +76,7 @@
     "ERROR_ARANGO_COLLECTION_NOT_FOUND" : { "code" : 1203, "message" : "collection not found" }, 
     "ERROR_ARANGO_COLLECTION_PARAMETER_MISSING" : { "code" : 1204, "message" : "parameter 'collection' not found" }, 
     "ERROR_ARANGO_DOCUMENT_HANDLE_BAD" : { "code" : 1205, "message" : "illegal document handle" }, 
-    "ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL" : { "code" : 1206, "message" : "maixmal size of journal too small" }, 
+    "ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL" : { "code" : 1206, "message" : "maximal size of journal too small" }, 
     "ERROR_ARANGO_DUPLICATE_NAME"  : { "code" : 1207, "message" : "duplicate name" }, 
     "ERROR_ARANGO_ILLEGAL_NAME"    : { "code" : 1208, "message" : "illegal name" }, 
     "ERROR_ARANGO_NO_INDEX"        : { "code" : 1209, "message" : "no suitable index known" }, 

lib/BasicsC/errors.dat

@@ -1,4 +1,3 @@
-@startDocuBlock errorCodes
 ################################################################################
 ## general error messages
 ################################################################################
@@ -352,4 +351,3 @@ RESULT_ELEMENT_NOT_FOUND,10003,"element not found in structure","Will be returne
 ## foxx app update via github
 ################################################################################
 ERROR_APP_ALREADY_EXISTS,20000,"newest version of app already installed","newest version of app already installed"
-@endDocuBlock

lib/BasicsC/voc-errors.c

@@ -72,7 +72,7 @@ void TRI_InitialiseErrorMessages (void) {
   REG_ERROR(ERROR_ARANGO_COLLECTION_NOT_FOUND, "collection not found");
   REG_ERROR(ERROR_ARANGO_COLLECTION_PARAMETER_MISSING, "parameter 'collection' not found");
   REG_ERROR(ERROR_ARANGO_DOCUMENT_HANDLE_BAD, "illegal document handle");
-  REG_ERROR(ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL, "maixmal size of journal too small");
+  REG_ERROR(ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL, "maximal size of journal too small");
   REG_ERROR(ERROR_ARANGO_DUPLICATE_NAME, "duplicate name");
   REG_ERROR(ERROR_ARANGO_ILLEGAL_NAME, "illegal name");
   REG_ERROR(ERROR_ARANGO_NO_INDEX, "no suitable index known");

lib/BasicsC/voc-errors.h

@@ -66,8 +66,8 @@ extern "C" {
 /// - 400: @LIT{bad parameter}
 ///   Will be raised when the HTTP request does not fulfill the requirements.
 /// - 401: @LIT{unauthorized}
-///   Will be raised when authorisation is required but the user is not
+///   Will be raised when authorization is required but the user is not
-///   authorised.
+///   authorized.
 /// - 403: @LIT{forbidden}
 ///   Will be raised when the operation is forbidden.
 /// - 404: @LIT{not found}
@@ -109,7 +109,8 @@ extern "C" {
 /// - 1101: @LIT{illegal parameter file}
 ///   Will be raised if a parameter file is corrupted.
 /// - 1102: @LIT{corrupted collection}
-///   Will be raised when a collection contains one or more corrupted datafiles.
+///   Will be raised when a collection contains one or more corrupted data
+///   files.
 /// - 1103: @LIT{mmap failed}
 ///   Will be raised when the system call mmap failed.
 /// - 1104: @LIT{filesystem full}
@@ -149,7 +150,7 @@ extern "C" {
 ///   Will be raised when the collection parameter is missing.
 /// - 1205: @LIT{illegal document handle}
 ///   Will be raised when a document handle is corrupt.
-/// - 1206: @LIT{maixmal size of journal too small}
+/// - 1206: @LIT{maximal size of journal too small}
 ///   Will be raised when the maximal size of the journal is too small.
 /// - 1207: @LIT{duplicate name}
 ///   Will be raised when a name duplicate is detected.
@@ -222,7 +223,7 @@ extern "C" {
 /// - 1300: @LIT{datafile full}
 ///   Will be raised when the datafile reaches its limit.
 /// - 1301: @LIT{server database directory is empty}
-///   Will be raised when encoutering an empty server database directory.
+///   Will be raised when encountering an empty server database directory.
 /// - 1400: @LIT{no response}
 ///   Will be raised when the replication applier does not receive any or an
 ///   incomplete response from the master.
@@ -341,7 +342,7 @@ extern "C" {
 ///   Will be raised when a running query is killed by an explicit admin
 ///   command.
 /// - 1501: @LIT{\%s}
-///   Will be raised when query is parsed and is found to be syntactially
+///   Will be raised when query is parsed and is found to be syntactically
 ///   invalid.
 /// - 1502: @LIT{query is empty}
 ///   Will be raised when an empty query is specified.
@@ -864,8 +865,8 @@ void TRI_InitialiseErrorMessages (void);
 ///
 /// unauthorized
 ///
-/// Will be raised when authorisation is required but the user is not
+/// Will be raised when authorization is required but the user is not
-/// authorised.
+/// authorized.
 ////////////////////////////////////////////////////////////////////////////////
 
 #define TRI_ERROR_HTTP_UNAUTHORIZED                                       (401)
@@ -1222,7 +1223,7 @@ void TRI_InitialiseErrorMessages (void);
 ////////////////////////////////////////////////////////////////////////////////
 /// @brief 1206: ERROR_ARANGO_MAXIMAL_SIZE_TOO_SMALL
 ///
-/// maixmal size of journal too small
+/// maximal size of journal too small
 ///
 /// Will be raised when the maximal size of the journal is too small.
 ////////////////////////////////////////////////////////////////////////////////
@@ -1544,7 +1545,7 @@ void TRI_InitialiseErrorMessages (void);
 ///
 /// server database directory is empty
 ///
-/// Will be raised when encoutering an empty server database directory.
+/// Will be raised when encountering an empty server database directory.
 ////////////////////////////////////////////////////////////////////////////////
 
 #define TRI_ERROR_ARANGO_EMPTY_DATADIR                                    (1301)
@@ -1980,7 +1981,8 @@ void TRI_InitialiseErrorMessages (void);
 ///
 /// %s
 ///
-/// Will be raised when query is parsed and is found to be syntactially invalid.
+/// Will be raised when query is parsed and is found to be syntactically
+/// invalid.
 ////////////////////////////////////////////////////////////////////////////////
 
 #define TRI_ERROR_QUERY_PARSE                                             (1501)