mirror of https://gitee.com/bigwinds/arangodb
Cleanup documentation for remaining @-tags
This commit is contained in:
parent
751643f887
commit
b06d03e84f
|
@ -17,13 +17,20 @@ check-summary:
|
|||
fi
|
||||
|
||||
book-check-leftover-docublocks:
|
||||
@if test "`grep -r \"@startDocuBlock\" --include \"*.html\" books/$(NAME) | wc -l`" -ne 0; then \
|
||||
@if test "`grep -r \"@startDocuBlock\" --include \"*.md\" ppbooks/$(NAME) | wc -l`" -ne 0; then \
|
||||
echo ; \
|
||||
echo "@startDocuBlock markers still found in generated output files:"; \
|
||||
grep -rl "@startDocuBlock" --include "*.html" books/$(NAME) | sed -e "s/^/- /g"; \
|
||||
grep -rl "@startDocuBlock" --include "*.md" ppbooks/$(NAME) | sed -e "s/^/- /g"; \
|
||||
exit 1; \
|
||||
fi
|
||||
|
||||
book-check-restheader-leftovers:
|
||||
@if test "`find ppbooks/$(NAME) -name '*.md' -exec grep -- '^@[A-Z]*' {} \; -print | wc -l`" -gt 0; then \
|
||||
echo "found these unconverted Swagger Restapi tags: "; \
|
||||
find ppbooks/$(NAME) -name '*.md' -exec grep '^@[A-Z]*' {} \; -print; \
|
||||
exit 1; \
|
||||
fi
|
||||
|
||||
book-check-markdown-leftovers:
|
||||
@if test "`find books/$(NAME) -name '*.html' -exec grep -- '##' {} \; -print | wc -l`" -gt 0; then \
|
||||
echo "found these unconverted markdown titles: "; \
|
||||
|
@ -69,12 +76,14 @@ build-book:
|
|||
|
||||
test -d books/$(NAME) || mkdir -p books/$(NAME)
|
||||
|
||||
make check-summary
|
||||
make book-check-leftover-docublocks
|
||||
make book-check-restheader-leftovers
|
||||
|
||||
cd ppbooks/$(NAME) && gitbook install
|
||||
cd ppbooks/$(NAME) && gitbook build ./ ./../../books/$(NAME)
|
||||
python deprecated.py
|
||||
|
||||
make check-summary
|
||||
make book-check-leftover-docublocks
|
||||
make book-check-markdown-leftovers
|
||||
|
||||
clean-book:
|
||||
|
|
|
@ -148,43 +148,3 @@ Changes or sets the property name an edges to value.
|
|||
|
||||
arango> e.getPropert("weight")
|
||||
20
|
||||
|
||||
|
||||
<!--
|
||||
@anchor JSModuleGraphEdgeGetId
|
||||
@copydetails JSF_Edge_prototype_getId
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetInVertex
|
||||
@copydetails JSF_Edge_prototype_getInVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetLabel
|
||||
@copydetails JSF_Edge_prototype_getLabel
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetOutVertex
|
||||
@copydetails JSF_Edge_prototype_getOutVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetPeerVertex
|
||||
@copydetails JSF_Edge_prototype_getPeerVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetProperty
|
||||
@copydetails JSF_Edge_prototype_getProperty
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetPropertyKeys
|
||||
@copydetails JSF_Edge_prototype_getPropertyKeys
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeProperties
|
||||
@copydetails JSF_Edge_prototype_properties
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeSetProperty
|
||||
@copydetails JSF_Edge_prototype_setProperty
|
||||
|
||||
@BNAVIGATE_JSModuleGraph
|
||||
-->
|
|
@ -193,60 +193,3 @@ Calculates the normalized degree, closeness, betweenness or eccentricity of all
|
|||
* closeness: to calculate the closeness
|
||||
* betweenness: to calculate the betweenness
|
||||
* eccentricity: to calculate the eccentricity
|
||||
|
||||
<!--
|
||||
@verbinclude graph-setup
|
||||
|
||||
@anchor JSModuleGraphGraphConstructor
|
||||
@copydetails JSF_Graph_prototype_initialize
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphAddEdge
|
||||
@copydetails JSF_Graph_prototype_addEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphAddVertex
|
||||
@copydetails JSF_Graph_prototype_addVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetEdges
|
||||
@copydetails JSF_Graph_prototype_getEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetVertex
|
||||
@copydetails JSF_Graph_prototype_getVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetVertices
|
||||
@copydetails JSF_Graph_prototype_getVertices
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphRemoveVertex
|
||||
@copydetails JSF_Graph_prototype_removeVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphRemoveEdge
|
||||
@copydetails JSF_Graph_prototype_removeEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphDrop
|
||||
@copydetails JSF_Graph_prototype_drop
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetAll
|
||||
@copydetails JSF_graph_getAll
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGeodesics
|
||||
@copydetails JSF_Graph_prototype_geodesics
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphMeasurement
|
||||
@copydetails JSF_Graph_prototype_measurement
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphNormalizedMeasurement
|
||||
@copydetails JSF_Graph_prototype_normalizedMeasurement
|
||||
|
||||
@CLEARPAGE
|
||||
-->
|
||||
|
|
|
@ -16,11 +16,6 @@ you can build a graph using the Graph constructor.
|
|||
arango> g1 = new Graph("graph", "vertices", "edges");
|
||||
Graph("vertices", "edges")
|
||||
|
||||
|
||||
<!--
|
||||
@verbinclude graph25
|
||||
-->
|
||||
|
||||
It is possible to use different edges with the same vertices. For instance, to
|
||||
build a new graph with a different edge collection use
|
||||
|
||||
|
@ -28,9 +23,5 @@ build a new graph with a different edge collection use
|
|||
|
||||
arango> g2 = new Graph("graph", "vertices", "alternativeEdges");
|
||||
Graph("vertices", "alternativeEdges")
|
||||
|
||||
<!--
|
||||
@verbinclude graph26
|
||||
-->
|
||||
It is, however, impossible to use different vertices with the same edges. Edges
|
||||
are tied to the vertices.
|
||||
|
|
|
@ -237,81 +237,3 @@ Changes or sets the property name a vertex to value.
|
|||
|
||||
Calculates the eccentricity, betweenness or closeness of the vertex
|
||||
|
||||
|
||||
|
||||
<!--
|
||||
@anchor JSModuleGraphVertexAddInEdge
|
||||
@copydetails JSF_Vertex_prototype_addInEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexAddOutEdge
|
||||
@copydetails JSF_Vertex_prototype_addOutEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexEdges
|
||||
@copydetails JSF_Vertex_prototype_edges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetId
|
||||
@copydetails JSF_Vertex_prototype_getId
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetInEdges
|
||||
@copydetails JSF_Vertex_prototype_getInEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetOutEdges
|
||||
@copydetails JSF_Vertex_prototype_getOutEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetEdges
|
||||
@copydetails JSF_Vertex_prototype_getEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetProperty
|
||||
@copydetails JSF_Vertex_prototype_getProperty
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetPropertyKeys
|
||||
@copydetails JSF_Vertex_prototype_getPropertyKeys
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexProperties
|
||||
@copydetails JSF_Vertex_prototype_properties
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexSetProperty
|
||||
@copydetails JSF_Vertex_prototype_setProperty
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexCommonNeighborsWith
|
||||
@copydetails JSF_Vertex_prototype_commonNeighborsWith
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexCommonPropertiesWith
|
||||
@copydetails JSF_Vertex_prototype_commonPropertiesWith
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexPathTo
|
||||
@copydetails JSF_Vertex_prototype_pathTo
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexDistanceTo
|
||||
@copydetails JSF_Vertex_prototype_distanceTo
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexDeterminePredecessors
|
||||
@copydetails JSF_Vertex_prototype_determinePredecessors
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexPathesForTree
|
||||
@copydetails JSF_Vertex_prototype_pathesForTree
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetNeighbors
|
||||
@copydetails JSF_Vertex_prototype_getNeighbors
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexMeasurement
|
||||
@copydetails JSF_Vertex_prototype_measurement
|
||||
-->
|
||||
|
|
|
@ -58,14 +58,14 @@ On many systems this can be achieved with the following command:
|
|||
|
||||
!SECTION Frequently Used Options
|
||||
|
||||
The following command-line options are frequently used. For a full
|
||||
list of options see [here](../ConfigureArango/README.md).
|
||||
The following command-line options are frequently used.
|
||||
[For a full list of options see the documentation](../ConfigureArango/README.md).
|
||||
|
||||
`database-directory`
|
||||
|
||||
Uses the "database-directory" as base directory. There is an
|
||||
alternative version available for use in configuration files, see
|
||||
[here](../ConfigureArango/Arangod.md).
|
||||
[configuration documentation](../ConfigureArango/Arangod.md).
|
||||
|
||||
`--help`<br >
|
||||
`-h`
|
||||
|
@ -80,30 +80,8 @@ the server. The "level" is specified as a string and can be one of
|
|||
the following values: fatal, error, warning, info, debug or trace. For
|
||||
more information see [here](../ConfigureArango/Logging.md).
|
||||
|
||||
`--server.endpoint endpoint`
|
||||
Specifies an endpoint for HTTP requests by clients. Endpoints have the following pattern:
|
||||
|
||||
* tcp://ipv4-address:port - TCP/IP endpoint, using IPv4
|
||||
* tcp://[ipv6-address]:port - TCP/IP endpoint, using IPv6
|
||||
* ssl://ipv4-address:port - TCP/IP endpoint, using IPv4, SSL encryption
|
||||
* ssl://[ipv6-address]:port - TCP/IP endpoint, using IPv6, SSL encryption
|
||||
* unix:///path/to/socket - Unix domain socket endpoint
|
||||
|
||||
If a TCP/IP endpoint is specified without a port number, then the default port (8529) will be used. If multiple endpoints need to be used, the option can be repeated multiple times.
|
||||
|
||||
!SUBSUBSECTION Examples
|
||||
|
||||
unix> ./arangod --server.endpoint tcp://127.0.0.1:8529
|
||||
--server.endpoint ssl://127.0.0.1:8530
|
||||
--server.keyfile server.pem /tmp/vocbase
|
||||
2012-07-26T07:07:47Z [8161] INFO using SSL protocol version 'TLSv1'
|
||||
2012-07-26T07:07:48Z [8161] INFO using endpoint 'ssl://127.0.0.1:8530' for http ssl requests
|
||||
2012-07-26T07:07:48Z [8161] INFO using endpoint 'tcp://127.0.0.1:8529' for http tcp requests
|
||||
2012-07-26T07:07:49Z [8161] INFO ArangoDB (version 1.1.alpha) is ready for business
|
||||
2012-07-26T07:07:49Z [8161] INFO Have Fun!
|
||||
Note that if you are using SSL-encrypted endpoints, you must also supply the path to a server certificate using the --server.keyfile option.
|
||||
|
||||
Endpoints can also be changed at runtime. Please refer to HTTP Interface for Endpoints for more details.
|
||||
@startDocuBlock serverEndpoint
|
||||
|
||||
<!-- ArangoServer.h -->
|
||||
|
||||
|
@ -113,9 +91,7 @@ Endpoints can also be changed at runtime. Please refer to HTTP Interface for End
|
|||
|
||||
@startDocuBlock keep_alive_timeout
|
||||
|
||||
<!--
|
||||
@copydetails triagens::rest::ApplicationEndpointServer::_endpoints?????????????????????????
|
||||
-->
|
||||
@startDocuBlock serverEndpoint
|
||||
|
||||
`--daemon`
|
||||
|
||||
|
|
|
@ -149,7 +149,7 @@ access to additional index-specific methods like **range** or **fulltext** (see
|
|||
|
||||
The syntax for defining indexes is the same used in [*collection.ensureIndex*](../../IndexHandling/README.md).
|
||||
|
||||
@EXAMPLES
|
||||
**Examples**
|
||||
|
||||
```js
|
||||
var Foxx = require('org/arangodb/foxx');
|
||||
|
|
|
@ -25,8 +25,8 @@ cannot make changes to the flex or bison files.
|
|||
|
||||
!SUBSECTION Amazon Micro Instance
|
||||
|
||||
@sohgoh has reported that it is very easy to install ArangoDB on an Amazon
|
||||
Micro Instance:
|
||||
The github user @sohgoh has reported that it is very easy to install ArangoDB
|
||||
on an Amazon Micro Instance:
|
||||
|
||||
amazon> sudo yum install readline-devel
|
||||
amazon> ./configure
|
||||
|
|
|
@ -149,40 +149,3 @@ Changes or sets the property name an edges to value.
|
|||
arango> e.getPropert("weight")
|
||||
20
|
||||
|
||||
|
||||
<!--
|
||||
@anchor JSModuleGraphEdgeGetId
|
||||
@copydetails JSF_Edge_prototype_getId
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetInVertex
|
||||
@copydetails JSF_Edge_prototype_getInVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetLabel
|
||||
@copydetails JSF_Edge_prototype_getLabel
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetOutVertex
|
||||
@copydetails JSF_Edge_prototype_getOutVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetPeerVertex
|
||||
@copydetails JSF_Edge_prototype_getPeerVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetProperty
|
||||
@copydetails JSF_Edge_prototype_getProperty
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeGetPropertyKeys
|
||||
@copydetails JSF_Edge_prototype_getPropertyKeys
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeProperties
|
||||
@copydetails JSF_Edge_prototype_properties
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphEdgeSetProperty
|
||||
@copydetails JSF_Edge_prototype_setProperty
|
||||
-->
|
|
@ -190,58 +190,3 @@ Calculates the normalized degree, closeness, betweenness or eccentricity of all
|
|||
* betweenness: to calculate the betweenness
|
||||
* eccentricity: to calculate the eccentricity
|
||||
|
||||
<!--
|
||||
@verbinclude graph-setup
|
||||
|
||||
@anchor JSModuleGraphGraphConstructor
|
||||
@copydetails JSF_Graph_prototype_initialize
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphAddEdge
|
||||
@copydetails JSF_Graph_prototype_addEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphAddVertex
|
||||
@copydetails JSF_Graph_prototype_addVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetEdges
|
||||
@copydetails JSF_Graph_prototype_getEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetVertex
|
||||
@copydetails JSF_Graph_prototype_getVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetVertices
|
||||
@copydetails JSF_Graph_prototype_getVertices
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphRemoveVertex
|
||||
@copydetails JSF_Graph_prototype_removeVertex
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphRemoveEdge
|
||||
@copydetails JSF_Graph_prototype_removeEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphDrop
|
||||
@copydetails JSF_Graph_prototype_drop
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGetAll
|
||||
@copydetails JSF_graph_getAll
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphGeodesics
|
||||
@copydetails JSF_Graph_prototype_geodesics
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphMeasurement
|
||||
@copydetails JSF_Graph_prototype_measurement
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphGraphNormalizedMeasurement
|
||||
@copydetails JSF_Graph_prototype_normalizedMeasurement
|
||||
|
||||
-->
|
||||
|
|
|
@ -236,80 +236,3 @@ Changes or sets the property name a vertex to value.
|
|||
`vertex.measurement( measurement)`
|
||||
|
||||
Calculates the eccentricity, betweenness or closeness of the vertex
|
||||
|
||||
<!--
|
||||
@anchor JSModuleGraphVertexAddInEdge
|
||||
@copydetails JSF_Vertex_prototype_addInEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexAddOutEdge
|
||||
@copydetails JSF_Vertex_prototype_addOutEdge
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexEdges
|
||||
@copydetails JSF_Vertex_prototype_edges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetId
|
||||
@copydetails JSF_Vertex_prototype_getId
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetInEdges
|
||||
@copydetails JSF_Vertex_prototype_getInEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetOutEdges
|
||||
@copydetails JSF_Vertex_prototype_getOutEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetEdges
|
||||
@copydetails JSF_Vertex_prototype_getEdges
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetProperty
|
||||
@copydetails JSF_Vertex_prototype_getProperty
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetPropertyKeys
|
||||
@copydetails JSF_Vertex_prototype_getPropertyKeys
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexProperties
|
||||
@copydetails JSF_Vertex_prototype_properties
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexSetProperty
|
||||
@copydetails JSF_Vertex_prototype_setProperty
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexCommonNeighborsWith
|
||||
@copydetails JSF_Vertex_prototype_commonNeighborsWith
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexCommonPropertiesWith
|
||||
@copydetails JSF_Vertex_prototype_commonPropertiesWith
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexPathTo
|
||||
@copydetails JSF_Vertex_prototype_pathTo
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexDistanceTo
|
||||
@copydetails JSF_Vertex_prototype_distanceTo
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexDeterminePredecessors
|
||||
@copydetails JSF_Vertex_prototype_determinePredecessors
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexPathesForTree
|
||||
@copydetails JSF_Vertex_prototype_pathesForTree
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexGetNeighbors
|
||||
@copydetails JSF_Vertex_prototype_getNeighbors
|
||||
|
||||
@CLEARPAGE
|
||||
@anchor JSModuleGraphVertexMeasurement
|
||||
@copydetails JSF_Vertex_prototype_measurement
|
||||
-->
|
||||
|
|
|
@ -103,8 +103,8 @@ collections.
|
|||
!SUBSECTION Additional date functions
|
||||
|
||||
ArangoDB 2.7 provides several extra AQL functions for date and time
|
||||
calculation and manipulation. These functions were contributed by GitHub users
|
||||
@CoDEmanX and @friday. A big thanks for their work!
|
||||
calculation and manipulation. These functions were contributed
|
||||
by GitHub users @CoDEmanX and @friday. A big thanks for their work!
|
||||
|
||||
The following extra date functions are available from 2.7 on:
|
||||
|
||||
|
|
|
@ -328,6 +328,15 @@ def replaceCodeIndex(lines):
|
|||
#lines = re.sub(r"@RESTHEADER{([\s\w\/\_{}-]*),([\s\w-]*)}", r"###\g<2>\n`\g<1>`", lines)
|
||||
return lines
|
||||
|
||||
|
||||
RXFinal = [
|
||||
(re.compile(r"@anchor (.*)"), "<a name=\"\g<1>\">#</a>")
|
||||
]
|
||||
def replaceCodeFullFile(lines):
|
||||
for (oneRX, repl) in RXFinal:
|
||||
lines = oneRX.sub(repl, lines)
|
||||
return lines
|
||||
|
||||
################################################################################
|
||||
# main loop over all files
|
||||
################################################################################
|
||||
|
@ -367,11 +376,11 @@ def findStartCode(fd,full_path):
|
|||
textFile = replaceText(textFile, full_path, find)
|
||||
#print textFile
|
||||
|
||||
#try:
|
||||
# textFile = replaceCode(textFile)
|
||||
#except:
|
||||
# print >>sys.stderr, "while parsing :\n" + textFile
|
||||
# raise
|
||||
try:
|
||||
textFile = replaceCodeFullFile(textFile)
|
||||
except:
|
||||
print >>sys.stderr, "while parsing :\n" + textFile
|
||||
raise
|
||||
#print "9" * 80
|
||||
#print textFile
|
||||
outFD = open(full_path, "w")
|
||||
|
|
|
@ -95,6 +95,15 @@ examples:
|
|||
--javascript.execute /tmp/arangosh.examples.js ;\
|
||||
fi
|
||||
|
||||
examples-inspect-file:
|
||||
@echo "generating /tmp/allExamples.html"
|
||||
@(printf "<html><head></head><body><pre>\n"; \
|
||||
for thisExample in Documentation/Examples/*.generated; do \
|
||||
printf "<hr>\n<h3>$$thisExample</h3>\n"; \
|
||||
cat $$thisExample; \
|
||||
done; \
|
||||
printf "</pre></body></html>") > /tmp/allExamples.html
|
||||
|
||||
## -----------------------------------------------------------------------------
|
||||
## --SECTION-- END-OF-FILE
|
||||
## -----------------------------------------------------------------------------
|
||||
|
|
|
@ -310,6 +310,7 @@ namespace triagens {
|
|||
/// the path to a server certificate using the \-\-server.keyfile option.
|
||||
///
|
||||
/// Endpoints can also be changed at runtime.
|
||||
/// Please refer to HTTP Interface for Endpoints for more details.
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
|
|
@ -3676,6 +3676,8 @@ void RestReplicationHandler::handleCommandDump () {
|
|||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @startDocuBlock JSF_put_api_replication_makeSlave
|
||||
/// @brief Changes role to slave
|
||||
///
|
||||
/// @RESTHEADER{PUT /_api/replication/make-slave, Turn the server into a slave of another}
|
||||
///
|
||||
/// @RESTBODYPARAM{endpoint,string,required,string}
|
||||
|
|
|
@ -75,7 +75,12 @@ actions.defineHttp({
|
|||
/// @startDocuBlock JSF_get_admin_sleep
|
||||
/// @brief Suspend the execution for a specified duration before returnig
|
||||
///
|
||||
/// @RESTHEADER{GET /_admin/sleep?duration=5, Sleep for 5 seconds}
|
||||
/// @RESTHEADER{GET /_admin/sleep, Sleep for a specified amount of seconds}
|
||||
///
|
||||
/// @RESTQUERYPARAMETERS
|
||||
///
|
||||
/// @RESTURLPARAM{duration,integer,required}
|
||||
/// wait `duration` seconds until the reply is sent.
|
||||
///
|
||||
/// @RESTDESCRIPTION
|
||||
///
|
||||
|
|
|
@ -2133,16 +2133,25 @@
|
|||
"x-filename": "admin - js/actions/_admin/app.js, js/actions/_admin/routing/app.js, js/actions/_admin/server/app.js, js/actions/_admin/database/app.js, arangod/RestHandler/RestShutdownHandler.cpp"
|
||||
}
|
||||
},
|
||||
"/_admin/sleep?duration=5": {
|
||||
"/_admin/sleep": {
|
||||
"get": {
|
||||
"description": "\n\n<br> The call returns an object with the attribute <strong>duration</strong>. This takes as many seconds as the duration argument says. <br>",
|
||||
"parameters": [],
|
||||
"parameters": [
|
||||
{
|
||||
"description": "wait `duration` seconds until the reply is sent. <br>",
|
||||
"format": "integer",
|
||||
"in": "path",
|
||||
"name": "duration",
|
||||
"required": true,
|
||||
"type": "integer"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Sleep was conducted successfully. <br>"
|
||||
}
|
||||
},
|
||||
"summary": " Sleep for 5 seconds",
|
||||
"summary": " Sleep for a specified amount of seconds",
|
||||
"tags": [
|
||||
"admin"
|
||||
],
|
||||
|
|
|
@ -102,9 +102,6 @@ var findOrCreateEdgeCollectionByName = function (name) {
|
|||
///
|
||||
/// Changes or sets the property *name* an *edges* to *value*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-edge-set-property
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -140,9 +137,6 @@ Edge.prototype.setProperty = function (name, value) {
|
|||
///
|
||||
/// Returns a list of in- or outbound edges of the *vertex*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-vertex-edges
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -161,9 +155,6 @@ Vertex.prototype.edges = function () {
|
|||
///
|
||||
/// Returns a list of inbound edges of the *vertex* with given label(s).
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-vertex-get-in-edges
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -187,9 +178,6 @@ Vertex.prototype.getInEdges = function () {
|
|||
///
|
||||
/// Returns a list of outbound edges of the *vertex* with given label(s).
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-vertex-get-out-edges
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -235,10 +223,6 @@ Vertex.prototype.getEdges = function () {
|
|||
/// `vertex.inbound()`
|
||||
///
|
||||
/// Returns a list of inbound edges of the *vertex*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-vertex-inbound
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -257,9 +241,6 @@ Vertex.prototype.inbound = function () {
|
|||
///
|
||||
/// Returns a list of outbound edges of the *vertex*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-vertex-outbound
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -278,9 +259,6 @@ Vertex.prototype.outbound = function () {
|
|||
///
|
||||
/// Changes or sets the property *name* a *vertex* to *value*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-vertex-set-property
|
||||
/// @end Docu BLock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -319,9 +297,6 @@ Vertex.prototype.setProperty = function (name, value) {
|
|||
///
|
||||
/// Returns a known graph.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-constructor
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -612,9 +587,6 @@ Graph.prototype._replaceEdge = function (edge_id, data) {
|
|||
///
|
||||
/// Returns the vertex identified by *id* or *null*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-graph-get-vertex
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -635,9 +607,6 @@ Graph.prototype.getVertex = function (id) {
|
|||
/// Returns an iterator for all vertices of the graph. The iterator supports the
|
||||
/// methods *hasNext* and *next*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-graph-get-vertices
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -658,9 +627,6 @@ Graph.prototype.getVertices = function () {
|
|||
///
|
||||
/// Returns the edge identified by *id* or *null*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-graph-get-edge
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -694,9 +660,6 @@ Graph.prototype.getEdge = function (id) {
|
|||
/// Returns an iterator for all edges of the graph. The iterator supports the
|
||||
/// methods *hasNext* and *next*.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-graph-get-edges
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -716,9 +679,6 @@ Graph.prototype.getEdges = function () {
|
|||
///
|
||||
/// Deletes the *vertex* and all its edges.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-graph-remove-vertex
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
@ -749,9 +709,6 @@ Graph.prototype.removeVertex = function (vertex, waitForSync) {
|
|||
///
|
||||
/// Deletes the *edge*. Note that the in and out vertices are left untouched.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @verbinclude graph-graph-remove-edge
|
||||
/// @end Docu Block
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
|
Loading…
Reference in New Issue