Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

documentation updates

This commit is contained in:
Jan Steemann 2014-01-30 23:31:03 +01:00
parent 7bc4f06b6e
commit f4c9b4bc7a
1 changed files with 1 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
js/server/modules/org/arangodb/arango-collection.js
View File

@ -38,11 +38,6 @@ var internal = require("internal");
// --SECTION-- constructors and destructors // --SECTION-- constructors and destructors
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoShell
/// @{
////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief constructor /// @brief constructor
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -57,19 +52,10 @@ var simple = require("org/arangodb/simple-query");
var ArangoError = require("org/arangodb").ArangoError; var ArangoError = require("org/arangodb").ArangoError;
var ArangoDatabase = require("org/arangodb/arango-database").ArangoDatabase; var ArangoDatabase = require("org/arangodb/arango-database").ArangoDatabase;
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- private functions // --SECTION-- private functions
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoShell
/// @{
////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief converts collection into an array /// @brief converts collection into an array
/// ///
@ -89,19 +75,10 @@ ArangoCollection.prototype.toArray = function () {
return this.ALL(null, null).documents; return this.ALL(null, null).documents;
}; };
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- public functions // --SECTION-- public functions
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoShell
/// @{
////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief truncates a collection /// @brief truncates a collection
/// ///
@ -131,19 +108,10 @@ ArangoCollection.prototype.truncate = function () {
return internal.db._truncate(this); return internal.db._truncate(this);
}; };
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- index functions // --SECTION-- index functions
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoShell
/// @{
////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief finds an index of a collection /// @brief finds an index of a collection
/// ///
@ -196,19 +164,10 @@ ArangoCollection.prototype.index = function (id) {
throw err; throw err;
}; };
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- document functions // --SECTION-- document functions
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoShell
/// @{
////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief returns any document from a collection /// @brief returns any document from a collection
/// ///
@ -337,7 +296,7 @@ ArangoCollection.prototype.first = function (count) {
/// ///
/// @FUN{@FA{collection}.last(@FA{count})} /// @FUN{@FA{collection}.last(@FA{count})}
/// ///
/// The @FN{lst} method returns the n last documents from the collection, in /// The @FN{last} method returns the n last documents from the collection, in
/// order of document insertion/update time. /// order of document insertion/update time.
/// ///
/// If called with the @FA{count} argument, the result is a list of up to /// If called with the @FA{count} argument, the result is a list of up to
@ -682,10 +641,6 @@ ArangoCollection.prototype.updateByExample = function (example,
return updated; return updated;
}; };
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- END-OF-FILE // --SECTION-- END-OF-FILE
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------