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/Documentation/Makefile.files b/Documentation/Makefile.files index cde3550146..08c739285f 100644 --- a/Documentation/Makefile.files +++ b/Documentation/Makefile.files @@ -34,6 +34,8 @@ DOXYGEN = \ WIKI = \ ArangoErrors \ + Aql \ + AqlExamples \ CommandLine \ Compiling \ Communication \ @@ -87,12 +89,11 @@ WIKI = \ ShellEdge \ ShellIndex \ SimpleQueries \ + Upgrading \ UserManual \ UserManualBasics \ UserManualArangosh \ UserManualActions \ - Aql \ - AqlExamples \ jsUnity ## ----------------------------------------------------------------------------- @@ -153,8 +154,9 @@ doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN) @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --keep-title Doxygen/html/$$w.html Doxygen/website/$$w.html; done cp -R @top_srcdir@/Documentation/images/* Doxygen/website/images + cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/website - @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html Doxygen/html/$$w.html Doxygen/doc/$$w.html; done + @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html --keep-title Doxygen/html/$$w.html Doxygen/doc/$$w.html; done cp -R @top_srcdir@/Documentation/images/* Doxygen/doc/images cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/doc diff --git a/Documentation/Manual/FirstStepsArangoDB.md b/Documentation/Manual/FirstStepsArangoDB.md index 28f7ddeb4d..785c982aeb 100644 --- a/Documentation/Manual/FirstStepsArangoDB.md +++ b/Documentation/Manual/FirstStepsArangoDB.md @@ -44,7 +44,7 @@ For more in-depth information - @EXTREF_S{http://vimeo.com/36411892,watch the video} - Martin Schoenert, architect of ArangoDB, gives an introduction of what the ArangoDB project is about -- or give it a @EXTRES{http://www.arangodb.org/try,try} +- or give it a @EXTREF{http://www.arangodb.org/try,try}. Getting Familiar with ArangoDB {#FirstStepsArangoDBServerStart} =============================================================== @@ -373,7 +373,7 @@ CommandLineArango "here". @copydetails triagens::rest::ApplicationServer::_options -@CMDOPT{--log @CA{level}} +@CMDOPT{\--log @CA{level}} Allows the user to choose the level of information which is logged by the server. The @CA{level} is specified as a string and can be one of @@ -390,6 +390,6 @@ more information see @ref CommandLineLogging "here". @copydetails triagens::rest::ApplicationEndpointServer::_keepAliveTimeout -@CMDOPT{--daemon} +@CMDOPT{\--daemon} Runs the server as a daemon (as a background process). diff --git a/Documentation/Manual/Home.md b/Documentation/Manual/Home.md index 13da09c24d..bc3fb7416c 100644 --- a/Documentation/Manual/Home.md +++ b/Documentation/Manual/Home.md @@ -23,6 +23,11 @@ The HTML and PDF versions of the manual can be found Please contact @EXTREF_S{http://www.arangodb.org/connect,us} if you have any questions. +Upgrading to ArangoDB 1.1 {#ArangoDBUpgrading} +============================================== + +- @ref Upgrading + ArangoDB's User Manuals {#ArangoDBUserManual} ============================================= diff --git a/Documentation/Manual/Upgrading.md b/Documentation/Manual/Upgrading.md new file mode 100644 index 0000000000..099ce6d8e0 --- /dev/null +++ b/Documentation/Manual/Upgrading.md @@ -0,0 +1,189 @@ +Upgrading to ArangoDB 1.1 {#Upgrading} +====================================== + +ArangoDB 1.1 introduces new features but may in some respect have slightly different behavior than 1.0. + +This is unavoidable as new features get introduced and others become superfluous. + +The following list contains changes in ArangoDB 1.1 that are not 100% downwards-compatible to ArangoDB 1.0. + +Existing users of ArangoDB 1.0 should read the list carefully and make sure they have undertaken all +necessary steps and precautions before upgrading from ArangoDB 1.0 to ArangoDB 1.1. + +## Database directory version check and upgrade + +Starting with ArangoDB 1.1, _arangod_ will perform a database version check at startup. + +It will look for a file named _VERSION_ in its database directory. If the file is not present +(it will not be present in an ArangoDB 1.0 database), _arangod_ in version 1.1 will refuse to start +and ask the user to run the script _arango-upgrade_ first. + +If the _VERSION_ file is present but is from a non-matching version of ArangoDB, _arangod_ will also +refuse to start and ask the user to run the upgrade script first. +This procedure shall ensure that users have full control over when they perform any updates/upgrades +of their data, and do not risk running an incompatible tandem of server and database. + +ArangoDB users are asked to run _arango-upgrade_ when upgrading from one version of ArangoDB to a +higher version (e.g. from 1.0 to 1.1 in this case), but also after pulling the latest ArangoDB source +code while staying in the same minor version (e.g. when updating from 1.1-beta1 to 1.1-beta2). + +When installing ArangoDB from scratch, users should also run _arango-upgrade_ once to initialise their +database directory with some system collections that ArangoDB requires. When not run, _arangod_ will refuse +to start as mentioned before. + +_arango-upgrade_ can be invoked from the command-line, and takes the database directory as its +only argument: + + > bin/arango-upgrade --database.directory /tmp/voctest + + ... + 2012-11-21T18:00:38Z [2411] INFO Upgrade script ./js/server/arango-upgrade.js started + 2012-11-21T18:00:38Z [2411] INFO Server version: 1.1.beta2, database directory version: (not set) + 2012-11-21T18:00:38Z [2411] INFO Found 9 defined task(s), 9 task(s) to run + 2012-11-21T18:00:38Z [2411] INFO Executing task #1 (setupUsers): setup _users collection + 2012-11-21T18:00:38Z [2411] INFO Task successful + ... + 2012-11-21T18:00:40Z [2411] INFO Upgrade script successfully finished + 2012-11-21T18:00:42Z [2411] INFO ArangoDB has been shut down + +The _arango-upgrade_ will execute the defined tasks to run _arangod_ with all new features and +data formats. It should normally run without problems and indicate success at script end. If it detects +a problem that it cannot fix, it will halt on the first error and warn the user. + +Re-executing _arango-upgrade_ will execute only the previously failed and not yet executed tasks. + +_arango-upgrade_ needs exclusive access to the database, so it cannot be executed while an +instance of _arangod_ is currently running. + + +## Server startup options changes + +### Port options and endpoints + +The following startup options have been removed for _arangod_ in version 1.1: +- `--port` +- `--server.port` +- `--server.http-port` +- `--server.admin-port` + +All these options are replaced by the new `--server.endpoint` option in ArangoDB 1.1. + + +The server must now be started with a defined endpoint. +The new `--server.endpoint` option is required to specify the protocol, hostname and port the +server should use when listening for incoming connections. + +The `--server.endpoint` option must be specified on server start, either on the command line or via +a configuration file, otherwise _arangod_ will refuse to start. + +The server can be bound to one or multiple endpoints at once. The following endpoint +specification sytnax is currently supported: +- `tcp://host:port (HTTP over IPv4)` +- `tcp://[host]:port (HTTP over IPv6)` +- `ssl://host:port (HTTP over SSL-encrypted IPv4)` +- `ssl://[host]:port (HTTP over SSL-encrypted IPv6)` +- `unix://path/to/socket (HTTP over UNIX socket)` + +An example value for the option is `--server.endpoint tcp://127.0.0.1:8529`. +This will make the server listen to requests coming in on IP address 127.0.0.1 on port 8529, +and that use HTTP over TCP/IPv4. + +### Authorization + +Starting from 1.1, _arangod_ may be started with authentication turned on. +When authentication is turned on, all requests incoming to _arangod_ via the HTTP interface must +carry an _HTTP authorization_ header with a valid username and password in order to be processed. +Clients sending requests without HTTP autorization headers or with invalid usernames/passwords +will be rejected by arangod with an HTTP 401 error. + +_arango-upgrade_ will create a default user _root_ with an empty password when run initially. + +To turn authorization off, the server can be started with the following command line option: + --server.disable-authentication true +Of course this option can also be stored in a configuration file. + + +### HTTP keep-alive + +The following _arangod_ startup options have been removed in ArangoDB 1.1: +- `--server.require-keep-alive` +- `--server.secure-require-keep-alive` + +In version 1.1, The server will now behave as follows automatically which should be more +conforming to the HTTP standard: +- if a client sends a `Connection: close` HTTP header, the server will close the connection as + requested +- if a client sends a `Connection: keep-alive` HTTP header, the server will not close the + connection but keep it alive as requested +- if a client does not send any `Connection` HTTP header, the server will assume _keep-alive_ + if the request was an HTTP/1.1 request, and "close" if the request was an HTTP/1.0 request +- dangling keep-alive connections will be closed automatically by the server after a configurable + amount of seconds. To adjust the value, use the new server option `--server.keep-alive-timeout` + + +## Start / stop scripts + +The user used in start and stop scripts has changed from _arango_ to _arangodb_. Furthermore, +the start script name itself has changed from _arangod_ to _arangodb_. Additionally, the default +database directory name changed from _/var/arangodb_ to _/var/lib/arangodb_. +This was done to be more compliant with various Linux policies. + + +## Collection types + +In ArangoDB 1.1, collection types have been introduced: +- regular documents go into _document_-only collections, +- and edges go into _edge_ collections. + +The prefixing (`db.xxx` and `edges.xxx`) that could be used to access a collection thus works +slightly differently in 1.1: + +`edges.xxx` can still be used to access collections, however, it will not determine the type +of existing collections anymore. In 1.0, you could write `edges.xxx.something` and `xxx` was +automatically treated as an _edge_ collection. + +As collections know and save their type in ArangoDB 1.1, this might work slightly differently. +The type of existing collections is immutable and not modifiable by changing the prefix (`db` or `edges`). + +In 1.1, _edge_ collections can be created via the following ways: +- `edges._create()` as in 1.0 +- addtionally there is a new method `db._createEdgeCollection()` + +To create _document_ collections, the following methods are available: +- `db._create()` as in 1.0, +- additionally there is now `db._createDocumentCollection()` + +Collections in 1.1 are now either _document_-only or _edge_ collections, but the two concepts +cannot be mixed in the same collection. + +_arango-upgrade_ will determine the types of existing collections from 1.0 once on upgrade, +based on the inspection of the first 50 documents in the collection. + +If one of the documents contains either a `_from` or a `_to` attribute, the collection is made an +_edge_ collection. Otherwise, the collection is marked as a _document_ collection. + +This distinction is important because edges can only be created in _edge_ collections starting +with 1.1. Client code may need to be adjusted to work with ArangoDB 1.1 if it tries to insert +edges into _document_-only collections. + + +## arangoimp / arangosh + +The parameters `--connect-timeout` and `--request-timeout` for _arangosh_ and _arangoimp_ have been +renamed to `--server.connect-timeout` and `--server.request-timeout`. + +The parameter `--server` has been removed for both _arangoimp_ and _arangosh_. + +To specify a server to connect to, the client tools now provide an option `--server.endpoint`. +This option can be used to specify the protocol, hostname and port for the connection. +The default endpoint that is used when none is specified is `tcp://127.0.0.1:8529`. +For more information on the endpoint specification syntax, see above. + +The options `--server.username` and `--server.password` have been added for _arangoimp_ and _arangosh_ +in order to use authorization from these client tools, too. + +These options can be used to specify the username and password when connecting via client tools +to the _arangod_ server. If no password is given on the command line, _arangoimp_ and _arangosh_ +will interactively prompt for a password. +If no username is specified on the command line, the default user _root_ will be used but there +will still be a password prompt. diff --git a/Documentation/Scripts/html2html.sh b/Documentation/Scripts/html2html.sh index 5fe97f8275..72927e8bd1 100755 --- a/Documentation/Scripts/html2html.sh +++ b/Documentation/Scripts/html2html.sh @@ -37,8 +37,8 @@ if test "x$FULL_HTML" == "x0"; then HEADER="" FOOTER="" else - HEADER='ArangoDB: About ArangoDB
' - FOOTER='' + HEADER='ArangoDB: About ArangoDB
' + FOOTER='
' fi rm -f $OUTPUT.tmp diff --git a/Documentation/arango.template.in b/Documentation/arango.template.in index a45a84dfb0..15f0e5431b 100644 --- a/Documentation/arango.template.in +++ b/Documentation/arango.template.in @@ -197,48 +197,56 @@ TAB_SIZE = 8 # function definition ALIASES = \ - "FUN{1}=@latexonly\functionsignature{\1}@endlatexonly@htmlonly
\1
@endhtmlonly" \ - "FUN{2}=@latexonly\functionsignature{\1, \2}@endlatexonly@htmlonly
\1, \2
@endhtmlonly" \ - "FUN{3}=@latexonly\functionsignature{\1, \2, \3}@endlatexonly@htmlonly
\1, \2, \3
@endhtmlonly" \ - "FUN{4}=@latexonly\functionsignature{\1, \2, \3, \4}@endlatexonly@htmlonly
\1, \2, \3, \4
@endhtmlonly" \ - "FUN{5}=@latexonly\functionsignature{\1, \2, \3, \4, \5}@endlatexonly@htmlonly
\1, \2, \3, \4, \5
@endhtmlonly" \ - "FUN{6}=@latexonly\functionsignature{\1, \2, \3, \4, \5, \6}@endlatexonly@htmlonly
\1, \2, \3, \4, \5, \6
@endhtmlonly" \ - "FUN{7}=@latexonly\functionsignature{\1, \2, \3, \4, \5, \6, \7}@endlatexonly@htmlonly
\1, \2, \3, \4, \5, \6, \7
@endhtmlonly" \ - "FA{1}=\1" \ - "FN{1}=\1" + "FUN{1}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FUN{2}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FUN{3}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FUN{4}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FUN{5}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4, \5@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FUN{6}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4, \5, \6@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FUN{7}=@latexonly\functionsignature{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4, \5, \6, \7@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FA{1}=@latexonly\functionargument{@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "FN{1}=@latexonly\functionname{@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly" # command line option ALIASES += \ - "CMDOPT{1}=@latexonly\commandlineoption{\1}@endlatexonly@htmlonly
\1
@endhtmlonly" \ - "CA{1}=\1" \ - "CO{1}=\1" + "CMDOPT{1}=@latexonly\commandlineoption{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "CA{1}=@latexonly\commandlineargument{@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "CO{1}=@latexonly\commandoption{@endlatexon\@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly" # rest calls ALIASES += \ - "RESTHEADER{2}=@latexonly\restheader{1 (\2)}@endlatexonly@htmlonly
\1
(\2)
@endhtmlonly" \ - "REST{1}=\1" + "RESTHEADER{2}=@latexonly\restheader{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly,@endlatexonly@htmlonly
(@endhtmlonly@xmlonly XMLMISSING @endxmlonly\2@latexonly}@endlatexonly@htmlonly)
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \ + "REST{1}=@latexonly\restcall{@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly
@endhtmlonly@xmlonly XMLMISSING @endxmlonly" + +# navigation +ALIASES += \ + "NAVIGATE{3}=@htmlonly
prev | home | next
@endhtmlonly" \ + "EMBEDTOC{1}=@if LATEX@else@htmlonly
@endhtmlonly@copydoc \1\n@htmlonly
@endhtmlonly@endif" + +# glossary +ALIASES += \ + "GE{1}=@latexonly\glossaryentry{@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly@endhtmlonly@xmlonly XMLMISSING @endxmlonly" + +# examples +ALIASES += \ + "EXAMPLES=@htmlonly
Examples
@endhtmlonly" \ + "EXAMPLE{2}=@latexonly\renewcommand{\examplecap}{\2}\setboolean{hascap}{true}@endlatexonly@verbinclude \1@latexonly\setboolean{hascap}{false}@endlatexonly" \ + "TINYEXAMPLE{2}=@latexonly\renewcommand{\examplecap}{\2}\setboolean{hascap}{true}\renewcommand{\examplesize}{\tiny}@endlatexonly@verbinclude \1@latexonly\setboolean{hascap}{false}\renewcommand{\examplesize}{\ttfamily}@endlatexonly" + +# references +ALIASES += \ + "EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" \ + "EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else\2 @endif" \ + "S_EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else \2@endif" \ + "INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif" # other aliases ALIASES += \ - "VAR{1}=\1" \ - "LIT{1}=\1" \ - "CODE{1}=\1" \ - "CODE{2}=\1, \2" \ - "CODE{3}=\1, \2, \3" \ - "GE{1}=\1" \ - "EXAMPLES=@htmlonly
Examples
@endhtmlonly" \ - "EXAMPLE{2}=@latexonly\renewcommand{\examplecap}{\2}\setboolean{hascap}{true}@endlatexonly@verbinclude \1@latexonly\setboolean{hascap}{false}@endlatexonly" \ - "TINYEXAMPLE{2}=@latexonly\renewcommand{\examplecap}{\2}\setboolean{hascap}{true}\renewcommand{\examplesize}{\tiny}@endlatexonly@verbinclude \1@latexonly\setboolean{hascap}{false}\renewcommand{\examplesize}{\ttfamily}@endlatexonly" \ "VERSION=@PACKAGE_VERSION@" \ - "NAVIGATE{3}=@htmlonly
prev | home | next
@endhtmlonly" \ - "EMBEDTOC{1}=@if LATEX@else@htmlonly
@endhtmlonly@copydoc \1\n@htmlonly
@endhtmlonly@endif" \ + "LIT{1}=\1" \ + "LIT{2}=\1, \2" \ + "LIT{3}=\1, \2, \3" \ "LATEXBREAK=@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" \ - "EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else\2@endif" \ - "EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else\2 @endif" \ - "S_EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else \2@endif" \ - "EXTRES{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else \2@endif" \ - "INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif" \ - "SPC= " \ "CLEARPAGE=@if LATEX @latexonly\clearpage@endlatexonly@else\n@endif" # This tag can be used to specify a number of word-keyword mappings (TCL only). diff --git a/Documentation/arangodb.css b/Documentation/arangodb.css index 071c920962..428d2dd2f3 100644 --- a/Documentation/arangodb.css +++ b/Documentation/arangodb.css @@ -3,15 +3,70 @@ padding: 14px 0 3px; } +/* ************************************************************************** */ +/* global */ +/* ************************************************************************** */ + +#content div.arangodb { + background: none repeat scroll 0 0 transparent; + border: 0 none; + color: #666666; + font-family: "Helvetica",sans-serif; + font-size: 16px; + font-weight: 300; + line-height: 1.4em; + margin: 0; + padding: 0px; + vertical-align: baseline; +} + +#content div.offlineview { + width: 980px; +} + +#content div.arangodb p, #content div.arangodb ul, #content div.arangodb ol, #content div.arangodb dd, #content div.arangodb pre, #content div.arangodb hr { + margin-bottom: 24px; +} + +/* ************************************************************************** */ +/* title */ +/* ************************************************************************** */ + +#content div.arangodb div.headertitle, #content div.arangodb h1, #content div.arangodb h2, #content div.arangodb h3, #content div.arangodb h4, #content div.arangodb h5, #content div.arangodb h6 { + color: #000000; + font-family: Helvetica; + font-weight: lighter; + line-height: 1em; + margin: 0 0 20px; + text-align: left; +} + +#content div.arangodb div.headertitle { + border-bottom: 1px solid #EFECE9; + font-family: Rockwell,Georgia,"Times New Roman",Times,serif; + font-size: 2em; + margin-bottom: 38px; + padding: 14px 0 3px; +} + +#content div.arangodb h2 { + border-bottom: 1px solid #EFECE9; + color: #404040; + font-family: Helvetica,Times New Roman; + font-size: 26px; + margin-bottom: 14px; + padding: 14px 0 3px; +} + /* ************************************************************************** */ /* navigation bar */ /* ************************************************************************** */ #content div.arangodb div.navigate { + height: 0px; position: relative; text-align: right; top: -70px; - height: 0px; } /* ************************************************************************** */ @@ -26,9 +81,27 @@ } #content div.arangodb div.toc ul { + margin-top: 0px; margin-bottom: 0px; } +/* ************************************************************************** */ +/* pre */ +/* ************************************************************************** */ + +#content div.arangodb pre { + background-color: #FBFCFD !important; + border: 1px solid #C4CFE5 !important; + font-family: monospace,fixed; + font-size: 105%; + font-size: 15px; + line-height: 21px; + margin: 4px 8px 24px 2px; + overflow: auto; + padding: 4px 6px; + word-wrap: break-word; +} + /* ************************************************************************** */ /* function signature */ /* ************************************************************************** */ @@ -48,6 +121,10 @@ margin-bottom: 14px; } +#content div.arangodb span.commandlineargument { + font-style: italic; +} + /* ************************************************************************** */ /* rest call */ /* ************************************************************************** */ diff --git a/Installation/Makefile.local b/Installation/Makefile.local index cf2c51267c..e7ac8ee6e9 100644 --- a/Installation/Makefile.local +++ b/Installation/Makefile.local @@ -25,7 +25,8 @@ publish-wiki: publish-html: $(OUTPUT_FOLDER) $(MAKE) doxygen @for w in $(WIKI); do cp Doxygen/website/$$w.html $(OUTPUT_FOLDER); done - @for i in `ls Doxygen/doc/images/*.png`; do cp $$i $(OUTPUT_FOLDER)/images; done + @for i in `ls Doxygen/website/images/*.png`; do cp $$i $(OUTPUT_FOLDER)/images; done + @cp Doxygen/website/arangodb.css $(OUTPUT_FOLDER) publish-pdf: $(OUTPUT_FOLDER) $(MAKE) latex diff --git a/Makefile.in b/Makefile.in index bd7269de33..425d89fa13 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1602,6 +1602,8 @@ DOXYGEN = \ ################################################################################ WIKI = \ ArangoErrors \ + Aql \ + AqlExamples \ CommandLine \ Compiling \ Communication \ @@ -1655,12 +1657,11 @@ WIKI = \ ShellEdge \ ShellIndex \ SimpleQueries \ + Upgrading \ UserManual \ UserManualBasics \ UserManualArangosh \ UserManualActions \ - Aql \ - AqlExamples \ jsUnity @ENABLE_ALL_IN_ONE_ICU_TRUE@ICUDIR = @abs_top_srcdir@/3rdParty/icu/BUILD @@ -5692,8 +5693,9 @@ doxygen: Doxygen/.setup-directories Doxygen/arango-html.doxy $(DOXYGEN) @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --keep-title Doxygen/html/$$w.html Doxygen/website/$$w.html; done cp -R @top_srcdir@/Documentation/images/* Doxygen/website/images + cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/website - @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html Doxygen/html/$$w.html Doxygen/doc/$$w.html; done + @for w in $(WIKI); do @top_srcdir@/Documentation/Scripts/html2html.sh --full-html --keep-title Doxygen/html/$$w.html Doxygen/doc/$$w.html; done cp -R @top_srcdir@/Documentation/images/* Doxygen/doc/images cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/doc 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/api-collection.dox b/arangod/Documentation/api-collection.dox index cd704e90cc..6cf400c3b1 100644 --- a/arangod/Documentation/api-collection.dox +++ b/arangod/Documentation/api-collection.dox @@ -99,7 +99,7 @@ /// identifier identifies a collection and is managed by ArangoDB. All /// collections are found under the URI /// -/// @LIT{http://@FA{server}:@FA{port}/_api/collection/@FA{collection-identifier}} +/// @LIT{http://server:port/_api/collection/collection-identifier} /// /// For example: Assume that the collection identifier is @LIT{7254820}, /// then the URL of that collection is: diff --git a/arangod/Documentation/api-index.dox b/arangod/Documentation/api-index.dox index 3bf9087a00..d1cdfb5444 100644 --- a/arangod/Documentation/api-index.dox +++ b/arangod/Documentation/api-index.dox @@ -84,7 +84,7 @@ /// All indexes in ArangoDB have an unique handle. This index handle identifies /// an index and is managed by ArangoDB. All indexes are found under the URI /// -/// @LIT{http://@FA{server}:@FA{port}/_api/index/@FA{index-handle}} +/// @LIT{http://server:port/_api/index/index-handle} /// /// For example: Assume that the index handle is @LIT{7254820/63563528} then /// the URL of that index is: diff --git a/arangod/Documentation/command-line-options.dox b/arangod/Documentation/command-line-options.dox index 1e8e8e9e18..b393289b59 100644 --- a/arangod/Documentation/command-line-options.dox +++ b/arangod/Documentation/command-line-options.dox @@ -128,7 +128,7 @@ /// @copydetails triagens::rest::ApplicationServer::_configFile /// /// @anchor CommandLineDaemon -/// @CMDOPT{--daemon} +/// @CMDOPT{\--daemon} /// /// Runs the server as a daemon (as a background process). This parameter can /// only be set if the pid (process id) file is specified. That is, unless a @@ -136,7 +136,7 @@ /// error and exit. /// /// @anchor CommandLineSupervisor -/// @CMDOPT{--supervisor} +/// @CMDOPT{\--supervisor} /// /// Executes the server in supervisor mode. In the event that the server /// unexpectedly terminates due to an internal error, the supervisor will @@ -196,7 +196,7 @@ /// @copydetails triagens::rest::ApplicationEndpointServer::_sslCipherList /// /// @anchor CommandLineArangoDisableAdminInterface -/// @CMDOPT{--disable-admin-interface @CA{value}} +/// @CMDOPT{\--disable-admin-interface @CA{value}} /// /// If this option is specified and @CA{value} is @LIT{true}, then the HTML /// administration interface at URL @LIT{http://server:port/} will be disabled @@ -236,14 +236,14 @@ /// @copydetails triagens::rest::ApplicationScheduler::_backend /// /// @anchor CommandLineSchedulerShowIoBackends -/// @CMDOPT{--show-io-backends} +/// @CMDOPT{\--show-io-backends} /// /// If this option is specified, then the server will list available backends /// and exit. This option is useful only when used in conjunction with the /// option scheduler.backend. An integer is returned (which is platform /// dependent) which indicates available backends on your platform. See libev /// for further details and for the meaning of the integer returned. This -/// describes the allowed integers for @CODE{scheduler.backend}, see +/// describes the allowed integers for @LIT{scheduler.backend}, see /// @ref CommandLineScheduler "here" for details. /// /// @section CommandLineLogging Command-Line Options for Logging diff --git a/arangod/Documentation/install-manual.dox b/arangod/Documentation/install-manual.dox index 53cea200b4..e7ed6d297b 100644 --- a/arangod/Documentation/install-manual.dox +++ b/arangod/Documentation/install-manual.dox @@ -173,7 +173,7 @@ ///////////////////////// /// /// Please use the -/// @EXTRES{https://github.com/mgiken/portage-overlay/tree/master/dev-db/ArangoDB,portage} +/// @EXTREF_S{https://github.com/mgiken/portage-overlay/tree/master/dev-db/ArangoDB,portage} /// provided by @@mgiken. /// /// @subsubsection InstallingOpenSUSE OpenSuSE @@ -214,7 +214,7 @@ ///////////////////////////////////////////////// /// /// If you are using homebrew, -/// then you can install the ArangoDB using @CODE{brew} as follows: +/// then you can install the ArangoDB using @LIT{brew} as follows: /// /// @code /// brew install arangodb diff --git a/arangod/Documentation/module-jsunity.dox b/arangod/Documentation/module-jsunity.dox index 4cabb1e6f1..91d2407368 100644 --- a/arangod/Documentation/module-jsunity.dox +++ b/arangod/Documentation/module-jsunity.dox @@ -51,7 +51,7 @@ /// /// Assume that your file live in a directory called @LIT{lib}. Use /// -/// @CODE{node-jscoverage lib lib-cov} +/// @LIT{node-jscoverage lib lib-cov} /// /// to create a copy of the JavaScript files with coverage information. Start /// the ArangoDB with these files and use @FN{jsunity.runCoverage} instead of diff --git a/arangod/Documentation/rest-document.dox b/arangod/Documentation/rest-document.dox index ebd5d8b87c..3564a55734 100644 --- a/arangod/Documentation/rest-document.dox +++ b/arangod/Documentation/rest-document.dox @@ -95,7 +95,7 @@ /// defines a document and is managed by ArangoDB. All documents are /// found under the URI: /// -/// @LIT{http://@FA{server}:@FA{port}/_api/document/@FA{document-handle}} +/// @LIT{http://server:port/_api/document/document-handle} /// /// For example: Assume that the document handle, which is stored in /// the @LIT{_id} field of the document, is @LIT{7254820/362549736}, diff --git a/arangod/Documentation/rest-edge.dox b/arangod/Documentation/rest-edge.dox index e917776ef0..7d221796f1 100644 --- a/arangod/Documentation/rest-edge.dox +++ b/arangod/Documentation/rest-edge.dox @@ -93,11 +93,11 @@ /// defines a document and is managed by ArangoDB. All documents are /// found under the URI /// -/// @LIT{http://@FA{server}:@FA{port}/_api/document/@FA{document-handle}} +/// @LIT{http://server:port/_api/document/document-handle} /// /// For edges you can use the special address /// -/// @LIT{http://@FA{server}:@FA{port}/_api/edge/@FA{document-handle}} +/// @LIT{http://server:port/_api/edge/document-handle} /// /// For example: Assume that the document handle, which is stored in /// the @LIT{_id} field of the edge, is @LIT{7254820/362549736}, diff --git a/arangod/Documentation/simple-queries.dox b/arangod/Documentation/simple-queries.dox index e7e3629f55..d3db19c70a 100644 --- a/arangod/Documentation/simple-queries.dox +++ b/arangod/Documentation/simple-queries.dox @@ -142,8 +142,8 @@ /// faster than a simple R* index. /// /// In general a geo coordinate is a pair of latitude and longitude. This can -/// either be an list with two elements like @CODE{[-10\, +30]} (latitude -/// first, followed by longitude) or an object like @CODE{{lon: -10\, lat: +30}}. +/// either be an list with two elements like @LIT{[-10\, +30]} (latitude +/// first, followed by longitude) or an object like @LIT{{lon: -10\, lat: +30}}. /// In order to find all documents within a given radius around a coordinate /// use the @FN{within} operator. In order to find all documents near a given /// document use the @FN{near} operator. @@ -177,7 +177,7 @@ /// @FN{skip} used together with @FN{limit} can be used to implement pagination. /// The @FN{skip} operator skips over the first n documents. So, in order to /// create result pages with 10 result documents per page, you can use -/// @CODE{skip(n * 10).limit(10)} to access the 10 documents on the n.th page. +/// @LIT{skip(n * 10).limit(10)} to access the 10 documents on the n.th page. /// This result should be sorted, so that the pagination works in a predicable /// way. /// diff --git a/arangod/MRServer/ApplicationMR.h b/arangod/MRServer/ApplicationMR.h index c029fa2b1f..f29d43db85 100644 --- a/arangod/MRServer/ApplicationMR.h +++ b/arangod/MRServer/ApplicationMR.h @@ -271,7 +271,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief path to the directory containing alternate startup scripts /// -/// @CMDOPT{--ruby.directory @CA{directory}} +/// @CMDOPT{\--ruby.directory @CA{directory}} /// /// Specifies the @CA{directory} path to alternate startup MRuby files. /// Normally, the server will start using built-in MRuby core functionality. To @@ -284,7 +284,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief semicolon separated list of module directories /// -/// @CMDOPT{--ruby.modules-path @CA{directory}} +/// @CMDOPT{\--ruby.modules-path @CA{directory}} /// /// Specifies the @CA{directory} path with user defined MRuby modules. Multiple /// paths can be specified separated with commas. @@ -295,7 +295,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief path to the system action directory /// -/// @CMDOPT{--ruby.action-directory @CA{directory}} +/// @CMDOPT{\--ruby.action-directory @CA{directory}} /// /// Specifies the @CA{directory} containg the system defined MRuby files that /// can be invoked as actions. @@ -306,7 +306,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief MRuby garbage collection interval (each x requests) /// -/// @CMDOPT{--ruby.gc-interval @CA{interval}} +/// @CMDOPT{\--ruby.gc-interval @CA{interval}} /// /// Specifies the interval (approximately in number of requests) that the /// garbage collection for MRuby objects will be run in each thread. @@ -317,7 +317,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief MRuby garbage collection frequency (each x seconds) /// -/// @CMDOPT{--ruby.gc-frequency @CA{frequency}} +/// @CMDOPT{\--ruby.gc-frequency @CA{frequency}} /// /// Specifies the frequency in seconds for the automatic garbage collection of /// MRuby objects. This setting is useful to have the garbage collection diff --git a/arangod/RestServer/ArangoServer.h b/arangod/RestServer/ArangoServer.h index 671fc00f3a..afa3f5c5b1 100644 --- a/arangod/RestServer/ArangoServer.h +++ b/arangod/RestServer/ArangoServer.h @@ -256,7 +256,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief number of dispatcher threads for non-database worker /// -/// @CMDOPT{--server.threads @CA{number}} +/// @CMDOPT{\--server.threads @CA{number}} /// /// Specifies the @CA{number} of threads that are spawned to handle action /// requests using Rest, JavaScript, or Ruby. @@ -267,10 +267,10 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief path to the database /// -/// @CMDOPT{--database.directory @CA{directory}} +/// @CMDOPT{\--database.directory @CA{directory}} /// /// The directory containing the collections and data-files. Defaults -/// to @CODE{/var/lib/arango}. +/// to @LIT{/var/lib/arango}. /// /// @CMDOPT{@CA{directory}} /// @@ -287,7 +287,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief remove on drop /// -/// @CMDOPT{--database.remove-on-drop @CA{flag}} +/// @CMDOPT{\--database.remove-on-drop @CA{flag}} /// /// If @LIT{true} and you drop a collection, then they directory and all /// associated datafiles will be removed from disk. If @LIT{false}, then they @@ -304,7 +304,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief remove on compaction /// -/// @CMDOPT{--database.remove-on-compaction @CA{flag}} +/// @CMDOPT{\--database.remove-on-compaction @CA{flag}} /// /// Normally the garbage collection will removed compacted datafile. For debug /// purposes you can use this option to keep the old datafiles. You should @@ -318,7 +318,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief default journal size /// -/// @CMDOPT{--database.maximal-journal-size @CA{size}} +/// @CMDOPT{\--database.maximal-journal-size @CA{size}} /// /// Maximal size of journal in bytes. Can be overwritten when creating a new /// collection. Note that this also limits the maximal size of a single @@ -332,7 +332,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief default wait for sync behavior /// -/// @CMDOPT{--database.wait-for-sync @CA{boolean}} +/// @CMDOPT{\--database.wait-for-sync @CA{boolean}} /// /// Default wait-for-sync value. Can be overwritten when creating a new /// collection. @@ -345,7 +345,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief force sync shapes /// -/// @CMDOPT{--database.force-sync-shapes @CA{boolean}} +/// @CMDOPT{\--database.force-sync-shapes @CA{boolean}} /// /// Force syncing of shape data to disk when writing shape information. /// If turned off, syncing will still happen for shapes of collections that @@ -360,7 +360,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief unit tests /// -/// @CMDOPT{--javascript.unit-tests @CA{test-file}} +/// @CMDOPT{\--javascript.unit-tests @CA{test-file}} /// /// Runs one or more unit tests. //////////////////////////////////////////////////////////////////////////////// @@ -370,7 +370,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief files to jslint /// -/// @CMDOPT{--jslint @CA{test-file}} +/// @CMDOPT{\--jslint @CA{test-file}} /// /// Runs jslint on one or more files. //////////////////////////////////////////////////////////////////////////////// @@ -380,7 +380,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief run script file /// -/// @CMDOPT{--javascript.script @CA{script-file}} +/// @CMDOPT{\--javascript.script @CA{script-file}} /// /// Runs the script file. //////////////////////////////////////////////////////////////////////////////// @@ -390,7 +390,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief parameters to script file /// -/// @CMDOPT{--javascript.script-parameter @CA{script-parameter}} +/// @CMDOPT{\--javascript.script-parameter @CA{script-parameter}} /// /// Parameter to script. //////////////////////////////////////////////////////////////////////////////// @@ -400,7 +400,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief server default language /// -/// @CMDOPT{--default-language @CA{script-parameter}} +/// @CMDOPT{\--default-language @CA{script-parameter}} /// /// Parameter to script. //////////////////////////////////////////////////////////////////////////////// diff --git a/arangod/V8Server/ApplicationV8.h b/arangod/V8Server/ApplicationV8.h index 0627a32153..afd17a7ff0 100644 --- a/arangod/V8Server/ApplicationV8.h +++ b/arangod/V8Server/ApplicationV8.h @@ -330,7 +330,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief path to the directory containing alternate startup scripts /// -/// @CMDOPT{--javascript.directory @CA{directory}} +/// @CMDOPT{\--javascript.directory @CA{directory}} /// /// Specifies the @CA{directory} path to alternate startup JavaScript files. /// Normally, the server will start using built-in JavaScript core @@ -343,7 +343,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief semicolon separated list of module directories /// -/// @CMDOPT{--javascript.modules-path @CA{directory}} +/// @CMDOPT{\--javascript.modules-path @CA{directory}} /// /// Specifies the @CA{directory} path with user defined JavaScript modules. /// Multiple paths can be specified separated with commas. @@ -354,7 +354,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief path to the system action directory /// -/// @CMDOPT{--javascript.action-directory @CA{directory}} +/// @CMDOPT{\--javascript.action-directory @CA{directory}} /// /// Specifies the @CA{directory} containg the system defined JavaScript files /// that can be invoked as actions. @@ -377,7 +377,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief JavaScript garbage collection interval (each x requests) /// -/// @CMDOPT{--javascript.gc-interval @CA{interval}} +/// @CMDOPT{\--javascript.gc-interval @CA{interval}} /// /// Specifies the interval (approximately in number of requests) that the /// garbage collection for JavaScript objects will be run in each thread. @@ -388,7 +388,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief JavaScript garbage collection frequency (each x seconds) /// -/// @CMDOPT{--javascript.gc-frequency @CA{frequency}} +/// @CMDOPT{\--javascript.gc-frequency @CA{frequency}} /// /// Specifies the frequency (in seconds) for the automatic garbage collection of /// JavaScript objects. This setting is useful to have the garbage collection @@ -400,7 +400,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief optional arguments to pass to v8 /// -/// @CMDOPT{--javascript.v8-options @CA{options}} +/// @CMDOPT{\--javascript.v8-options @CA{options}} /// /// Optional arguments to pass to the V8 Javascript engine. The V8 engine will /// run with default settings unless explicit options are specified using this diff --git a/arangod/VocBase/primary-collection.h b/arangod/VocBase/primary-collection.h index 9f3ffa0238..e2c41e6b87 100644 --- a/arangod/VocBase/primary-collection.h +++ b/arangod/VocBase/primary-collection.h @@ -1,4 +1,4 @@ -//////////////////////////////////////////////////////////////////////////////// +/////////////////////////////////////////////////////////////////////////////// /// @brief primary collection with global read-write lock /// /// @file diff --git a/arangod/VocBase/vocbase.h b/arangod/VocBase/vocbase.h index 7fa1519d9c..42adcb05c4 100644 --- a/arangod/VocBase/vocbase.h +++ b/arangod/VocBase/vocbase.h @@ -342,10 +342,10 @@ typedef uint32_t TRI_col_type_t; /// /// There are the following locks: /// -/// @CODE{TRI_vocbase_t._lock}: This lock protects the access to _collections, +/// @LIT{TRI_vocbase_t._lock}: This lock protects the access to _collections, /// _collectionsByName, and _collectionsById. /// -/// @CODE{TRI_vocbase_col_t._lock}: This lock protects the status (loaded, +/// @LIT{TRI_vocbase_col_t._lock}: This lock protects the status (loaded, /// unloaded) of the collection. If you want to use a collection, you must call /// @ref TRI_UseCollectionVocBase, this will either load or manifest the /// collection and a read-lock is held when the functions returns. You must diff --git a/config/generateErrorfile.py b/config/generateErrorfile.py index 31dfa9db77..42e80f6a60 100644 --- a/config/generateErrorfile.py +++ b/config/generateErrorfile.py @@ -86,7 +86,7 @@ def genCHeaderFile(errors): for e in errors: wiki = wiki\ - + "/// - " + e[1] + ": @CODE{" + e[2].replace("%", "\%").replace("<", "\<").replace(">", "\>") + "}\n"\ + + "/// - " + e[1] + ": @LIT{" + e[2].replace("%", "\%").replace("<", "\<").replace(">", "\>") + "}\n"\ + wrap(e[3], 80, 0, 0, "/// ") + "\n" wiki = wiki\ diff --git a/html/admin/js/modules/simple-query-basics.js b/html/admin/js/modules/simple-query-basics.js index 10c326a9d7..13fe73d9e7 100644 --- a/html/admin/js/modules/simple-query-basics.js +++ b/html/admin/js/modules/simple-query-basics.js @@ -324,7 +324,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 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 diff --git a/lib/ApplicationServer/ApplicationServer.h b/lib/ApplicationServer/ApplicationServer.h index ac1d30ed63..7217f2ad67 100644 --- a/lib/ApplicationServer/ApplicationServer.h +++ b/lib/ApplicationServer/ApplicationServer.h @@ -341,12 +341,12 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief program options /// -/// @CMDOPT{--help} +/// @CMDOPT{\--help} /// /// @CMDOPT{-h} /// /// Prints a list of the most common options available and then -/// exits. In order to see all options use @CODE{\-\-help-all}. +/// exits. In order to see all options use @LIT{\-\-help-all}. //////////////////////////////////////////////////////////////////////////////// basics::ProgramOptions _options; @@ -409,7 +409,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief version of the application /// -/// @CMDOPT{--version} +/// @CMDOPT{\--version} /// /// @CMDOPT{-v} /// @@ -421,23 +421,23 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief config file /// -/// @CMDOPT{--configuration @CA{filename}} +/// @CMDOPT{\--configuration @CA{filename}} /// /// @CMDOPT{-c @CA{filename}} /// /// Specifies the name of the configuration file to use. /// /// If this command is not passed to the server, then by default, the server -/// will attempt to first locate a file named @CODE{~/SERVER/SERVER.conf} in the +/// will attempt to first locate a file named @LIT{~/SERVER/SERVER.conf} in the /// user's home directory, where @CA{SERVER} is the name of the corresponding /// server. /// /// If no such file is found, the server will proceed to look for a file -/// @CODE{/etc/SERVER.conf} in the system configuration directory. The default +/// @LIT{/etc/SERVER.conf} in the system configuration directory. The default /// installation specifies the system configuration directory as /// /etc. Therefore, in case that no configuration file is found in the user's /// home directory, the server will proceed to look for a file named -/// @CODE{/etc/SERVER.conf}. +/// @LIT{/etc/SERVER.conf}. /// /// Only command line options with a value should be set within the /// configuration file. Command line options which act as flags should be @@ -473,7 +473,7 @@ namespace triagens { /// /// @verbinclude conf5 /// -/// when starting up the server. Note that, the word @CODE{none} is +/// when starting up the server. Note that, the word @LIT{none} is /// case-insensitive. //////////////////////////////////////////////////////////////////////////////// @@ -500,7 +500,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief the user id to use for the process /// -/// @CMDOPT{--uid @CA{uid}} +/// @CMDOPT{\--uid @CA{uid}} /// /// The name (identity) of the user the server will run as. If this parameter is /// not specified, the server will not attempt to change its UID, so that the @@ -534,7 +534,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief the group id to use for the process /// -/// @CMDOPT{--gid @CA{gid}} +/// @CMDOPT{\--gid @CA{gid}} /// /// The name (identity) of the group the server will run as. If this parameter /// is not specified, then the server will not attempt to change its GID, so @@ -564,7 +564,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log application name /// -/// @CMDOPT{--log.application @CA{name}} +/// @CMDOPT{\--log.application @CA{name}} /// /// Specifies the @CA{name} of the application which should be logged if this item of /// information is to be logged. @@ -575,7 +575,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log host name /// -/// @CMDOPT{--log.hostname @CA{name}} +/// @CMDOPT{\--log.hostname @CA{name}} /// /// Specifies the @CA{name} of the operating environment (the "hostname") which /// should be logged if this item of information is to be logged. Note that @@ -587,7 +587,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log facility /// -/// @CMDOPT{--log.facility @CA{name}} +/// @CMDOPT{\--log.facility @CA{name}} /// /// Specifies the name of the server instance which should be logged if this /// item of information is to be logged. @@ -598,9 +598,9 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log level /// -/// @CMDOPT{--log.level @CA{level}} +/// @CMDOPT{\--log.level @CA{level}} /// -/// @CMDOPT{--log @CA{level}} +/// @CMDOPT{\--log @CA{level}} /// /// Allows the user to choose the level of information which is logged by the /// server. The argument @CA{level} is specified as a string and can be one of @@ -670,7 +670,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log format /// -/// @CMDOPT{--log.format @CA{format}} +/// @CMDOPT{\--log.format @CA{format}} /// /// @copydetails triagens::basics::Logger::setLogFormat //////////////////////////////////////////////////////////////////////////////// @@ -680,7 +680,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log severity /// -/// @CMDOPT{--log.severity @CA{severity}} +/// @CMDOPT{\--log.severity @CA{severity}} /// /// This parameter provides a set of standard log severities which can be /// used. The currently accepted @CA{severities} are: @@ -701,7 +701,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log level /// -/// @CMDOPT{--log.file @CA{filename}} +/// @CMDOPT{\--log.file @CA{filename}} /// /// This option allows the user to specify the name of a file to which /// information is logged. By default, if no log file is specified, the standard @@ -719,7 +719,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log prefix /// -/// @CMDOPT{--log.prefix @CA{prefix}} +/// @CMDOPT{\--log.prefix @CA{prefix}} /// /// This option is used specify an prefix to logged text. //////////////////////////////////////////////////////////////////////////////// @@ -729,7 +729,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log level /// -/// @CMDOPT{--log.syslog @CA{arg}} +/// @CMDOPT{\--log.syslog @CA{arg}} /// /// If this option is set, then in addition to output being directed to the /// standard output (or to a specified file, in the case that the command line @@ -750,7 +750,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log thread identifier /// -/// @CMDOPT{--log.thread} +/// @CMDOPT{\--log.thread} /// /// Whenever log output is generated, the process ID is written as part of the /// log information. Setting this option appends the thread id of the calling @@ -770,7 +770,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log line number /// -/// @CMDOPT{--log.line-number} +/// @CMDOPT{\--log.line-number} /// /// Normally, if an human readable fatal, error, warning or info message is /// logged, no information about the file and line number is provided. The file @@ -783,7 +783,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief log filter /// -/// @CMDOPT{--log.filter @CA{arg}} +/// @CMDOPT{\--log.filter @CA{arg}} /// /// For debug and trace messages, only log those messages occurring in the /// file @CA{arg}. @@ -794,7 +794,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief random number generator to use /// -/// @CMDOPT{--random.generator @CA{arg}} +/// @CMDOPT{\--random.generator @CA{arg}} /// /// The argument is an integer (1,2,3 or 4) which sets the manner in which /// random numbers are generated. The default method (3) is to use the a @@ -805,7 +805,7 @@ namespace triagens { /// algorithm. Algorithm 4 is a combination of the blocking random number /// generator and the Mersenne Twister. /// -/// @CMDOPT{--random.no-seed} +/// @CMDOPT{\--random.no-seed} /// /// By default, the random generator is seeded. Setting this option causes the /// random number generator not to be seeded. (Seeding the random number diff --git a/lib/BasicsC/voc-errors.h b/lib/BasicsC/voc-errors.h index 92e7d738d7..b7931ff832 100644 --- a/lib/BasicsC/voc-errors.h +++ b/lib/BasicsC/voc-errors.h @@ -11,295 +11,295 @@ extern "C" { /// /// The following errors might be raised when running ArangoDB: /// -/// - 0: @CODE{no error} +/// - 0: @LIT{no error} /// No error has occurred. -/// - 1: @CODE{failed} +/// - 1: @LIT{failed} /// Will be raised when a general error occurred. -/// - 2: @CODE{system error} +/// - 2: @LIT{system error} /// Will be raised when operating system error occurred. -/// - 3: @CODE{out of memory} +/// - 3: @LIT{out of memory} /// Will be raised when there is a memory shortage. -/// - 4: @CODE{internal error} +/// - 4: @LIT{internal error} /// Will be raised when an internal error occurred. -/// - 5: @CODE{illegal number} +/// - 5: @LIT{illegal number} /// Will be raised when an illegal representation of a number was given. -/// - 6: @CODE{numeric overflow} +/// - 6: @LIT{numeric overflow} /// Will be raised when a numeric overflow occurred. -/// - 7: @CODE{illegal option} +/// - 7: @LIT{illegal option} /// Will be raised when an unknown option was supplied by the user. -/// - 8: @CODE{dead process identifier} +/// - 8: @LIT{dead process identifier} /// Will be raised when a PID without a living process was found. -/// - 9: @CODE{not implemented} +/// - 9: @LIT{not implemented} /// Will be raised when hitting an unimplemented feature. -/// - 10: @CODE{bad parameter} +/// - 10: @LIT{bad parameter} /// Will be raised when the parameter does not fulfill the requirements. -/// - 11: @CODE{forbidden} +/// - 11: @LIT{forbidden} /// Will be raised when you are missing permission for the operation. -/// - 12: @CODE{out of memory in mmap} +/// - 12: @LIT{out of memory in mmap} /// Will be raised when there is a memory shortage. -/// - 13: @CODE{csv is corrupt} +/// - 13: @LIT{csv is corrupt} /// Will be raised when encountering a corrupt csv line. -/// - 400: @CODE{bad parameter} +/// - 400: @LIT{bad parameter} /// Will be raised when the HTTP request does not fulfill the requirements. -/// - 403: @CODE{forbidden} +/// - 403: @LIT{forbidden} /// Will be raised when the operation is forbidden. -/// - 404: @CODE{not found} +/// - 404: @LIT{not found} /// Will be raised when an URI is unknown. -/// - 405: @CODE{method not supported} +/// - 405: @LIT{method not supported} /// Will be raised when an unsupported HTTP method is used for an operation. -/// - 500: @CODE{internal server error} +/// - 500: @LIT{internal server error} /// Will be raised when an internal server is encountered. -/// - 600: @CODE{invalid JSON object} +/// - 600: @LIT{invalid JSON object} /// Will be raised when a string representation of a JSON object is corrupt. -/// - 601: @CODE{superfluous URL suffices} +/// - 601: @LIT{superfluous URL suffices} /// Will be raised when the URL contains superfluous suffices. -/// - 1000: @CODE{illegal state} +/// - 1000: @LIT{illegal state} /// Internal error that will be raised when the datafile is not in the /// required state. -/// - 1001: @CODE{illegal shaper} +/// - 1001: @LIT{illegal shaper} /// Internal error that will be raised when the shaper encountered a porblem. -/// - 1002: @CODE{datafile sealed} +/// - 1002: @LIT{datafile sealed} /// Internal error that will be raised when trying to write to a datafile. -/// - 1003: @CODE{unknown type} +/// - 1003: @LIT{unknown type} /// Internal error that will be raised when an unknown collection type is /// encountered. -/// - 1004: @CODE{ready only} +/// - 1004: @LIT{ready only} /// Internal error that will be raised when trying to write to a read-only /// datafile or collection. -/// - 1005: @CODE{duplicate identifier} +/// - 1005: @LIT{duplicate identifier} /// Internal error that will be raised when a identifier duplicate is /// detected. -/// - 1006: @CODE{datafile unreadable} +/// - 1006: @LIT{datafile unreadable} /// Internal error that will be raised when the datafile is unreadable. -/// - 1100: @CODE{corrupted datafile} +/// - 1100: @LIT{corrupted datafile} /// Will be raised when a corruption is detected in a datafile. -/// - 1101: @CODE{illegal parameter file} +/// - 1101: @LIT{illegal parameter file} /// Will be raised if a parameter file is corrupted. -/// - 1102: @CODE{corrupted collection} +/// - 1102: @LIT{corrupted collection} /// Will be raised when a collection contains one or more corrupted datafiles. -/// - 1103: @CODE{mmap failed} +/// - 1103: @LIT{mmap failed} /// Will be raised when the system call mmap failed. -/// - 1104: @CODE{filesystem full} +/// - 1104: @LIT{filesystem full} /// Will be raised when the filesystem is full. -/// - 1105: @CODE{no journal} +/// - 1105: @LIT{no journal} /// Will be raised when a journal cannot be created. -/// - 1106: @CODE{cannot create/rename datafile because it already exists} +/// - 1106: @LIT{cannot create/rename datafile because it already exists} /// Will be raised when the datafile cannot be created or renamed because a /// file of the same name already exists. -/// - 1107: @CODE{database is locked} +/// - 1107: @LIT{database is locked} /// Will be raised when the database is locked by a different process. -/// - 1108: @CODE{cannot create/rename collection because directory already exists} +/// - 1108: @LIT{cannot create/rename collection because directory already exists} /// Will be raised when the collection cannot be created because a directory /// of the same name already exists. -/// - 1200: @CODE{conflict} +/// - 1200: @LIT{conflict} /// Will be raised when updating or deleting a document and a conflict has /// been detected. -/// - 1201: @CODE{wrong path for database} +/// - 1201: @LIT{wrong path for database} /// Will be raised when a non-existing directory was specified as path for /// the database. -/// - 1202: @CODE{document not found} +/// - 1202: @LIT{document not found} /// Will be raised when a document with a given identifier or handle is /// unknown. -/// - 1203: @CODE{collection not found} +/// - 1203: @LIT{collection not found} /// Will be raised when a collection with a given identifier or name is /// unknown. -/// - 1204: @CODE{parameter 'collection' not found} +/// - 1204: @LIT{parameter 'collection' not found} /// Will be raised when the collection parameter is missing. -/// - 1205: @CODE{illegal document handle} +/// - 1205: @LIT{illegal document handle} /// Will be raised when a document handle is corrupt. -/// - 1206: @CODE{maixmal size of journal too small} +/// - 1206: @LIT{maixmal size of journal too small} /// Will be raised when the maximal size of the journal is too small. -/// - 1207: @CODE{duplicate name} +/// - 1207: @LIT{duplicate name} /// Will be raised when a name duplicate is detected. -/// - 1208: @CODE{illegal name} +/// - 1208: @LIT{illegal name} /// Will be raised when an illegal name is detected. -/// - 1209: @CODE{no suitable index known} +/// - 1209: @LIT{no suitable index known} /// Will be raised when no suitable index for the query is known. -/// - 1210: @CODE{unique constraint violated} +/// - 1210: @LIT{unique constraint violated} /// Will be raised when there is a unique constraint violation. -/// - 1211: @CODE{geo index violated} +/// - 1211: @LIT{geo index violated} /// Will be raised when a illegale coordinate is used. -/// - 1212: @CODE{index not found} +/// - 1212: @LIT{index not found} /// Will be raised when an index with a given identifier is unknown. -/// - 1213: @CODE{cross collection request not allowed} +/// - 1213: @LIT{cross collection request not allowed} /// Will be raised when a cross-collection is requested. -/// - 1214: @CODE{illegal index handle} +/// - 1214: @LIT{illegal index handle} /// Will be raised when a index handle is corrupt. -/// - 1215: @CODE{cap constraint already defined} +/// - 1215: @LIT{cap constraint already defined} /// Will be raised when a cap constraint was already defined. -/// - 1216: @CODE{document too large} +/// - 1216: @LIT{document too large} /// Will be raised when the document cannot fit into any datafile because of /// it is too large. -/// - 1217: @CODE{collection must be unloaded} +/// - 1217: @LIT{collection must be unloaded} /// Will be raised when a collection should be unloaded, but has a different /// status. -/// - 1218: @CODE{collection type invalid} +/// - 1218: @LIT{collection type invalid} /// Will be raised when an invalid collection type is used in a request. -/// - 1300: @CODE{datafile full} +/// - 1300: @LIT{datafile full} /// Will be raised when the datafile reaches its limit. -/// - 1500: @CODE{query killed} +/// - 1500: @LIT{query killed} /// Will be raised when a running query is killed by an explicit admin /// command. -/// - 1501: @CODE{\%s} +/// - 1501: @LIT{\%s} /// Will be raised when query is parsed and is found to be syntactially /// invalid. -/// - 1502: @CODE{query is empty} +/// - 1502: @LIT{query is empty} /// Will be raised when an empty query is specified. -/// - 1503: @CODE{runtime error '\%s'} +/// - 1503: @LIT{runtime error '\%s'} /// Will be raised when a runtime error is caused by the query. -/// - 1504: @CODE{number out of range} +/// - 1504: @LIT{number out of range} /// Will be raised when a number is outside the expected range. -/// - 1510: @CODE{variable name '\%s' has an invalid format} +/// - 1510: @LIT{variable name '\%s' has an invalid format} /// Will be raised when an invalid variable name is used. -/// - 1511: @CODE{variable '\%s' is assigned multiple times} +/// - 1511: @LIT{variable '\%s' is assigned multiple times} /// Will be raised when a variable gets re-assigned in a query. -/// - 1512: @CODE{unknown variable '\%s'} +/// - 1512: @LIT{unknown variable '\%s'} /// Will be raised when an unknown variable is used or the variable is /// undefined the context it is used. -/// - 1520: @CODE{unable to open collection '\%s'} +/// - 1520: @LIT{unable to open collection '\%s'} /// Will be raised when one of the collections referenced in the query was /// not found. -/// - 1521: @CODE{unable to read-lock collection \%s} +/// - 1521: @LIT{unable to read-lock collection \%s} /// Will be raised when a read lock on the collection cannot be acquired. -/// - 1522: @CODE{too many collections} +/// - 1522: @LIT{too many collections} /// Will be raised when the number of collections in a query is beyond the /// allowed value. -/// - 1530: @CODE{document attribute '\%s' is assigned multiple times} +/// - 1530: @LIT{document attribute '\%s' is assigned multiple times} /// Will be raised when a document attribute is re-assigned. -/// - 1540: @CODE{usage of unknown function '\%s'} +/// - 1540: @LIT{usage of unknown function '\%s'} /// Will be raised when an undefined function is called. -/// - 1541: @CODE{invalid number of arguments for function '\%s'} +/// - 1541: @LIT{invalid number of arguments for function '\%s'} /// Will be raised when the number of arguments used in a function call does /// not match the expected number of arguments for the function. -/// - 1542: @CODE{invalid argument type used in call to function '\%s()'} +/// - 1542: @LIT{invalid argument type used in call to function '\%s()'} /// Will be raised when the type of an argument used in a function call does /// not match the expected argument type. -/// - 1550: @CODE{invalid structure of bind parameters} +/// - 1550: @LIT{invalid structure of bind parameters} /// Will be raised when the structure of bind parameters passed has an /// unexpected format. -/// - 1551: @CODE{no value specified for declared bind parameter '\%s'} +/// - 1551: @LIT{no value specified for declared bind parameter '\%s'} /// Will be raised when a bind parameter was declared in the query but the /// query is being executed with no value for that parameter. -/// - 1552: @CODE{bind parameter '\%s' was not declared in the query} +/// - 1552: @LIT{bind parameter '\%s' was not declared in the query} /// Will be raised when a value gets specified for an undeclared bind /// parameter. -/// - 1553: @CODE{bind parameter '\%s' has an invalid value or type} +/// - 1553: @LIT{bind parameter '\%s' has an invalid value or type} /// Will be raised when a bind parameter has an invalid value or type. -/// - 1560: @CODE{invalid logical value} +/// - 1560: @LIT{invalid logical value} /// Will be raised when a non-boolean value is used in a logical operation. -/// - 1561: @CODE{invalid arithmetic value} +/// - 1561: @LIT{invalid arithmetic value} /// Will be raised when a non-numeric value is used in an arithmetic /// operation. -/// - 1562: @CODE{division by zero} +/// - 1562: @LIT{division by zero} /// Will be raised when there is an attempt to divide by zero. -/// - 1563: @CODE{list expected} +/// - 1563: @LIT{list expected} /// Will be raised when a non-list operand is used for an operation that /// expects a list argument operand. -/// - 1569: @CODE{FAIL(\%s) called} +/// - 1569: @LIT{FAIL(\%s) called} /// Will be raised when the function FAIL() is called from inside a query. -/// - 1570: @CODE{no suitable geo index found for geo restriction on '\%s'} +/// - 1570: @LIT{no suitable geo index found for geo restriction on '\%s'} /// Will be raised when a geo restriction was specified but no suitable geo /// index is found to resolve it. -/// - 1600: @CODE{cursor not found} +/// - 1600: @LIT{cursor not found} /// Will be raised when a cursor is requested via its id but a cursor with /// that id cannot be found. -/// - 1800: @CODE{invalid key declaration} +/// - 1800: @LIT{invalid key declaration} /// Will be raised when an invalid key specification is passed to the server -/// - 1801: @CODE{key already exists} +/// - 1801: @LIT{key already exists} /// Will be raised when a key is to be created that already exists -/// - 1802: @CODE{key not found} +/// - 1802: @LIT{key not found} /// Will be raised when the specified key is not found -/// - 1803: @CODE{key is not unique} +/// - 1803: @LIT{key is not unique} /// Will be raised when the specified key is not unique -/// - 1804: @CODE{key value not changed} +/// - 1804: @LIT{key value not changed} /// Will be raised when updating the value for a key does not work -/// - 1805: @CODE{key value not removed} +/// - 1805: @LIT{key value not removed} /// Will be raised when deleting a key/value pair does not work -/// - 1806: @CODE{missing value} +/// - 1806: @LIT{missing value} /// Will be raised when the value is missing -/// - 1901: @CODE{invalid graph} +/// - 1901: @LIT{invalid graph} /// Will be raised when an invalid name is passed to the server -/// - 1902: @CODE{could not create graph} +/// - 1902: @LIT{could not create graph} /// Will be raised when an invalid name, vertices or edges is passed to the /// server -/// - 1903: @CODE{invalid vertex} +/// - 1903: @LIT{invalid vertex} /// Will be raised when an invalid vertex id is passed to the server -/// - 1904: @CODE{could not create vertex} +/// - 1904: @LIT{could not create vertex} /// Will be raised when the vertex could not be created -/// - 1905: @CODE{could not change vertex} +/// - 1905: @LIT{could not change vertex} /// Will be raised when the vertex could not be changed -/// - 1906: @CODE{invalid edge} +/// - 1906: @LIT{invalid edge} /// Will be raised when an invalid edge id is passed to the server -/// - 1907: @CODE{could not create edge} +/// - 1907: @LIT{could not create edge} /// Will be raised when the edge could not be created -/// - 1908: @CODE{could not change edge} +/// - 1908: @LIT{could not change edge} /// Will be raised when the edge could not be changed -/// - 2000: @CODE{unknown client error} +/// - 2000: @LIT{unknown client error} /// This error should not happen. -/// - 2001: @CODE{could not connect to server} +/// - 2001: @LIT{could not connect to server} /// Will be raised when the client could not connect to the server. -/// - 2002: @CODE{could not write to server} +/// - 2002: @LIT{could not write to server} /// Will be raised when the client could not write data. -/// - 2003: @CODE{could not read from server} +/// - 2003: @LIT{could not read from server} /// Will be raised when the client could not read data. -/// - 3100: @CODE{priority queue insert failure} +/// - 3100: @LIT{priority queue insert failure} /// Will be raised when an attempt to insert a document into a priority queue /// index fails for some reason. -/// - 3110: @CODE{priority queue remove failure} +/// - 3110: @LIT{priority queue remove failure} /// Will be raised when an attempt to remove a document from a priority queue /// index fails for some reason. -/// - 3111: @CODE{priority queue remove failure - item missing in index} +/// - 3111: @LIT{priority queue remove failure - item missing in index} /// Will be raised when an attempt to remove a document from a priority queue /// index fails when document can not be located within the index. -/// - 3312: @CODE{(non-unique) hash index insert failure - document duplicated in index} +/// - 3312: @LIT{(non-unique) hash index insert failure - document duplicated in index} /// Will be raised when an attempt to insert a document into a non-unique /// hash index fails due to the fact that document is duplicated within that /// index. -/// - 3313: @CODE{(non-unique) skiplist index insert failure - document duplicated in index} +/// - 3313: @LIT{(non-unique) skiplist index insert failure - document duplicated in index} /// Will be raised when an attempt to insert a document into a non-unique /// skiplist index fails due to the fact that document is duplicated within /// that index. -/// - 3200: @CODE{hash index insertion warning - attribute missing in document} +/// - 3200: @LIT{hash index insertion warning - attribute missing in document} /// Will be raised when an attempt to insert a document into a hash index is /// caused by the document not having one or more attributes which are /// required by the hash index. -/// - 3202: @CODE{hash index update warning - attribute missing in revised document} +/// - 3202: @LIT{hash index update warning - attribute missing in revised document} /// Will be raised when an attempt to update a document results in the /// revised document not having one or more attributes which are required by /// the hash index. -/// - 3211: @CODE{hash index remove failure - item missing in index} +/// - 3211: @LIT{hash index remove failure - item missing in index} /// Will be raised when an attempt to remove a document from a hash index /// fails when document can not be located within that index. -/// - 3300: @CODE{skiplist index insertion warning - attribute missing in document} +/// - 3300: @LIT{skiplist index insertion warning - attribute missing in document} /// Will be raised when an attempt to insert a document into a skiplist index /// is caused by in the document not having one or more attributes which are /// required by the skiplist index. -/// - 3302: @CODE{skiplist index update warning - attribute missing in revised document} +/// - 3302: @LIT{skiplist index update warning - attribute missing in revised document} /// Will be raised when an attempt to update a document results in the /// revised document not having one or more attributes which are required by /// the skiplist index. -/// - 3311: @CODE{skiplist index remove failure - item missing in index} +/// - 3311: @LIT{skiplist index remove failure - item missing in index} /// Will be raised when an attempt to remove a document from a skiplist index /// fails when document can not be located within that index. -/// - 3400: @CODE{bitarray index insertion warning - attribute missing in document} +/// - 3400: @LIT{bitarray index insertion warning - attribute missing in document} /// Will be raised when an attempt to insert a document into a bitarray index /// is caused by in the document not having one or more attributes which are /// required by the bitarray index. -/// - 3402: @CODE{bitarray index update warning - attribute missing in revised document} +/// - 3402: @LIT{bitarray index update warning - attribute missing in revised document} /// Will be raised when an attempt to update a document results in the /// revised document not having one or more attributes which are required by /// the bitarray index. -/// - 3411: @CODE{bitarray index remove failure - item missing in index} +/// - 3411: @LIT{bitarray index remove failure - item missing in index} /// Will be raised when an attempt to remove a document from a bitarray index /// fails when document can not be located within that index. -/// - 3413: @CODE{bitarray index insert failure - document attribute value unsupported in index} +/// - 3413: @LIT{bitarray index insert failure - document attribute value unsupported in index} /// Will be raised when an attempt to insert a document into a bitarray index /// fails due to the fact that one or more values for an index attribute is /// not supported within that index. -/// - 3415: @CODE{bitarray index creation failure - one or more index attributes are duplicated.} +/// - 3415: @LIT{bitarray index creation failure - one or more index attributes are duplicated.} /// Will be raised when an attempt to create an index with two or more index /// attributes repeated. -/// - 3417: @CODE{bitarray index creation failure - one or more index attribute values are duplicated.} +/// - 3417: @LIT{bitarray index creation failure - one or more index attribute values are duplicated.} /// Will be raised when an attempt to create an index with two or more index /// attribute values repeated. //////////////////////////////////////////////////////////////////////////////// diff --git a/lib/HttpServer/ApplicationEndpointServer.h b/lib/HttpServer/ApplicationEndpointServer.h index fe8faab125..09b4b6bfd8 100644 --- a/lib/HttpServer/ApplicationEndpointServer.h +++ b/lib/HttpServer/ApplicationEndpointServer.h @@ -271,7 +271,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief endpoints for client HTTP requests /// -/// @CMDOPT{--server.endpoint @CA{endpoint}} +/// @CMDOPT{\--server.endpoint @CA{endpoint}} /// /// Specifies an @CA{endpoint} for HTTP requests by clients. Endpoints have /// the following pattern: @@ -299,7 +299,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief disable authentication for ALL client requests /// -/// @CMDOPT{--server.disable-authentication @CA{value}} +/// @CMDOPT{\--server.disable-authentication @CA{value}} /// /// Setting @CA{value} to true will turn off authentication on the server side /// so all clients can execute any action without authorisation and privilege @@ -313,7 +313,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief timeout for HTTP keep-alive /// -/// @CMDOPT{--server.keep-alive-timeout} +/// @CMDOPT{\--server.keep-alive-timeout} /// /// Allows to specify the timeout for HTTP keep-alive connections. The timeout /// value must be specified in seconds. @@ -327,7 +327,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief listen backlog size /// -/// @CMDOPT{--server.backlog-size} +/// @CMDOPT{\--server.backlog-size} /// /// Allows to specify the size of the backlog for the listen system call /// The default value is 10. The maximum value is platform-dependent. @@ -338,7 +338,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief keyfile containing server certificate /// -/// @CMDOPT{--server.keyfile @CA{filename}} +/// @CMDOPT{\--server.keyfile @CA{filename}} /// /// If SSL encryption is used, this option must be used to specify the filename /// of the server private key. The file must be PEM formatted and contain both @@ -367,7 +367,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief CA file /// -/// @CMDOPT{--server.cafile @CA{filename}} +/// @CMDOPT{\--server.cafile @CA{filename}} /// /// This option can be used to specify a file with CA certificates that are sent /// to the client whenever the server requests a client certificate. If the @@ -385,7 +385,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief SSL protocol type to use /// -/// @CMDOPT{--server.ssl-protocol @CA{value}} +/// @CMDOPT{\--server.ssl-protocol @CA{value}} /// /// Use this option to specify the default encryption protocol to be used. /// The following variants are available: @@ -404,7 +404,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief whether or not to use SSL session caching /// -/// @CMDOPT{--server.ssl-cache @CA{value}} +/// @CMDOPT{\--server.ssl-cache @CA{value}} /// /// Set to true if SSL session caching should be used. /// @@ -419,7 +419,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief ssl options to use /// -/// @CMDOPT{--server.ssl-options @CA{value}} +/// @CMDOPT{\--server.ssl-options @CA{value}} /// /// This option can be used to set various SSL-related options. Individual /// option values must be combined using bitwise OR. @@ -441,7 +441,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief ssl cipher list to use /// -/// @CMDOPT{--server.ssl-cipher-list @CA{cipher-list}} +/// @CMDOPT{\--server.ssl-cipher-list @CA{cipher-list}} /// /// This option can be used to restrict the server to certain SSL ciphers only, /// and to define the relative usage preference of SSL ciphers. diff --git a/lib/Rest/AnyServer.h b/lib/Rest/AnyServer.h index c20de94919..dcc154bfcd 100644 --- a/lib/Rest/AnyServer.h +++ b/lib/Rest/AnyServer.h @@ -168,11 +168,11 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief pid file /// -/// @CMDOPT{--pid-file @CA{filename}} +/// @CMDOPT{\--pid-file @CA{filename}} /// /// The name of the process ID file to use when running the server as a -/// daemon. This parameter must be specified if either the flag @CODE{daemon} or -/// @CODE{supervisor} is set. +/// daemon. This parameter must be specified if either the flag @LIT{daemon} or +/// @LIT{supervisor} is set. //////////////////////////////////////////////////////////////////////////////// string _pidFile; diff --git a/lib/Scheduler/ApplicationScheduler.h b/lib/Scheduler/ApplicationScheduler.h index dfded23a85..0bc7c66b49 100644 --- a/lib/Scheduler/ApplicationScheduler.h +++ b/lib/Scheduler/ApplicationScheduler.h @@ -269,7 +269,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief number of scheduler threads /// -/// @CMDOPT{--scheduler.threads @CA{arg}} +/// @CMDOPT{\--scheduler.threads @CA{arg}} /// /// An integer argument which sets the number of threads to use in the IO /// scheduler. The default is 1. @@ -280,7 +280,7 @@ namespace triagens { //////////////////////////////////////////////////////////////////////////////// /// @brief scheduler backend /// -/// @CMDOPT{--scheduler.backend @CA{arg}} +/// @CMDOPT{\--scheduler.backend @CA{arg}} /// /// The I/O method used by the event handler. The default (if this option is /// not specified) is to try all recommended backends. This is platform diff --git a/lib/V8/v8-shell.cpp b/lib/V8/v8-shell.cpp index 0dc4254b26..e3b8e612a7 100644 --- a/lib/V8/v8-shell.cpp +++ b/lib/V8/v8-shell.cpp @@ -110,9 +110,9 @@ static void ProcessCsvEnd (TRI_csv_parser_t* parser, char const* field, size_t r /// @FUN{processCsvFile(@FA{filename}, @FA{callback})} /// /// Processes a CSV file. The @FA{callback} function is called for line in the -/// file. The seperator is @CODE{\,} and the quote is @CODE{"}. +/// file. The seperator is @LIT{\,} and the quote is @LIT{"}. /// -/// Create the input file @CODE{csv.txt} +/// Create the input file @LIT{csv.txt} /// /// @verbinclude fluent48 /// @@ -124,7 +124,7 @@ static void ProcessCsvEnd (TRI_csv_parser_t* parser, char const* field, size_t r /// /// Processes a CSV file. The @FA{callback} function is called for line in the /// file. The @FA{options} argument must be an object. The value of -/// @CODE{seperator} sets the seperator character and @CODE{quote} the quote +/// @LIT{seperator} sets the seperator character and @LIT{quote} the quote /// character. //////////////////////////////////////////////////////////////////////////////// @@ -232,7 +232,7 @@ static v8::Handle JS_ProcessCsvFile (v8::Arguments const& argv) { /// Processes a JSON file. The file must contain the JSON objects each on its /// own line. The @FA{callback} function is called for each object. /// -/// Create the input file @CODE{json.txt} +/// Create the input file @LIT{json.txt} /// /// @verbinclude fluent49 ///