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

more doc for shell interface

This commit is contained in:
Frank Celler 2012-04-11 16:51:36 +02:00
parent 29fd5384af
commit 1b7ac3b14f
1 changed files with 39 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
js/server/js-server.h
View File

@ -152,15 +152,21 @@ static string JS_server_server =
"///\n"
"/// @FUN{db._drop(@FA{collection})}\n"
"///\n"
"/// Drops a collection and all its indexes.\n"
"/// Drops a @FA{collection} and all its indexes.\n"
"///\n"
"/// @FUN{db._drop(@FA{collection-name})}\n"
"///\n"
"/// Drops a collection and all its indexes.\n"
"/// Drops a collection named @FA{collection-name} and all its indexes.\n"
"///\n"
"/// @EXAMPLES\n"
"///\n"
"/// @verbinclude shell_collection-drop\n"
"/// Drops a collection:\n"
"///\n"
"/// @verbinclude shell_collection-drop-db\n"
"///\n"
"/// Drops a collection identified by name:\n"
"///\n"
"/// @verbinclude shell_collection-drop-name-db\n"
"////////////////////////////////////////////////////////////////////////////////\n"
"\n"
"AvocadoDatabase.prototype._drop = function(name) {\n"
@ -181,6 +187,25 @@ static string JS_server_server =
"\n"
"////////////////////////////////////////////////////////////////////////////////\n"
"/// @brief truncates a collection\n"
"///\n"
"/// @FUN{db._truncate(@FA{collection})}\n"
"///\n"
"/// Truncates a @FA{collection}, removing all documents but keeping all its\n"
"/// indexes.\n"
"///\n"
"/// @FUN{db._truncate(@FA{collection-name})}\n"
"///\n"
"/// Truncates a collection named @FA{collection-name}.\n"
"///\n"
"/// @EXAMPLES\n"
"///\n"
"/// Truncates a collection:\n"
"///\n"
"/// @verbinclude shell_collection-truncate-db\n"
"///\n"
"/// Truncates a collection identified by name:\n"
"///\n"
"/// @verbinclude shell_collection-truncate-name-db\n"
"////////////////////////////////////////////////////////////////////////////////\n"
"\n"
"AvocadoDatabase.prototype._truncate = function(name) {\n"
@ -286,6 +311,17 @@ static string JS_server_server =
"\n"
"////////////////////////////////////////////////////////////////////////////////\n"
"/// @brief truncates a collection\n"
"///\n"
"/// @FUN{@FA{collection}.truncate()}\n"
"///\n"
"/// Truncates a @FA{collection}, removing all documents but keeping all its\n"
"/// indexes.\n"
"///\n"
"/// @EXAMPLES\n"
"///\n"
"/// Truncates a collection:\n"
"///\n"
"/// @verbinclude shell_collection-truncate\n"
"////////////////////////////////////////////////////////////////////////////////\n"
"\n"
"AvocadoCollection.prototype.truncate = function() {\n"