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

doc

This commit is contained in:
Frank Celler 2012-02-08 10:43:42 +01:00
parent a161d9ebf7
commit 5cccbe44ba
3 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile.files
View File

@ -273,6 +273,7 @@ BUILT_SOURCES += \
DOXYGEN = \
Doxygen/js/bootstrap/modules.c \
Doxygen/js/bootstrap/print.c \
Doxygen/js/modules/graph.c \
Doxygen/js/modules/jsunity.c \
Doxygen/js/server/modules.c \

16
V8/v8-actions.h
View File

@ -89,8 +89,10 @@
/// <ol>
/// <li>@ref DefineActionDefineAction "defineAction"</li>
/// <li>@ref DefineActionDefineSystemAction "defineSystemAction"</li>
/// <li>@ref JSF_actionResult "actionResult"</li>
/// <li>@ref JSF_actionError "actionError"</li>
/// <li>@ref DefineActionActionResult "actionResult"</li>
/// <li>@ref DefineActionActionError "actionError"</li>
/// <li>@ref DefineActionQueryResult "queryResult"</li>
/// <li>@ref DefineActionQueryReferences "queryReferences"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@ -112,11 +114,17 @@
/// @anchor DefineActionDefineSystemAction
/// @copydetails JS_DefineSystemAction
///
/// @anchor JSF_actionResult
/// @anchor DefineActionActionResult
/// @copydetails JSF_actionResult
///
/// @anchor JSF_actionError
/// @anchor DefineActionActionError
/// @copydetails JSF_actionError
///
/// @anchor DefineActionQueryResult
/// @copydetails JSF_queryResult
///
/// @anchor DefineActionQueryReferences
/// @copydetails JSF_queryReferences
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------

8
js/server/actions.js
View File

@ -94,6 +94,8 @@ function queryResult (req, res, query) {
////////////////////////////////////////////////////////////////////////////////
/// @brief returns a result of a query as references
///
/// @FUN{queryReferences(@FA{req}, @FA{res}, @FA{query})}
///
/// The methods works like @FN{queryResult} but instead of the documents only
/// document identifiers are returned.
////////////////////////////////////////////////////////////////////////////////
@ -145,6 +147,8 @@ function queryReferences (req, res, query) {
////////////////////////////////////////////////////////////////////////////////
/// @brief returns a result
///
/// @FUN{actionResult(@FA{req}, @FA{res}, @FA{code}, @FA{result})}
///
/// The functions returns a result object. @FA{code} is the status code
/// to return.
////////////////////////////////////////////////////////////////////////////////
@ -163,9 +167,11 @@ function actionResult (req, res, code, result) {
////////////////////////////////////////////////////////////////////////////////
/// @brief returns an error
///
/// @FUN{actionError(@FA{req}, @FA{res}, @FA{errorMessage})}
///
/// The functions returns an error message. The status code is 500 and the
/// returned object is an array with an attribute @LIT{error} containing
/// the error message.
/// the error message @FA{errorMessage}.
////////////////////////////////////////////////////////////////////////////////
function actionError (req, res, err) {