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

fixed documentation again

This commit is contained in:
Frank Celler 2012-11-21 17:42:13 +01:00
parent e845b0f776
commit cccb3511c5
27 changed files with 948 additions and 1141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/Makefile.files
View File

@ -153,8 +153,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 @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/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/images/* Doxygen/doc/images
cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/doc cp -R @top_srcdir@/Documentation/arangodb.css Doxygen/doc

6
Documentation/Manual/FirstStepsArangoDB.md
View File

@ -44,7 +44,7 @@ For more in-depth information
- @EXTREF_S{http://vimeo.com/36411892,watch the video} - Martin Schoenert, - @EXTREF_S{http://vimeo.com/36411892,watch the video} - Martin Schoenert,
architect of ArangoDB, gives an introduction of what the ArangoDB project architect of ArangoDB, gives an introduction of what the ArangoDB project
is about 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} Getting Familiar with ArangoDB {#FirstStepsArangoDBServerStart}
=============================================================== ===============================================================
@ -373,7 +373,7 @@ CommandLineArango "here".
@copydetails triagens::rest::ApplicationServer::_options @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 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 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 @copydetails triagens::rest::ApplicationEndpointServer::_keepAliveTimeout
@CMDOPT{--daemon} @CMDOPT{\--daemon}
Runs the server as a daemon (as a background process). Runs the server as a daemon (as a background process).

4
Documentation/Scripts/html2html.sh
View File

@ -37,8 +37,8 @@ if test "x$FULL_HTML" == "x0"; then
HEADER="" HEADER=""
FOOTER="" FOOTER=""
else else
HEADER='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><title>ArangoDB: About ArangoDB</title><link rel="stylesheet" type="text/css" href="arangodb.css"></head><body><div>' HEADER='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><title>ArangoDB: About ArangoDB</title></head><body><div id="content"><div class="offlineview"><div>'
FOOTER='</body></html>' FOOTER='</div></div></body></html>'
fi fi
rm -f $OUTPUT.tmp rm -f $OUTPUT.tmp

70
Documentation/arango.template.in
View File

@ -197,48 +197,56 @@ TAB_SIZE = 8
# function definition # function definition
ALIASES = \ ALIASES = \
"FUN{1}=@latexonly\functionsignature{\1}@endlatexonly@htmlonly<div class=\"functionsignature\">\1</div>@endhtmlonly" \ "FUN{1}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FUN{2}=@latexonly\functionsignature{\1, \2}@endlatexonly@htmlonly<div class=\"functionsignature\">\1, \2</div>@endhtmlonly" \ "FUN{2}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FUN{3}=@latexonly\functionsignature{\1, \2, \3}@endlatexonly@htmlonly<div class=\"functionsignature\">\1, \2, \3</div>@endhtmlonly" \ "FUN{3}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FUN{4}=@latexonly\functionsignature{\1, \2, \3, \4}@endlatexonly@htmlonly<div class=\"functionsignature\">\1, \2, \3, \4</div>@endhtmlonly" \ "FUN{4}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FUN{5}=@latexonly\functionsignature{\1, \2, \3, \4, \5}@endlatexonly@htmlonly<div class=\"functionsignature\">\1, \2, \3, \4, \5</div>@endhtmlonly" \ "FUN{5}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4, \5@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FUN{6}=@latexonly\functionsignature{\1, \2, \3, \4, \5, \6}@endlatexonly@htmlonly<div class=\"functionsignature\">\1, \2, \3, \4, \5, \6</div>@endhtmlonly" \ "FUN{6}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4, \5, \6@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FUN{7}=@latexonly\functionsignature{\1, \2, \3, \4, \5, \6, \7}@endlatexonly@htmlonly<div class=\"functionsignature\">\1, \2, \3, \4, \5, \6, \7</div>@endhtmlonly" \ "FUN{7}=@latexonly\functionsignature{@endlatexonly@htmlonly<div class=\"functionsignature\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1, \2, \3, \4, \5, \6, \7@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FA{1}=<em>\1</em>" \ "FA{1}=@latexonly\functionargument{@endlatexonly@htmlonly<span class=\"functionargument\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</span>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"FN{1}=<tt>\1</tt>" "FN{1}=@latexonly\functionname{@endlatexonly@htmlonly<span class=\"functionname\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</span>@endhtmlonly@xmlonly XMLMISSING @endxmlonly"
# command line option # command line option
ALIASES += \ ALIASES += \
"CMDOPT{1}=@latexonly\commandlineoption{\1}@endlatexonly@htmlonly<div class=\"commandlineoption\">\1</div>@endhtmlonly" \ "CMDOPT{1}=@latexonly\commandlineoption{@endlatexonly@htmlonly<div class=\"commandlineoption\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"CA{1}=<em>\1</em>" \ "CA{1}=@latexonly\commandlineargument{@endlatexonly@htmlonly<span class=\"commandlineargument\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</span>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"CO{1}=<tt>\1</tt>" "CO{1}=@latexonly\commandoption{@endlatexon\@htmlonly<span class=\"commandoption\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</span>@endhtmlonly@xmlonly XMLMISSING @endxmlonly"
# rest calls # rest calls
ALIASES += \ ALIASES += \
"RESTHEADER{2}=@latexonly\restheader{1 (\2)}@endlatexonly@htmlonly<div class=\"restheader\">\1 <div class=\"restheaderremark\">(\2)</div></div>@endhtmlonly" \ "RESTHEADER{2}=@latexonly\restheader{@endlatexonly@htmlonly<div class=\"restheader\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly,@endlatexonly@htmlonly<div class=\"restheaderremark\">(@endhtmlonly@xmlonly XMLMISSING @endxmlonly\2@latexonly}@endlatexonly@htmlonly)</div></div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly" \
"REST{1}=<tt><b>\1</b></tt>" "REST{1}=@latexonly\restcall{@endlatexonly@htmlonly<div class=\"restcall\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly"
# navigation
ALIASES += \
"NAVIGATE{3}=@htmlonly<div class=\"navigate\"><a href=\"\1.html\">prev</a> | <a href=\"\2.html\">home</a> | <a href=\"\3.html\">next</a></div>@endhtmlonly" \
"EMBEDTOC{1}=@if LATEX@else@htmlonly <div class=\"toc\">@endhtmlonly@copydoc \1\n@htmlonly</div>@endhtmlonly@endif"
# glossary
ALIASES += \
"GE{1}=@latexonly\glossaryentry{@endlatexonly@htmlonly<div class=\"glossaryentry\">@endhtmlonly@xmlonly XMLMISSING @endxmlonly\1@latexonly}@endlatexonly@htmlonly</div>@endhtmlonly@xmlonly XMLMISSING @endxmlonly"
# examples
ALIASES += \
"EXAMPLES=@htmlonly<div class=\"example\">Examples</div>@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<a href=\1>\2</a>@endif" \
"EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else<a href=\1>\2</a> @endif" \
"S_EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else <a href=\1>\2</a>@endif" \
"INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif"
# other aliases # other aliases
ALIASES += \ ALIASES += \
"VAR{1}=<tt>\1</tt>" \
"LIT{1}=<tt>\1</tt>" \
"CODE{1}=<tt>\1</tt>" \
"CODE{2}=<tt>\1, \2</tt>" \
"CODE{3}=<tt>\1, \2, \3</tt>" \
"GE{1}=<b>\1</b>" \
"EXAMPLES=@htmlonly<div class=\"example\">Examples</div>@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@" \ "VERSION=@PACKAGE_VERSION@" \
"NAVIGATE{3}=@htmlonly <div class=\"navigate\"><a href=\"\1.html\">prev</a> | <a href=\"\2.html\">home</a> | <a href=\"\3.html\">next</a></div>@endhtmlonly" \ "LIT{1}=<tt>\1</tt>" \
"EMBEDTOC{1}=@if LATEX@else@htmlonly <div class=\"toc\">@endhtmlonly@copydoc \1\n@htmlonly </div>@endhtmlonly@endif" \ "LIT{2}=<tt>\1, \2</tt>" \
"LIT{3}=<tt>\1, \2, \3</tt>" \
"LATEXBREAK=@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" \ "LATEXBREAK=@latexonly\vskip -0.5em\hskip 1.0em@endlatexonly" \
"EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else<a href= \1>\2</a>@endif" \
"EXTREF_S{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else<a href=\1>\2</a> @endif" \
"S_EXTREF{2}=@if LATEX \2 (see @latexonly \url{\1} @endlatexonly)@else <a href=\1>\2</a>@endif" \
"EXTRES{2}=@if LATEX \2 (see @latexonly \url{\1}@endlatexonly)@else&nbsp;<a href= \1>\2</a>@endif" \
"INTREF{2}=@if LATEX \2@else@ref \1 \"\2\"@endif" \
"SPC=&nbsp;" \
"CLEARPAGE=@if LATEX @latexonly\clearpage@endlatexonly@else\n@endif" "CLEARPAGE=@if LATEX @latexonly\clearpage@endlatexonly@else\n@endif"
# This tag can be used to specify a number of word-keyword mappings (TCL only). # This tag can be used to specify a number of word-keyword mappings (TCL only).

79
Documentation/arangodb.css
View File

@ -3,15 +3,70 @@
padding: 14px 0 3px; 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 */ /* navigation bar */
/* ************************************************************************** */ /* ************************************************************************** */
#content div.arangodb div.navigate { #content div.arangodb div.navigate {
height: 0px;
position: relative; position: relative;
text-align: right; text-align: right;
top: -70px; top: -70px;
height: 0px;
} }
/* ************************************************************************** */ /* ************************************************************************** */
@ -26,9 +81,27 @@
} }
#content div.arangodb div.toc ul { #content div.arangodb div.toc ul {
margin-top: 0px;
margin-bottom: 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 */ /* function signature */
/* ************************************************************************** */ /* ************************************************************************** */
@ -48,6 +121,10 @@
margin-bottom: 14px; margin-bottom: 14px;
} }
#content div.arangodb span.commandlineargument {
font-style: italic;
}
/* ************************************************************************** */ /* ************************************************************************** */
/* rest call */ /* rest call */
/* ************************************************************************** */ /* ************************************************************************** */

3
Installation/Makefile.local
View File

@ -25,7 +25,8 @@ publish-wiki:
publish-html: $(OUTPUT_FOLDER) publish-html: $(OUTPUT_FOLDER)
$(MAKE) doxygen $(MAKE) doxygen
@for w in $(WIKI); do cp Doxygen/website/$$w.html $(OUTPUT_FOLDER); done @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) publish-pdf: $(OUTPUT_FOLDER)
$(MAKE) latex $(MAKE) latex

1510
Makefile.in
View File

File diff suppressed because it is too large Load Diff

2
arangod/Documentation/api-collection.dox
View File

@ -99,7 +99,7 @@
/// identifier identifies a collection and is managed by ArangoDB. All /// identifier identifies a collection and is managed by ArangoDB. All
/// collections are found under the URI /// 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}, /// For example: Assume that the collection identifier is @LIT{7254820},
/// then the URL of that collection is: /// then the URL of that collection is:

2
arangod/Documentation/api-index.dox
View File

@ -84,7 +84,7 @@
/// All indexes in ArangoDB have an unique handle. This index handle identifies /// 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 /// 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 /// For example: Assume that the index handle is @LIT{7254820/63563528} then
/// the URL of that index is: /// the URL of that index is:

10
arangod/Documentation/command-line-options.dox
View File

@ -128,7 +128,7 @@
/// @copydetails triagens::rest::ApplicationServer::_configFile /// @copydetails triagens::rest::ApplicationServer::_configFile
/// ///
/// @anchor CommandLineDaemon /// @anchor CommandLineDaemon
/// @CMDOPT{--daemon} /// @CMDOPT{\--daemon}
/// ///
/// Runs the server as a daemon (as a background process). This parameter can /// 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 /// only be set if the pid (process id) file is specified. That is, unless a
@ -136,7 +136,7 @@
/// error and exit. /// error and exit.
/// ///
/// @anchor CommandLineSupervisor /// @anchor CommandLineSupervisor
/// @CMDOPT{--supervisor} /// @CMDOPT{\--supervisor}
/// ///
/// Executes the server in supervisor mode. In the event that the server /// Executes the server in supervisor mode. In the event that the server
/// unexpectedly terminates due to an internal error, the supervisor will /// unexpectedly terminates due to an internal error, the supervisor will
@ -196,7 +196,7 @@
/// @copydetails triagens::rest::ApplicationEndpointServer::_sslCipherList /// @copydetails triagens::rest::ApplicationEndpointServer::_sslCipherList
/// ///
/// @anchor CommandLineArangoDisableAdminInterface /// @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 /// 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 /// administration interface at URL @LIT{http://server:port/} will be disabled
@ -236,14 +236,14 @@
/// @copydetails triagens::rest::ApplicationScheduler::_backend /// @copydetails triagens::rest::ApplicationScheduler::_backend
/// ///
/// @anchor CommandLineSchedulerShowIoBackends /// @anchor CommandLineSchedulerShowIoBackends
/// @CMDOPT{--show-io-backends} /// @CMDOPT{\--show-io-backends}
/// ///
/// If this option is specified, then the server will list available 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 /// and exit. This option is useful only when used in conjunction with the
/// option scheduler.backend. An integer is returned (which is platform /// option scheduler.backend. An integer is returned (which is platform
/// dependent) which indicates available backends on your platform. See libev /// dependent) which indicates available backends on your platform. See libev
/// for further details and for the meaning of the integer returned. This /// 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. /// @ref CommandLineScheduler "here" for details.
/// ///
/// @section CommandLineLogging Command-Line Options for Logging /// @section CommandLineLogging Command-Line Options for Logging

4
arangod/Documentation/install-manual.dox
View File

@ -173,7 +173,7 @@
///////////////////////// /////////////////////////
/// ///
/// Please use the /// 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. /// provided by @@mgiken.
/// ///
/// @subsubsection InstallingOpenSUSE OpenSuSE /// @subsubsection InstallingOpenSUSE OpenSuSE
@ -214,7 +214,7 @@
///////////////////////////////////////////////// /////////////////////////////////////////////////
/// ///
/// If you are using <a href="http://mxcl.github.com/homebrew/">homebrew</a>, /// If you are using <a href="http://mxcl.github.com/homebrew/">homebrew</a>,
/// then you can install the ArangoDB using @CODE{brew} as follows: /// then you can install the ArangoDB using @LIT{brew} as follows:
/// ///
/// @code /// @code
/// brew install arangodb /// brew install arangodb

2
arangod/Documentation/module-jsunity.dox
View File

@ -51,7 +51,7 @@
/// ///
/// Assume that your file live in a directory called @LIT{lib}. Use /// 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 /// to create a copy of the JavaScript files with coverage information. Start
/// the ArangoDB with these files and use @FN{jsunity.runCoverage} instead of /// the ArangoDB with these files and use @FN{jsunity.runCoverage} instead of

2
arangod/Documentation/rest-document.dox
View File

@ -95,7 +95,7 @@
/// defines a document and is managed by ArangoDB. All documents are /// defines a document and is managed by ArangoDB. All documents are
/// found under the URI: /// 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 /// For example: Assume that the document handle, which is stored in
/// the @LIT{_id} field of the document, is @LIT{7254820/362549736}, /// the @LIT{_id} field of the document, is @LIT{7254820/362549736},

4
arangod/Documentation/rest-edge.dox
View File

@ -93,11 +93,11 @@
/// defines a document and is managed by ArangoDB. All documents are /// defines a document and is managed by ArangoDB. All documents are
/// found under the URI /// 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 /// 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 /// For example: Assume that the document handle, which is stored in
/// the @LIT{_id} field of the edge, is @LIT{7254820/362549736}, /// the @LIT{_id} field of the edge, is @LIT{7254820/362549736},

6
arangod/Documentation/simple-queries.dox
View File

@ -142,8 +142,8 @@
/// faster than a simple R* index. /// faster than a simple R* index.
/// ///
/// In general a geo coordinate is a pair of latitude and longitude. This can /// 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 /// either be an list with two elements like @LIT{[-10\, +30]} (latitude
/// first, followed by longitude) or an object like @CODE{{lon: -10\, lat: +30}}. /// 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 /// 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 /// use the @FN{within} operator. In order to find all documents near a given
/// document use the @FN{near} operator. /// document use the @FN{near} operator.
@ -177,7 +177,7 @@
/// @FN{skip} used together with @FN{limit} can be used to implement pagination. /// @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 /// 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 /// 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 /// This result should be sorted, so that the pagination works in a predicable
/// way. /// way.
/// ///

10
arangod/MRServer/ApplicationMR.h
View File

@ -271,7 +271,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief path to the directory containing alternate startup scripts /// @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. /// Specifies the @CA{directory} path to alternate startup MRuby files.
/// Normally, the server will start using built-in MRuby core functionality. To /// 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 /// @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 /// Specifies the @CA{directory} path with user defined MRuby modules. Multiple
/// paths can be specified separated with commas. /// paths can be specified separated with commas.
@ -295,7 +295,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief path to the system action directory /// @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 /// Specifies the @CA{directory} containg the system defined MRuby files that
/// can be invoked as actions. /// can be invoked as actions.
@ -306,7 +306,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief MRuby garbage collection interval (each x requests) /// @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 /// Specifies the interval (approximately in number of requests) that the
/// garbage collection for MRuby objects will be run in each thread. /// 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) /// @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 /// Specifies the frequency in seconds for the automatic garbage collection of
/// MRuby objects. This setting is useful to have the garbage collection /// MRuby objects. This setting is useful to have the garbage collection

26
arangod/RestServer/ArangoServer.h
View File

@ -256,7 +256,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief number of dispatcher threads for non-database worker /// @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 /// Specifies the @CA{number} of threads that are spawned to handle action
/// requests using Rest, JavaScript, or Ruby. /// requests using Rest, JavaScript, or Ruby.
@ -267,10 +267,10 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief path to the database /// @brief path to the database
/// ///
/// @CMDOPT{--database.directory @CA{directory}} /// @CMDOPT{\--database.directory @CA{directory}}
/// ///
/// The directory containing the collections and data-files. Defaults /// The directory containing the collections and data-files. Defaults
/// to @CODE{/var/lib/arango}. /// to @LIT{/var/lib/arango}.
/// ///
/// @CMDOPT{@CA{directory}} /// @CMDOPT{@CA{directory}}
/// ///
@ -287,7 +287,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief remove on drop /// @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 /// 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 /// associated datafiles will be removed from disk. If @LIT{false}, then they
@ -304,7 +304,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief remove on compaction /// @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 /// Normally the garbage collection will removed compacted datafile. For debug
/// purposes you can use this option to keep the old datafiles. You should /// purposes you can use this option to keep the old datafiles. You should
@ -318,7 +318,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief default journal size /// @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 /// 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 /// collection. Note that this also limits the maximal size of a single
@ -332,7 +332,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief default wait for sync behavior /// @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 /// Default wait-for-sync value. Can be overwritten when creating a new
/// collection. /// collection.
@ -345,7 +345,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief force sync shapes /// @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. /// Force syncing of shape data to disk when writing shape information.
/// If turned off, syncing will still happen for shapes of collections that /// If turned off, syncing will still happen for shapes of collections that
@ -360,7 +360,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief unit tests /// @brief unit tests
/// ///
/// @CMDOPT{--javascript.unit-tests @CA{test-file}} /// @CMDOPT{\--javascript.unit-tests @CA{test-file}}
/// ///
/// Runs one or more unit tests. /// Runs one or more unit tests.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -370,7 +370,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief files to jslint /// @brief files to jslint
/// ///
/// @CMDOPT{--jslint @CA{test-file}} /// @CMDOPT{\--jslint @CA{test-file}}
/// ///
/// Runs jslint on one or more files. /// Runs jslint on one or more files.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -380,7 +380,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief run script file /// @brief run script file
/// ///
/// @CMDOPT{--javascript.script @CA{script-file}} /// @CMDOPT{\--javascript.script @CA{script-file}}
/// ///
/// Runs the script file. /// Runs the script file.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -390,7 +390,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief parameters to script file /// @brief parameters to script file
/// ///
/// @CMDOPT{--javascript.script-parameter @CA{script-parameter}} /// @CMDOPT{\--javascript.script-parameter @CA{script-parameter}}
/// ///
/// Parameter to script. /// Parameter to script.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -400,7 +400,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief server default language /// @brief server default language
/// ///
/// @CMDOPT{--default-language @CA{script-parameter}} /// @CMDOPT{\--default-language @CA{script-parameter}}
/// ///
/// Parameter to script. /// Parameter to script.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////

12
arangod/V8Server/ApplicationV8.h
View File

@ -330,7 +330,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief path to the directory containing alternate startup scripts /// @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. /// Specifies the @CA{directory} path to alternate startup JavaScript files.
/// Normally, the server will start using built-in JavaScript core /// Normally, the server will start using built-in JavaScript core
@ -343,7 +343,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief semicolon separated list of module directories /// @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. /// Specifies the @CA{directory} path with user defined JavaScript modules.
/// Multiple paths can be specified separated with commas. /// Multiple paths can be specified separated with commas.
@ -354,7 +354,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief path to the system action directory /// @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 /// Specifies the @CA{directory} containg the system defined JavaScript files
/// that can be invoked as actions. /// that can be invoked as actions.
@ -377,7 +377,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief JavaScript garbage collection interval (each x requests) /// @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 /// Specifies the interval (approximately in number of requests) that the
/// garbage collection for JavaScript objects will be run in each thread. /// 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) /// @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 /// Specifies the frequency (in seconds) for the automatic garbage collection of
/// JavaScript objects. This setting is useful to have the garbage collection /// JavaScript objects. This setting is useful to have the garbage collection
@ -400,7 +400,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief optional arguments to pass to v8 /// @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 /// Optional arguments to pass to the V8 Javascript engine. The V8 engine will
/// run with default settings unless explicit options are specified using this /// run with default settings unless explicit options are specified using this

2
arangod/VocBase/primary-collection.h
View File

@ -1,4 +1,4 @@
//////////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////////
/// @brief primary collection with global read-write lock /// @brief primary collection with global read-write lock
/// ///
/// @file /// @file

4
arangod/VocBase/vocbase.h
View File

@ -342,10 +342,10 @@ typedef uint32_t TRI_col_type_t;
/// ///
/// There are the following locks: /// 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. /// _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 /// unloaded) of the collection. If you want to use a collection, you must call
/// @ref TRI_UseCollectionVocBase, this will either load or manifest the /// @ref TRI_UseCollectionVocBase, this will either load or manifest the
/// collection and a read-lock is held when the functions returns. You must /// collection and a read-lock is held when the functions returns. You must

2
config/generateErrorfile.py
View File

@ -86,7 +86,7 @@ def genCHeaderFile(errors):
for e in errors: for e in errors:
wiki = wiki\ 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" + wrap(e[3], 80, 0, 0, "/// ") + "\n"
wiki = wiki\ wiki = wiki\

50
lib/ApplicationServer/ApplicationServer.h
View File

@ -341,12 +341,12 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief program options /// @brief program options
/// ///
/// @CMDOPT{--help} /// @CMDOPT{\--help}
/// ///
/// @CMDOPT{-h} /// @CMDOPT{-h}
/// ///
/// Prints a list of the most common options available and then /// 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; basics::ProgramOptions _options;
@ -409,7 +409,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief version of the application /// @brief version of the application
/// ///
/// @CMDOPT{--version} /// @CMDOPT{\--version}
/// ///
/// @CMDOPT{-v} /// @CMDOPT{-v}
/// ///
@ -421,23 +421,23 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief config file /// @brief config file
/// ///
/// @CMDOPT{--configuration @CA{filename}} /// @CMDOPT{\--configuration @CA{filename}}
/// ///
/// @CMDOPT{-c @CA{filename}} /// @CMDOPT{-c @CA{filename}}
/// ///
/// Specifies the name of the configuration file to use. /// Specifies the name of the configuration file to use.
/// ///
/// If this command is not passed to the server, then by default, the server /// 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 /// user's home directory, where @CA{SERVER} is the name of the corresponding
/// server. /// server.
/// ///
/// If no such file is found, the server will proceed to look for a file /// 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 /// installation specifies the system configuration directory as
/// /etc. Therefore, in case that no configuration file is found in the user's /// /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 /// 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 /// Only command line options with a value should be set within the
/// configuration file. Command line options which act as flags should be /// configuration file. Command line options which act as flags should be
@ -473,7 +473,7 @@ namespace triagens {
/// ///
/// @verbinclude conf5 /// @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. /// case-insensitive.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -500,7 +500,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief the user id to use for the process /// @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 /// 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 /// 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 /// @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 /// 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 /// is not specified, then the server will not attempt to change its GID, so
@ -564,7 +564,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log application name /// @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 /// Specifies the @CA{name} of the application which should be logged if this item of
/// information is to be logged. /// information is to be logged.
@ -575,7 +575,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log host name /// @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 /// 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 /// should be logged if this item of information is to be logged. Note that
@ -587,7 +587,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log facility /// @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 /// Specifies the name of the server instance which should be logged if this
/// item of information is to be logged. /// item of information is to be logged.
@ -598,9 +598,9 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log level /// @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 /// 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 /// server. The argument @CA{level} is specified as a string and can be one of
@ -670,7 +670,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log format /// @brief log format
/// ///
/// @CMDOPT{--log.format @CA{format}} /// @CMDOPT{\--log.format @CA{format}}
/// ///
/// @copydetails triagens::basics::Logger::setLogFormat /// @copydetails triagens::basics::Logger::setLogFormat
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -680,7 +680,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log severity /// @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 /// This parameter provides a set of standard log severities which can be
/// used. The currently accepted @CA{severities} are: /// used. The currently accepted @CA{severities} are:
@ -701,7 +701,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log level /// @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 /// 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 /// information is logged. By default, if no log file is specified, the standard
@ -719,7 +719,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log prefix /// @brief log prefix
/// ///
/// @CMDOPT{--log.prefix @CA{prefix}} /// @CMDOPT{\--log.prefix @CA{prefix}}
/// ///
/// This option is used specify an prefix to logged text. /// This option is used specify an prefix to logged text.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -729,7 +729,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log level /// @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 /// 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 /// standard output (or to a specified file, in the case that the command line
@ -750,7 +750,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log thread identifier /// @brief log thread identifier
/// ///
/// @CMDOPT{--log.thread} /// @CMDOPT{\--log.thread}
/// ///
/// Whenever log output is generated, the process ID is written as part of the /// 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 /// log information. Setting this option appends the thread id of the calling
@ -770,7 +770,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log line number /// @brief log line number
/// ///
/// @CMDOPT{--log.line-number} /// @CMDOPT{\--log.line-number}
/// ///
/// Normally, if an human readable fatal, error, warning or info message is /// 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 /// logged, no information about the file and line number is provided. The file
@ -783,7 +783,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief log filter /// @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 /// For debug and trace messages, only log those messages occurring in the
/// file @CA{arg}. /// file @CA{arg}.
@ -794,7 +794,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief random number generator to use /// @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 /// 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 /// 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 /// algorithm. Algorithm 4 is a combination of the blocking random number
/// generator and the Mersenne Twister. /// 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 /// By default, the random generator is seeded. Setting this option causes the
/// random number generator not to be seeded. (Seeding the random number /// random number generator not to be seeded. (Seeding the random number

238
lib/BasicsC/voc-errors.h
View File

@ -11,295 +11,295 @@ extern "C" {
/// ///
/// The following errors might be raised when running ArangoDB: /// The following errors might be raised when running ArangoDB:
/// ///
/// - 0: @CODE{no error} /// - 0: @LIT{no error}
/// No error has occurred. /// No error has occurred.
/// - 1: @CODE{failed} /// - 1: @LIT{failed}
/// Will be raised when a general error occurred. /// Will be raised when a general error occurred.
/// - 2: @CODE{system error} /// - 2: @LIT{system error}
/// Will be raised when operating system error occurred. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// Will be raised when the operation is forbidden.
/// - 404: @CODE{not found} /// - 404: @LIT{not found}
/// Will be raised when an URI is unknown. /// 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. /// 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. /// 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. /// 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. /// 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 /// Internal error that will be raised when the datafile is not in the
/// required state. /// required state.
/// - 1001: @CODE{illegal shaper} /// - 1001: @LIT{illegal shaper}
/// Internal error that will be raised when the shaper encountered a porblem. /// 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. /// 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 /// Internal error that will be raised when an unknown collection type is
/// encountered. /// encountered.
/// - 1004: @CODE{ready only} /// - 1004: @LIT{ready only}
/// Internal error that will be raised when trying to write to a read-only /// Internal error that will be raised when trying to write to a read-only
/// datafile or collection. /// datafile or collection.
/// - 1005: @CODE{duplicate identifier} /// - 1005: @LIT{duplicate identifier}
/// Internal error that will be raised when a identifier duplicate is /// Internal error that will be raised when a identifier duplicate is
/// detected. /// detected.
/// - 1006: @CODE{datafile unreadable} /// - 1006: @LIT{datafile unreadable}
/// Internal error that will be raised when the datafile is 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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 /// Will be raised when the datafile cannot be created or renamed because a
/// file of the same name already exists. /// 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. /// 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 /// Will be raised when the collection cannot be created because a directory
/// of the same name already exists. /// 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 /// Will be raised when updating or deleting a document and a conflict has
/// been detected. /// 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 /// Will be raised when a non-existing directory was specified as path for
/// the database. /// 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 /// Will be raised when a document with a given identifier or handle is
/// unknown. /// unknown.
/// - 1203: @CODE{collection not found} /// - 1203: @LIT{collection not found}
/// Will be raised when a collection with a given identifier or name is /// Will be raised when a collection with a given identifier or name is
/// unknown. /// unknown.
/// - 1204: @CODE{parameter 'collection' not found} /// - 1204: @LIT{parameter 'collection' not found}
/// Will be raised when the collection parameter is missing. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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. /// 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 /// Will be raised when the document cannot fit into any datafile because of
/// it is too large. /// 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 /// Will be raised when a collection should be unloaded, but has a different
/// status. /// status.
/// - 1218: @CODE{collection type invalid} /// - 1218: @LIT{collection type invalid}
/// Will be raised when an invalid collection type is used in a request. /// 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. /// 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 /// Will be raised when a running query is killed by an explicit admin
/// command. /// command.
/// - 1501: @CODE{\%s} /// - 1501: @LIT{\%s}
/// Will be raised when query is parsed and is found to be syntactially /// Will be raised when query is parsed and is found to be syntactially
/// invalid. /// invalid.
/// - 1502: @CODE{query is empty} /// - 1502: @LIT{query is empty}
/// Will be raised when an empty query is specified. /// 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. /// 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. /// 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. /// 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. /// 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 /// Will be raised when an unknown variable is used or the variable is
/// undefined the context it is used. /// 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 /// Will be raised when one of the collections referenced in the query was
/// not found. /// 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. /// 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 /// Will be raised when the number of collections in a query is beyond the
/// allowed value. /// 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. /// 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. /// 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 /// Will be raised when the number of arguments used in a function call does
/// not match the expected number of arguments for the function. /// 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 /// Will be raised when the type of an argument used in a function call does
/// not match the expected argument type. /// 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 /// Will be raised when the structure of bind parameters passed has an
/// unexpected format. /// 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 /// Will be raised when a bind parameter was declared in the query but the
/// query is being executed with no value for that parameter. /// 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 /// Will be raised when a value gets specified for an undeclared bind
/// parameter. /// 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. /// 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. /// 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 /// Will be raised when a non-numeric value is used in an arithmetic
/// operation. /// operation.
/// - 1562: @CODE{division by zero} /// - 1562: @LIT{division by zero}
/// Will be raised when there is an attempt to divide 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 /// Will be raised when a non-list operand is used for an operation that
/// expects a list argument operand. /// 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. /// 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 /// Will be raised when a geo restriction was specified but no suitable geo
/// index is found to resolve it. /// 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 /// Will be raised when a cursor is requested via its id but a cursor with
/// that id cannot be found. /// 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 /// 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 /// 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 /// 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 /// 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 /// 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 /// 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 /// 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 /// 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 /// Will be raised when an invalid name, vertices or edges is passed to the
/// server /// server
/// - 1903: @CODE{invalid vertex} /// - 1903: @LIT{invalid vertex}
/// Will be raised when an invalid vertex id is passed to the server /// 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 /// 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 /// 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 /// 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 /// 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 /// 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. /// 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. /// 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. /// 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. /// 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 /// Will be raised when an attempt to insert a document into a priority queue
/// index fails for some reason. /// 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 /// Will be raised when an attempt to remove a document from a priority queue
/// index fails for some reason. /// 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 /// 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. /// 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 /// 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 /// hash index fails due to the fact that document is duplicated within that
/// index. /// 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 /// 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 /// skiplist index fails due to the fact that document is duplicated within
/// that index. /// 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 /// 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 /// caused by the document not having one or more attributes which are
/// required by the hash index. /// 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 /// 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 /// revised document not having one or more attributes which are required by
/// the hash index. /// 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 /// Will be raised when an attempt to remove a document from a hash index
/// fails when document can not be located within that 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 /// 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 /// is caused by in the document not having one or more attributes which are
/// required by the skiplist index. /// 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 /// 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 /// revised document not having one or more attributes which are required by
/// the skiplist index. /// 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 /// Will be raised when an attempt to remove a document from a skiplist index
/// fails when document can not be located within that 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 /// 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 /// is caused by in the document not having one or more attributes which are
/// required by the bitarray index. /// 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 /// 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 /// revised document not having one or more attributes which are required by
/// the bitarray index. /// 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 /// Will be raised when an attempt to remove a document from a bitarray index
/// fails when document can not be located within that 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 /// 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 /// fails due to the fact that one or more values for an index attribute is
/// not supported within that index. /// 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 /// Will be raised when an attempt to create an index with two or more index
/// attributes repeated. /// 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 /// Will be raised when an attempt to create an index with two or more index
/// attribute values repeated. /// attribute values repeated.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////

20
lib/HttpServer/ApplicationEndpointServer.h
View File

@ -271,7 +271,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief endpoints for client HTTP requests /// @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 /// Specifies an @CA{endpoint} for HTTP requests by clients. Endpoints have
/// the following pattern: /// the following pattern:
@ -299,7 +299,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief disable authentication for ALL client requests /// @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 /// Setting @CA{value} to true will turn off authentication on the server side
/// so all clients can execute any action without authorisation and privilege /// so all clients can execute any action without authorisation and privilege
@ -313,7 +313,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief timeout for HTTP keep-alive /// @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 /// Allows to specify the timeout for HTTP keep-alive connections. The timeout
/// value must be specified in seconds. /// value must be specified in seconds.
@ -327,7 +327,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief listen backlog size /// @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 /// Allows to specify the size of the backlog for the listen system call
/// The default value is 10. The maximum value is platform-dependent. /// The default value is 10. The maximum value is platform-dependent.
@ -338,7 +338,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief keyfile containing server certificate /// @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 /// 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 /// of the server private key. The file must be PEM formatted and contain both
@ -367,7 +367,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief CA file /// @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 /// 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 /// to the client whenever the server requests a client certificate. If the
@ -385,7 +385,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief SSL protocol type to use /// @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. /// Use this option to specify the default encryption protocol to be used.
/// The following variants are available: /// The following variants are available:
@ -404,7 +404,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief whether or not to use SSL session caching /// @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. /// Set to true if SSL session caching should be used.
/// ///
@ -419,7 +419,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief ssl options to use /// @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 /// This option can be used to set various SSL-related options. Individual
/// option values must be combined using bitwise OR. /// option values must be combined using bitwise OR.
@ -441,7 +441,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief ssl cipher list to use /// @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, /// This option can be used to restrict the server to certain SSL ciphers only,
/// and to define the relative usage preference of SSL ciphers. /// and to define the relative usage preference of SSL ciphers.

6
lib/Rest/AnyServer.h
View File

@ -168,11 +168,11 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief pid file /// @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 /// 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 /// daemon. This parameter must be specified if either the flag @LIT{daemon} or
/// @CODE{supervisor} is set. /// @LIT{supervisor} is set.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
string _pidFile; string _pidFile;

4
lib/Scheduler/ApplicationScheduler.h
View File

@ -269,7 +269,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief number of scheduler threads /// @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 /// An integer argument which sets the number of threads to use in the IO
/// scheduler. The default is 1. /// scheduler. The default is 1.
@ -280,7 +280,7 @@ namespace triagens {
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief scheduler backend /// @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 /// 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 /// not specified) is to try all recommended backends. This is platform

8
lib/V8/v8-shell.cpp
View File

@ -110,9 +110,9 @@ static void ProcessCsvEnd (TRI_csv_parser_t* parser, char const* field, size_t r
/// @FUN{processCsvFile(@FA{filename}, @FA{callback})} /// @FUN{processCsvFile(@FA{filename}, @FA{callback})}
/// ///
/// Processes a CSV file. The @FA{callback} function is called for line in the /// 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 /// @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 /// 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 /// 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. /// character.
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -232,7 +232,7 @@ static v8::Handle<v8::Value> JS_ProcessCsvFile (v8::Arguments const& argv) {
/// Processes a JSON file. The file must contain the JSON objects each on its /// 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. /// 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 /// @verbinclude fluent49
/// ///