1
0
Fork 0

fixed doxygen errors

This commit is contained in:
Jan Steemann 2012-11-21 18:10:45 +01:00
parent 337f7b8552
commit ad855bd2bd
14 changed files with 31 additions and 36 deletions

View File

@ -0,0 +1,2 @@
arango> e = g.getEdge("1");
Edge(1)

View File

@ -43,7 +43,6 @@
/// ///
/// ///
/// ///
///
/// @anchor A_JSF_POST_blueprints_vertex /// @anchor A_JSF_POST_blueprints_vertex
/// @copydetails JSF_POST_blueprints_vertex /// @copydetails JSF_POST_blueprints_vertex
/// ///
@ -59,8 +58,8 @@
/// ///
/// ///
/// ///
/// @anchor A_JSF_GET_blueprints_vertices /// @anchor A_JSF_POST_blueprints_vertices
/// @copydetails JSF_GET_blueprints_vertices /// @copydetails JSF_POST_blueprints_vertices
/// ///
/// ///
/// ///
@ -80,8 +79,8 @@
/// ///
/// ///
/// ///
/// @anchor A_JSF_GET_blueprints_edges /// @anchor A_JSF_POST_blueprints_edges
/// @copydetails JSF_GET_blueprints_edges /// @copydetails JSF_POST_blueprints_edges
/// ///
////////////////////////////////////////////////////// //////////////////////////////////////////////////////

View File

@ -105,12 +105,12 @@
/// <li>@ref A_JSF_GET_blueprints_vertex "GET /_api/blueprints/vertex"</li> /// <li>@ref A_JSF_GET_blueprints_vertex "GET /_api/blueprints/vertex"</li>
/// <li>@ref A_JSF_PUT_blueprints_vertex "PUT /_api/blueprints/vertex"</li> /// <li>@ref A_JSF_PUT_blueprints_vertex "PUT /_api/blueprints/vertex"</li>
/// <li>@ref A_JSF_DELETE_blueprints_vertex "DELETE /_api/blueprints/vertex"</li> /// <li>@ref A_JSF_DELETE_blueprints_vertex "DELETE /_api/blueprints/vertex"</li>
/// <li>@ref A_JSF_GET_blueprints_vertices "GET /_api/blueprints/vertices"</li> /// <li>@ref A_JSF_POST_blueprints_vertices "POST /_api/blueprints/vertices"</li>
/// <li>@ref A_JSF_POST_blueprints_edge "POST /_api/blueprints/edge"</li> /// <li>@ref A_JSF_POST_blueprints_edge "POST /_api/blueprints/edge"</li>
/// <li>@ref A_JSF_GET_blueprints_edge "GET /_api/blueprints/edge"</li> /// <li>@ref A_JSF_GET_blueprints_edge "GET /_api/blueprints/edge"</li>
/// <li>@ref A_JSF_PUT_blueprints_edge "PUT /_api/blueprints/edge"</li> /// <li>@ref A_JSF_PUT_blueprints_edge "PUT /_api/blueprints/edge"</li>
/// <li>@ref A_JSF_DELETE_blueprints_edge "DELETE /_api/blueprints/edge"</li> /// <li>@ref A_JSF_DELETE_blueprints_edge "DELETE /_api/blueprints/edge"</li>
/// <li>@ref A_JSF_GET_blueprints_edges "GET /_api/blueprints/edges"</li> /// <li>@ref A_JSF_POST_blueprints_edges "POST /_api/blueprints/edges"</li>
/// </ul> /// </ul>
/// </li> /// </li>
/// </ul> /// </ul>

View File

@ -166,15 +166,15 @@
/////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////
/// ///
/// @anchor ShellCollectionRead /// @anchor ShellCollectionRead
/// @copydetails JS_CollectionVocBase /// @copydetails JS_CollectionVocbase
/// ///
/// @CLEARPAGE /// @CLEARPAGE
/// @anchor ShellCollectionCreate /// @anchor ShellCollectionCreate
/// @copydetails JS_CreateVocBase /// @copydetails JS_CreateVocbase
/// ///
/// @CLEARPAGE /// @CLEARPAGE
/// @anchor ShellCollectionReadAll /// @anchor ShellCollectionReadAll
/// @copydetails JS_CollectionsVocBase /// @copydetails JS_CollectionsVocbase
/// ///
/// @CLEARPAGE /// @CLEARPAGE
/// @anchor ShellCollectionReadShortCut /// @anchor ShellCollectionReadShortCut

View File

@ -31,17 +31,12 @@
namespace triagens { namespace triagens {
namespace arango { namespace arango {
class Transaction {
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- class AqlTransaction // --SECTION-- class AqlTransaction
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
class Transaction {
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoDB
/// @{
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- constructors and destructors // --SECTION-- constructors and destructors
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------

View File

@ -36,17 +36,12 @@
namespace triagens { namespace triagens {
namespace arango { namespace arango {
// -----------------------------------------------------------------------------
// --SECTION-- class UserTransaction
// -----------------------------------------------------------------------------
template<typename T> template<typename T>
class UserTransaction : public Transaction<T> { class UserTransaction : public Transaction<T> {
//////////////////////////////////////////////////////////////////////////////// // -----------------------------------------------------------------------------
/// @addtogroup ArangoDB // --SECTION-- class UserTransaction
/// @{ // -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- constructors and destructors // --SECTION-- constructors and destructors
@ -84,6 +79,10 @@ namespace triagens {
} }
} }
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------
// --SECTION-- virtual protected functions // --SECTION-- virtual protected functions
// ----------------------------------------------------------------------------- // -----------------------------------------------------------------------------

View File

@ -5056,7 +5056,7 @@ static v8::Handle<v8::Value> JS_CreateVocbase (v8::Arguments const& argv) {
/// @FUN{db._createDocumentCollection(@FA{collection-name}, @FA{properties})} /// @FUN{db._createDocumentCollection(@FA{collection-name}, @FA{properties})}
/// ///
/// Creates a new document collection named @FA{collection-name}. /// Creates a new document collection named @FA{collection-name}.
/// This is an alias for @ref JS_CreateVocBase, with the difference that the /// This is an alias for @ref JS_CreateVocbase, with the difference that the
/// collection type is not automatically detected. /// collection type is not automatically detected.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -5087,7 +5087,7 @@ static v8::Handle<v8::Value> JS_CreateDocumentCollectionVocbase (v8::Arguments c
/// ///
/// @EXAMPLES /// @EXAMPLES
/// ///
/// See @ref JS_CreateVocBase for examples. /// See @ref JS_CreateVocbase for examples.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
static v8::Handle<v8::Value> JS_CreateEdgeCollectionVocbase (v8::Arguments const& argv) { static v8::Handle<v8::Value> JS_CreateEdgeCollectionVocbase (v8::Arguments const& argv) {

View File

@ -324,7 +324,7 @@ SimpleQuery.prototype.execute = function () {
/// @FUN{@FA{query}.limit(@FA{number})} /// @FUN{@FA{query}.limit(@FA{number})}
/// ///
/// Limits a result to the first @FA{number} documents. Specifying a limit of /// Limits a result to the first @FA{number} documents. Specifying a limit of
/// @CODE{0} returns no documents at all. If you do not need a limit, just do /// @LIT{0} returns no documents at all. If you do not need a limit, just do
/// not add the limit operator. The limit must be non-negative. /// not add the limit operator. The limit must be non-negative.
/// ///
/// In general the input to @FN{limit} should be sorted. Otherwise it will be /// In general the input to @FN{limit} should be sorted. Otherwise it will be

View File

@ -245,7 +245,7 @@
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief deletes a blueprint graph /// @brief deletes a blueprint graph
/// ///
/// @RESTHEADER{DELETE /_api/blueprints/graph/@FA{graph-identifier},delete graph} /// @RESTHEADER{DELETE /_api/blueprints/graph,delete graph}
/// ///
/// @REST{DELETE /_api/blueprints/graph/@FA{graph-identifier}} /// @REST{DELETE /_api/blueprints/graph/@FA{graph-identifier}}
/// ///

View File

@ -222,11 +222,11 @@ module = ModuleCache["/"] = new Module("/");
/// ///
/// @FN{require} checks if the file specified by @FA{path} has already been /// @FN{require} checks if the file specified by @FA{path} has already been
/// loaded. If not, the content of the file is executed in a new /// loaded. If not, the content of the file is executed in a new
/// context. Within the context you can use the global variable @CODE{exports} /// context. Within the context you can use the global variable @LIT{exports}
/// in order to export variables and functions. This variable is returned by /// in order to export variables and functions. This variable is returned by
/// @FN{require}. /// @FN{require}.
/// ///
/// Assume that your module file is @CODE{test1.js} and contains /// Assume that your module file is @LIT{test1.js} and contains
/// ///
/// @verbinclude modules-require-1 /// @verbinclude modules-require-1
/// ///

View File

@ -440,7 +440,7 @@ Vertex.prototype.edges = function () {
/// @FUN{@FA{vertex}.getId()} /// @FUN{@FA{vertex}.getId()}
/// ///
/// Returns the identifier of the @FA{vertex}. If the vertex was deleted, then /// Returns the identifier of the @FA{vertex}. If the vertex was deleted, then
/// @CODE{undefined} is returned. /// @LIT{undefined} is returned.
/// ///
/// @EXAMPLES /// @EXAMPLES
/// ///

View File

@ -323,7 +323,7 @@ SimpleQuery.prototype.execute = function () {
/// @FUN{@FA{query}.limit(@FA{number})} /// @FUN{@FA{query}.limit(@FA{number})}
/// ///
/// Limits a result to the first @FA{number} documents. Specifying a limit of /// Limits a result to the first @FA{number} documents. Specifying a limit of
/// @CODE{0} returns no documents at all. If you do not need a limit, just do /// @LIT{0} returns no documents at all. If you do not need a limit, just do
/// not add the limit operator. The limit must be non-negative. /// not add the limit operator. The limit must be non-negative.
/// ///
/// In general the input to @FN{limit} should be sorted. Otherwise it will be /// In general the input to @FN{limit} should be sorted. Otherwise it will be

View File

@ -107,7 +107,7 @@ string const ApplicationServer::OPTIONS_SERVER = "Server Options";
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
#ifdef _WIN32 #ifdef _WIN32
ApplicationServer::ApplicationServer (string const& name, string const& title, string const& version) ApplicationServer::ApplicationServer (std::string const& name, std::string const& title, std::string const& version)
: _options(), : _options(),
_description(), _description(),
_descriptionFile(), _descriptionFile(),
@ -143,7 +143,7 @@ ApplicationServer::ApplicationServer (string const& name, string const& title, s
_randomGenerator(5) { _randomGenerator(5) {
} }
#else #else
ApplicationServer::ApplicationServer (string const& name, string const& title, string const& version) ApplicationServer::ApplicationServer (std::string const& name, std::string const& title, std::string const& version)
: _options(), : _options(),
_description(), _description(),
_descriptionFile(), _descriptionFile(),

View File

@ -126,7 +126,7 @@ namespace triagens {
/// @brief constructor /// @brief constructor
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
ApplicationServer (const std::string& name, const std::string& title, const std::string& version); ApplicationServer (std::string const& name, std::string const& title, std::string const& version);
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief destructor /// @brief destructor