From fabf8b700b4e8c33d52c67a29188962e820d111f Mon Sep 17 00:00:00 2001 From: Jan Steemann Date: Wed, 21 Nov 2012 17:44:23 +0100 Subject: [PATCH 1/2] fixed documentation --- Documentation/Examples/graph-graph-get-edge | 2 ++ Documentation/Examples/option-database-directory | 1 + arangod/Documentation/api-blueprints.dox | 4 ---- arangod/Documentation/implementor-manual.dox | 4 ++-- js/actions/system/api-blueprints.js | 2 +- 5 files changed, 6 insertions(+), 7 deletions(-) create mode 100644 Documentation/Examples/graph-graph-get-edge create mode 100644 Documentation/Examples/option-database-directory diff --git a/Documentation/Examples/graph-graph-get-edge b/Documentation/Examples/graph-graph-get-edge new file mode 100644 index 0000000000..73127737d5 --- /dev/null +++ b/Documentation/Examples/graph-graph-get-edge @@ -0,0 +1,2 @@ +arango> e = g.getEdge("1"); +Edge(1) diff --git a/Documentation/Examples/option-database-directory b/Documentation/Examples/option-database-directory new file mode 100644 index 0000000000..138abf4e05 --- /dev/null +++ b/Documentation/Examples/option-database-directory @@ -0,0 +1 @@ +> ./arangod --server.endpoint tcp://127.0.0.1:8529 --database.directory /tmp/vocbase diff --git a/arangod/Documentation/api-blueprints.dox b/arangod/Documentation/api-blueprints.dox index d3c55c4170..6f60535d2a 100644 --- a/arangod/Documentation/api-blueprints.dox +++ b/arangod/Documentation/api-blueprints.dox @@ -43,7 +43,6 @@ /// /// /// -/// /// @anchor A_JSF_POST_blueprints_vertex /// @copydetails JSF_POST_blueprints_vertex /// @@ -58,13 +57,11 @@ /// /// /// -/// /// @anchor A_JSF_POST_blueprints_vertices /// @copydetails JSF_POST_blueprints_vertices /// /// /// -/// /// @anchor A_JSF_POST_blueprints_edge /// @copydetails JSF_POST_blueprints_edge /// @@ -79,7 +76,6 @@ /// /// /// -/// /// @anchor A_JSF_POST_blueprints_edges /// @copydetails JSF_POST_blueprints_edges /// diff --git a/arangod/Documentation/implementor-manual.dox b/arangod/Documentation/implementor-manual.dox index a3f0a788d4..7670ca6718 100644 --- a/arangod/Documentation/implementor-manual.dox +++ b/arangod/Documentation/implementor-manual.dox @@ -105,12 +105,12 @@ ///
  • @ref A_JSF_GET_blueprints_vertex "GET /_api/blueprints/vertex"
    • ///
  • @ref A_JSF_PUT_blueprints_vertex "PUT /_api/blueprints/vertex"
    • ///
  • @ref A_JSF_DELETE_blueprints_vertex "DELETE /_api/blueprints/vertex"
    • -///
  • @ref A_JSF_GET_blueprints_vertices "GET /_api/blueprints/vertices"
    • +///
  • @ref A_JSF_POST_blueprints_vertices "POST /_api/blueprints/vertices"
    • ///
  • @ref A_JSF_POST_blueprints_edge "POST /_api/blueprints/edge"
    • ///
  • @ref A_JSF_GET_blueprints_edge "GET /_api/blueprints/edge"
    • ///
  • @ref A_JSF_PUT_blueprints_edge "PUT /_api/blueprints/edge"
    • ///
  • @ref A_JSF_DELETE_blueprints_edge "DELETE /_api/blueprints/edge"
    • -///
  • @ref A_JSF_GET_blueprints_edges "GET /_api/blueprints/edges"
    • +///
  • @ref A_JSF_POST_blueprints_edges "POST /_api/blueprints/edges"
    • /// /// /// diff --git a/js/actions/system/api-blueprints.js b/js/actions/system/api-blueprints.js index 5e76eb8086..106c156166 100644 --- a/js/actions/system/api-blueprints.js +++ b/js/actions/system/api-blueprints.js @@ -243,7 +243,7 @@ //////////////////////////////////////////////////////////////////////////////// /// @brief deletes a blueprint graph /// -/// @RESTHEADER{DELETE /_api/blueprints/graph},delete graph} +/// @RESTHEADER{DELETE /_api/blueprints/graph,delete graph} /// /// @REST{DELETE /_api/blueprints/graph/@FA{graph-identifier}} /// From f3b87fbe1f11e5d328234e82c154e909afbb5182 Mon Sep 17 00:00:00 2001 From: Jan Steemann Date: Wed, 21 Nov 2012 17:52:44 +0100 Subject: [PATCH 2/2] fixed documentation --- js/common/bootstrap/modules.js | 4 ++-- js/common/modules/graph.js | 2 +- js/common/modules/simple-query-basics.js | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/js/common/bootstrap/modules.js b/js/common/bootstrap/modules.js index 7ccda484f5..6b70ea6839 100644 --- a/js/common/bootstrap/modules.js +++ b/js/common/bootstrap/modules.js @@ -222,11 +222,11 @@ module = ModuleCache["/"] = new Module("/"); /// /// @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 -/// 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 /// @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 /// diff --git a/js/common/modules/graph.js b/js/common/modules/graph.js index 801bd32557..482adfde68 100644 --- a/js/common/modules/graph.js +++ b/js/common/modules/graph.js @@ -440,7 +440,7 @@ Vertex.prototype.edges = function () { /// @FUN{@FA{vertex}.getId()} /// /// Returns the identifier of the @FA{vertex}. If the vertex was deleted, then -/// @CODE{undefined} is returned. +/// @LIT{undefined} is returned. /// /// @EXAMPLES /// diff --git a/js/common/modules/simple-query-basics.js b/js/common/modules/simple-query-basics.js index 09fa93e7f3..d13e8cac67 100644 --- a/js/common/modules/simple-query-basics.js +++ b/js/common/modules/simple-query-basics.js @@ -323,7 +323,7 @@ SimpleQuery.prototype.execute = function () { /// @FUN{@FA{query}.limit(@FA{number})} /// /// 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. /// /// In general the input to @FN{limit} should be sorted. Otherwise it will be