Skip to content
Browse files

cleanup of documentation

  • Loading branch information...
1 parent 31843d1 commit beaaf3bc9b0caf06599c104476a9aa317421b390 @fceller fceller committed Apr 13, 2012
View
70 ApplicationServer/ApplicationServerImpl.h
@@ -42,26 +42,29 @@
/// @page CommandLineLoggingTOC
///
/// <ol>
-/// <li>General Logging Options</li>
+/// <li>@ref CommandLineLoggingGeneral
/// <ol>
-/// <li>log.file</li>
-/// <li>log.severity</li>
-/// <li>log.syslog</li>
+/// <li>@ref CommandLineLoggingLogFile "log.file"</li>
+/// <li>@ref CommandLineLoggingLogSeverity "log.severity"</li>
+/// <li>@ref CommandLineLoggingLogSyslog "log.syslog"</li>
/// </ol>
-/// <li>Human Readable Logging</li>
+/// </li>
+/// <li>@ref CommandLineLoggingHuman
/// <ol>
-/// <li>log.level</li>
-/// <li>log.line-number</li>
-/// <li>log.prefix</li>
-/// <li>log.thread</li>
+/// <li>@ref CommandLineLoggingLogLevel "log.level"</li>
+/// <li>@ref CommandLineLoggingLogLineNumber "log.line-number"</li>
+/// <li>@ref CommandLineLoggingLogPrefix "log.prefix"</li>
+/// <li>@ref CommandLineLoggingLogThread "log.thread"</li>
/// </ol>
-/// <li>Machine Readable Logging</li>
+/// </li>
+/// <li>@ref CommandLineLoggingMachine
/// <ol>
-/// <li>log.application</li>
-/// <li>log.facility</li>
-/// <li>log.format</li>
-/// <li>log.hostname</li>
+/// <li>@ref CommandLineLoggingLogApplication "log.application"</li>
+/// <li>@ref CommandLineLoggingLogFacility "log.facility"</li>
+/// <li>@ref CommandLineLoggingLogFormat "log.format"</li>
+/// <li>@ref CommandLineLoggingLogHostName "log.hostname"</li>
/// </ol>
+/// </li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@@ -78,42 +81,64 @@
/// @copydoc CommandLineLoggingTOC
/// <hr>
///
-/// @section GeneralLogging General Logging Options
+/// @section CommandLineLoggingGeneral General Logging Options
+//////////////////////////////////////////////////////////////
///
+/// @anchor CommandLineLoggingLogFile
/// @copydetails triagens::rest::ApplicationServerImpl::logFile
+/// <hr>
///
+/// @anchor CommandLineLoggingLogSeverity
/// @copydetails triagens::rest::ApplicationServerImpl::logSeverity
+/// <hr>
///
+/// @anchor CommandLineLoggingLogSyslog
/// @copydetails triagens::rest::ApplicationServerImpl::logSyslog
///
-/// @section HumanReadableLogging Human Readable Logging
+/// @section CommandLineLoggingHuman Human Readable Logging
+///////////////////////////////////////////////////////////
///
+/// @anchor CommandLineLoggingLogLevel
/// @copydetails triagens::rest::ApplicationServerImpl::logLevel
+/// <hr>
///
+/// @anchor CommandLineLoggingLogLineNumber
/// @copydetails triagens::rest::ApplicationServerImpl::logLineNumber
+/// <hr>
///
+/// @anchor CommandLineLoggingLogPrefix
/// @copydetails triagens::rest::ApplicationServerImpl::logPrefix
+/// <hr>
///
+/// @anchor CommandLineLoggingLogThread
/// @copydetails triagens::rest::ApplicationServerImpl::logThreadId
+/// <hr>
///
-/// @section MaschineReadableLogging Maschine Readable Logging
+/// @section CommandLineLoggingMachine Maschine Readable Logging
+////////////////////////////////////////////////////////////////
///
+/// @anchor CommandLineLoggingLogApplication
/// @copydetails triagens::rest::ApplicationServerImpl::logApplicationName
+/// <hr>
///
+/// @anchor CommandLineLoggingLogFacility
/// @copydetails triagens::rest::ApplicationServerImpl::logFacility
+/// <hr>
///
+/// @anchor CommandLineLoggingLogFormat
/// @copydetails triagens::rest::ApplicationServerImpl::logFormat
+/// <hr>
///
+/// @anchor CommandLineLoggingLogHostName
/// @copydetails triagens::rest::ApplicationServerImpl::logHostName
-///
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page CommandLineRandomTOC
///
/// <ol>
-/// <li>random.generator</li>
-/// <li>random.no-seed</li>
+/// <li>@ref CommandLineRandomGenerator "random.generator"</li>
+/// <li>@ref CommandLineRandomGenerator "random.no-seed"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@@ -124,6 +149,7 @@
/// @copydoc CommandLineRandomTOC
/// <hr>
///
+/// @anchor CommandLineRandomGenerator
/// @copydetails triagens::rest::ApplicationServerImpl::randomGenerator
////////////////////////////////////////////////////////////////////////////////
@@ -531,7 +557,7 @@ namespace triagens {
/// @CMDOPT{--log.severity @CA{severity}}
///
/// This parameter provides a set of standard log severities which can be
-/// used. The current arguments accepted are:
+/// used. The currently accepted @CA{severities} are:
///
/// - exception
/// - technical
@@ -639,6 +665,8 @@ namespace triagens {
/// algorithm. Algorithm 4 is a combination of the blocking random number
/// generator and the Mersenne Twister.
///
+/// <hr>
+///
/// @CMDOPT{--random.no-seed}
///
/// By default, the random generator is seeded. Setting this option causes the
View
25 ApplicationServer/ApplicationServerSchedulerImpl.h
@@ -36,8 +36,9 @@
/// @page CommandLineSchedulerTOC
///
/// <ol>
-/// <li>scheduler.backend</li>
-/// <li>scheduler.threads</li>
+/// <li>@ref CommandLineSchedulerThreads "scheduler.threads"</li>
+/// <li>@ref CommandLineSchedulerBackend "scheduler.backend"</li>
+/// <li>@ref CommandLineSchedulerShowIoBackends "show-io-backends"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@@ -48,9 +49,27 @@
/// @copydoc CommandLineSchedulerTOC
/// <hr>
///
+/// @anchor CommandLineSchedulerThreads
+///////////////////////////////////////
+/// @copydetails triagens::rest::ApplicationServerSchedulerImpl::_nrSchedulerThreads
+/// <hr>
+///
+/// @anchor CommandLineSchedulerBackend
+///////////////////////////////////////
/// @copydetails triagens::rest::ApplicationServerSchedulerImpl::_backend
+/// <hr>
///
-/// @copydetails triagens::rest::ApplicationServerSchedulerImpl::_nrSchedulerThreads
+/// @anchor CommandLineSchedulerShowIoBackends
+//////////////////////////////////////////////
+/// @CMDOPT{--show-io-backends}
+///
+/// If this option is specified, then the server will list available backends
+/// and exit. This option is useful only when used in conjunction with the
+/// option scheduler.backend. An integer is returned (which is platform
+/// dependent) which indicates available backends on your platform. See libev
+/// for further details and for the meaning of the integer returned. This
+/// describes the allowed integers for @CODE{scheduler.backend}, see
+/// @ref CommandLineScheduler "here" for details.
////////////////////////////////////////////////////////////////////////////////
namespace triagens {
View
0 Doxygen/Examples.AvocadoDB/start2 → ...mples.AvocadoDB/option-database-directory
File renamed without changes.
View
0 Doxygen/Examples.Durham/modules1 → Doxygen/Examples.Durham/modules-require-1
File renamed without changes.
View
0 Doxygen/Examples.Durham/modules2 → Doxygen/Examples.Durham/modules-require-2
File renamed without changes.
View
9 RestServer/AvocadoServer.h
@@ -321,7 +321,9 @@ namespace triagens {
/// When using the command line version, you can simply supply the database
/// directory as argument.
///
-/// @verbinclude start2
+/// @EXAMPLES
+///
+/// @verbinclude option-database-directory
////////////////////////////////////////////////////////////////////////////////
string _databasePath;
@@ -334,8 +336,9 @@ namespace triagens {
/// 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
/// collection directory will be renamed to @LIT{deleted-...}, but remains on
-/// hard disk. To restore such a dropped collection, you can simple rename to
-/// the directory to @LIT{collection-...}.
+/// hard disk. To restore such a dropped collection, you can rename the
+/// directory back to @LIT{collection-...}, but you must also edit the file
+/// @LIT{parameter.json} inside the directory.
///
/// The default is @LIT{true}.
////////////////////////////////////////////////////////////////////////////////
View
75 RestServer/api-collection.dox
@@ -41,19 +41,31 @@
/// @page HttpCollectionCallsTOC
///
/// <ol>
-/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier"</li>
-/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier/properties"</li>
-/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier/count"</li>
-/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier/figures"</li>
-/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier"</li>
-/// <li>@ref HttpCollectionCreate "POST /_api/collection"</li>
-/// <li>@ref HttpCollectionLoad "PUT /_api/collection/collection-identifier/load"</li>
-/// <li>@ref HttpCollectionUnload "PUT /_api/collection/collection-identifier/unload"</li>
-/// <li>@ref HttpCollectionTruncate "PUT /_api/collection/collection-identifier/truncate"</li>
-/// <li>@ref HttpCollectionProperties "PUT /_api/collection/collection-identifier/properties"</li>
-/// <li>@ref HttpCollectionRename "PUT /_api/collection/collection-identifier/rename"</li>
-/// <li>@ref HttpCollectionDelete "DELETE /_api/collection/collection-identifier"</li>
-/// <li>@ref HttpCollectionReadAll "GET /_api/collection/"</li>
+/// <li>@ref HttpCollectionConstructor
+/// <ol>
+/// <li>@ref HttpCollectionCreate "POST /_api/collection"</li>
+/// <li>@ref HttpCollectionDelete "DELETE /_api/collection/collection-identifier"</li>
+/// <li>@ref HttpCollectionTruncate "PUT /_api/collection/collection-identifier/truncate"</li>
+/// </ol>
+/// </li>
+/// <li>@ref HttpCollectionReading
+/// <ol>
+/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier"</li>
+/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier/properties"</li>
+/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier/count"</li>
+/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier/figures"</li>
+/// <li>@ref HttpCollectionRead "GET /_api/collection/collection-identifier"</li>
+/// <li>@ref HttpCollectionReadAll "GET /_api/collection/"</li>
+/// </ol>
+/// </li>
+/// <li>@ref HttpCollectionChanging
+/// <ol>
+/// <li>@ref HttpCollectionLoad "PUT /_api/collection/collection-identifier/load"</li>
+/// <li>@ref HttpCollectionUnload "PUT /_api/collection/collection-identifier/unload"</li>
+/// <li>@ref HttpCollectionProperties "PUT /_api/collection/collection-identifier/properties"</li>
+/// <li>@ref HttpCollectionRename "PUT /_api/collection/collection-identifier/rename"</li>
+/// </ol>
+/// </li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@@ -95,14 +107,35 @@
/// @section HttpCollectionHttp Working with Collections using HTTP
///////////////////////////////////////////////////////////////////
///
+/// @subsection HttpCollectionConstructor Creating and Deleting Collections
+///////////////////////////////////////////////////////////////////////////
+///
+/// @anchor HttpCollectionCreate
+/// @copydetails JSF_POST_api_collection
+/// <hr>
+///
+/// @anchor HttpCollectionDelete
+/// @copydetails JSF_DELETE_api_collection
+/// <hr>
+///
+/// @anchor HttpCollectionTruncate
+/// @copydetails JSF_PUT_api_collection_truncate
+/// <hr>
+///
+/// @subsection HttpCollectionReading Getting Information about a Collection
+////////////////////////////////////////////////////////////////////////////
+///
/// @anchor HttpCollectionRead
/// @copydetails JSF_GET_api_collection
/// <hr>
///
-/// @anchor HttpCollectionCreate
-/// @copydetails JSF_POST_api_collection
+/// @anchor HttpCollectionReadAll
+/// @copydetails JSF_GET_api_collections
/// <hr>
///
+/// @subsection HttpCollectionChanging Modifying a Collection
+/////////////////////////////////////////////////////////////
+///
/// @anchor HttpCollectionLoad
/// @copydetails JSF_PUT_api_collection_load
/// <hr>
@@ -111,24 +144,12 @@
/// @copydetails JSF_PUT_api_collection_unload
/// <hr>
///
-/// @anchor HttpCollectionTruncate
-/// @copydetails JSF_PUT_api_collection_truncate
-/// <hr>
-///
/// @anchor HttpCollectionProperties
/// @copydetails JSF_PUT_api_collection_properties
/// <hr>
///
/// @anchor HttpCollectionRename
/// @copydetails JSF_PUT_api_collection_rename
-/// <hr>
-///
-/// @anchor HttpCollectionDelete
-/// @copydetails JSF_DELETE_api_collection
-/// <hr>
-///
-/// @anchor HttpCollectionReadAll
-/// @copydetails JSF_GET_api_collections
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
View
1 RestServer/module-actions.dox
@@ -76,6 +76,7 @@
///
/// @anchor JSModuleActionsGetErrorMessage
/// @copydetails JSF_GetErrorMessage
+/// <hr>
///
/// @section JSModuleActionsHTTP Standard HTTP Result Generators
////////////////////////////////////////////////////////////////
View
4 RestServer/module-console.dox
@@ -49,15 +49,19 @@
///
/// @anchor JSModuleConsoleDebug
/// @copydetails JSF_CONSOLE_DEBUG
+/// <hr>
///
/// @anchor JSModuleConsoleError
/// @copydetails JSF_CONSOLE_ERROR
+/// <hr>
///
/// @anchor JSModuleConsoleInfo
/// @copydetails JSF_CONSOLE_INFO
+/// <hr>
///
/// @anchor JSModuleConsoleLog
/// @copydetails JSF_CONSOLE_LOG
+/// <hr>
///
/// @anchor JSModuleConsoleWarn
/// @copydetails JSF_CONSOLE_WARN
View
13 RestServer/module-internal.dox
@@ -34,7 +34,7 @@
/// <li>@ref JSModuleInternalLog "internal.log"</li>
/// <li>@ref JSModuleInternalLogLevel "internal.logLevel"</li>
/// <li>@ref JSModuleInternalOutput "internal.output"</li>
-/// <li>JSModuleInternalProcessStat "internal.processStat"</li>
+/// <li>@ref JSModuleInternalProcessStat "internal.processStat"</li>
/// <li>@ref JSModuleInternalRead "internal.read"</li>
/// <li>@ref JSModuleInternalSPrintF "internal.sprintf"</li>
/// <li>@ref JSModuleInternalTime "internal.time"</li>
@@ -52,24 +52,35 @@
///
/// @anchor JSModuleInternalExecute
/// @copydetails JS_Execute
+/// <hr>
///
/// @anchor JSModuleInternalLoad
/// @copydetails JS_Load
+/// <hr>
///
/// @anchor JSModuleInternalLog
/// @copydetails JS_Log
+/// <hr>
///
/// @anchor JSModuleInternalLogLevel
/// @copydetails JS_LogLevel
+/// <hr>
///
/// @anchor JSModuleInternalOutput
/// @copydetails JS_Output
+/// <hr>
+///
+/// @anchor JSModuleInternalProcessStat
+/// @copydetails JS_ProcessStat
+/// <hr>
///
/// @anchor JSModuleInternalRead
/// @copydetails JS_Read
+/// <hr>
///
/// @anchor JSModuleInternalSPrintF
/// @copydetails JS_SPrintF
+/// <hr>
///
/// @anchor JSModuleInternalTime
/// @copydetails JS_Time
View
93 RestServer/ref-manual.dox
@@ -78,13 +78,14 @@
/// @page CommandLineTOC
///
/// <ol>
-/// <li>configuration</li>
-/// <li>daemon</li>
-/// <li>gid</li>
-/// <li>help</li>
-/// <li>pid-file</li>
-/// <li>uid</li>
-/// <li>version</li>
+/// <li>@ref CommandLineHelp "help"</li>
+/// <li>@ref CommandLineVersion "version"</li>
+/// <li>@ref CommandLineConfiguration "configuration"</li>
+/// <li>@ref CommandLineDaemon "daemon"</li>
+/// <li>@ref CommandLineSupervisor "supervisor"</li>
+/// <li>@ref CommandLineUid "uid"</li>
+/// <li>@ref CommandLineGid "gid"</li>
+/// <li>@ref CommandLinePidFile "pid-file"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@@ -96,32 +97,36 @@
/// <hr>
///
/// @section GeneralOptions General Options
+///////////////////////////////////////////
///
+/// @anchor CommandLineHelp
+///////////////////////////
+/// @copydetails triagens::rest::ApplicationServerImpl::options
+/// <hr>
+///
+/// @anchor CommandLineVersion
+//////////////////////////////
+/// @copydetails triagens::rest::ApplicationServerImpl::version
+/// <hr>
+///
+/// @anchor CommandLineConfiguration
+////////////////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::initFile
+/// <hr>
///
+/// @anchor CommandLineDaemon
+/////////////////////////////
/// @CMDOPT{--daemon}
///
/// Runs the server as a daemon (as a background process). This parameter can
/// only be set if the pid (process id) file is specified. That is, unless a
/// value to the parameter pid-file is given, then the server will report an
/// error and exit.
///
-/// @copydetails triagens::rest::ApplicationServerImpl::gid
-///
-/// @copydetails triagens::rest::ApplicationServerImpl::options
-///
-/// @copydetails triagens::rest::AnyServer::_pidFile
-///
-/// @CMDOPT{--show-io-backends}
-///
-/// If this option is specified, then the server will list available backends
-/// and exit. This option is useful only when used in conjunction with the
-/// option scheduler.backend. An integer is returned (which is platform
-/// dependent) which indicates available backends on your platform. See libev
-/// for further details and for the meaning of the integer returned. This
-/// describes the allowed integers for @CODE{scheduler.backend}, see
-/// @ref CommandLineScheduler "here" for details.
+/// <hr>
///
+/// @anchor CommandLineSupervisor
+/////////////////////////////////
/// @CMDOPT{--supervisor}
///
/// Executes the server in supervisor mode. In the event that the server
@@ -130,12 +135,25 @@
/// that the server will run as a daemon. Note that, as with the daemon flag,
/// this flag requires that the pid-file parameter will set.
///
+/// <hr>
+///
+/// @anchor CommandLineUid
+//////////////////////////
/// @copydetails triagens::rest::ApplicationServerImpl::uid
+/// <hr>
///
-/// @copydetails triagens::rest::ApplicationServerImpl::version
+/// @anchor CommandLineGid
+//////////////////////////
+/// @copydetails triagens::rest::ApplicationServerImpl::gid
+/// <hr>
///
+/// @anchor CommandLinePidFile
+//////////////////////////////
+/// @copydetails triagens::rest::AnyServer::_pidFile
/// <hr>
+///
/// Next steps:
+///////////////
///
/// @copydetails CommandLineSubTOC
////////////////////////////////////////////////////////////////////////////////
@@ -144,11 +162,11 @@
/// @page CommandLineAvocadoTOC
///
/// <ol>
-/// <li>database.directory</li>
-/// <li>database.remove-on-drop</li>
-/// <li>database.maximal-journal-size</li>
-/// <li>server.admin-port</li>
-/// <li>server.http-port</li>
+/// <li>@ref CommandLineAvocadoHttpPort "server.http-port"</li>
+/// <li>@ref CommandLineAvocadoAdminPort "server.admin-port"</li>
+/// <li>@ref CommandLineAvocadoDirectory "database.directory"</li>
+/// <li>@ref CommandLineAvocadoMaximalJournalSize "database.maximal-journal-size"</li>
+/// <li>@ref CommandLineAvocadoRemoveOnDrop "database.remove-on-drop"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
@@ -159,15 +177,24 @@
/// @copydoc CommandLineAvocadoTOC
/// <hr>
///
-/// @copydetails triagens::avocado::AvocadoServer::_databasePath
+/// @anchor CommandLineAvocadoHttpPort
+/// @copydetails triagens::avocado::AvocadoServer::_httpPort
+/// <hr>
///
-/// @copydetails triagens::avocado::AvocadoServer::_removeOnDrop
+/// @anchor CommandLineAvocadoAdminPort
+/// @copydetails triagens::avocado::AvocadoServer::_adminPort
+/// <hr>
///
-/// @copydetails triagens::avocado::AvocadoServer::_defaultMaximalSize
+/// @anchor CommandLineAvocadoDirectory
+/// @copydetails triagens::avocado::AvocadoServer::_databasePath
+/// <hr>
///
-/// @copydetails triagens::avocado::AvocadoServer::_adminPort
+/// @anchor CommandLineAvocadoMaximalJournalSize
+/// @copydetails triagens::avocado::AvocadoServer::_defaultMaximalSize
+/// <hr>
///
-/// @copydetails triagens::avocado::AvocadoServer::_httpPort
+/// @anchor CommandLineAvocadoRemoveOnDrop
+/// @copydetails triagens::avocado::AvocadoServer::_removeOnDrop
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
View
12 RestServer/shell-collection.dox
@@ -41,7 +41,7 @@
/// @page ShellCollectionCallsTOC
///
/// <ol>
-/// <li>Collection Methods
+/// <li>@ref ShellCollectionCollectionMethods
/// <ol>
/// <li>@ref ShellCollectionDrop "collection.drop()"</li>
/// <li>@ref ShellCollectionTruncate "collection.truncate()"</li>
@@ -52,7 +52,7 @@
/// <li>@ref ShellCollectionUnload "collection.rename(new-name)"</li>
/// </ol>
/// </li>
-/// <li>Database Methods
+/// <li>@ref ShellCollectionDatabaseMethods
/// <ol>
/// <li>@ref ShellCollectionRead "db._collection(collection-identifier)"</li>
/// <li>@ref ShellCollectionCreate "db._create(collection-name, properties)"</li>
@@ -122,6 +122,9 @@
/// @section ShellCollectionShell Working with Collections
//////////////////////////////////////////////////////////
///
+/// @subsection ShellCollectionCollectionMethods Collection Methods
+///////////////////////////////////////////////////////////////////
+///
/// @anchor ShellCollectionDrop
/// @copydetails JS_DropVocbaseCol
/// <hr>
@@ -150,6 +153,9 @@
/// @copydetails JS_RenameVocbaseCol
/// <hr>
///
+/// @subsection ShellCollectionDatabaseMethods Database Methods
+///////////////////////////////////////////////////////////////
+///
/// @anchor ShellCollectionRead
/// @copydetails JS_CollectionVocBase
/// <hr>
@@ -172,8 +178,6 @@
///
/// @anchor ShellCollectionTruncateDb
/// @copydetails JSF_AvocadoDatabase_prototype__truncate
-/// <hr>
-///
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
View
10 RestServer/shell-document.dox
@@ -41,15 +41,15 @@
/// @page ShellDocumentCallsTOC
///
/// <ol>
-/// <li>Collection Methods
+/// <li>@ref ShellDocumentCollectionMethods
/// <ol>
/// <li>@ref ShellDocumentRead "collection.document(document-handle)"</li>
/// <li>@ref ShellDocumentCreate "collection.save(data)"</li>
/// <li>@ref ShellDocumentUpdate "collection.replace(document, data)"</li>
/// <li>@ref ShellDocumentDelete "collection.delete(document)"</li>
/// </ol>
/// </li>
-/// <li>Database Methods
+/// <li>@ref ShellDocumentDatabaseMethods
/// <ol>
/// <li>@ref ShellDocumentDbRead "db._document(document-handle)"</li>
/// <li>@ref ShellDocumentDbUpdate "db._replace(document-handle, data)"</li>
@@ -118,6 +118,9 @@
/// @section ShellDocumentShell Working with Documents
//////////////////////////////////////////////////////
///
+/// @subsection ShellDocumentCollectionMethods Collection Methods
+/////////////////////////////////////////////////////////////////
+///
/// @anchor ShellDocumentRead
/// @copydetails JS_DocumentVocbaseCol
/// <hr>
@@ -134,6 +137,9 @@
/// @copydetails JS_DeleteVocbaseCol
/// <hr>
///
+/// @subsection ShellDocumentDatabaseMethods Database Methods
+/////////////////////////////////////////////////////////////
+///
/// @anchor ShellDocumentDbRead
/// @copydetails JS_DocumentVocbase
/// <hr>
View
8 RestServer/shell-edge.dox
@@ -40,10 +40,10 @@
/// @page ShellEdgeCallsTOC
///
/// <ol>
-/// <li>@ref ShellEdgeCreate "edge-collection.save(from-handle, to-handle, data)"</li>
-/// <li>@ref ShellEdgeEdges "edge-collection.edges(vertex-handle)"</li>
-/// <li>@ref ShellEdgeInEdges "edge-collection.inEdges(vertex-handle)"</li>
-/// <li>@ref ShellEdgeOutEdges "edge-collection.outEdges(vertex-handle)"</li>
+/// <li>@ref ShellEdgeCreate "edge-collection.save(from, to, data)"</li>
+/// <li>@ref ShellEdgeEdges "edge-collection.edges(vertex)"</li>
+/// <li>@ref ShellEdgeInEdges "edge-collection.inEdges(vertex)"</li>
+/// <li>@ref ShellEdgeOutEdges "edge-collection.outEdges(vertex)"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
View
2 RestServer/user-manual-server.dox
@@ -156,7 +156,7 @@
/// to access the server using HTTP request on port 8529. See below for a list
/// of frequently used options, see @ref CommandLine "here" for a complete list.
///
-/// @verbinclude start2
+/// @verbinclude option-database-directory
///
/// @section UserManualServerStartStopDebug Starting the Debug Shell
///
View
2 V8/v8-actions.h
@@ -115,10 +115,8 @@
/// copydetails JS_DefineSystemAction
///
/// @anchor DefineActionActionResult
-/// @copydetails JSF_actionResult
///
/// @anchor DefineActionActionError
-/// @copydetails JSF_actionError
///
/// @anchor DefineActionQueryResult
/// copydetails JSF_queryResult
View
24 V8/v8-vocbase.cpp
@@ -1638,7 +1638,12 @@ static v8::Handle<v8::Value> JS_AllQuery (v8::Arguments const& argv) {
////////////////////////////////////////////////////////////////////////////////
/// @brief looks up all edges for a set of vertices
///
-/// @FUN{edges(@FA{vertices})}
+/// @FUN{@FA{edge-collection}.edges(@FA{vertex})}
+///
+/// The @FN{edges} operator finds all edges starting from (outbound) or ending
+/// in (inbound) @FA{vertex}.
+///
+/// @FUN{@FA{edge-collection}.edges(@FA{vertices})}
///
/// The @FN{edges} operator finds all edges starting from (outbound) or ending
/// in (inbound) a document from @FA{vertices}.
@@ -1655,7 +1660,11 @@ static v8::Handle<v8::Value> JS_EdgesQuery (v8::Arguments const& argv) {
////////////////////////////////////////////////////////////////////////////////
/// @brief looks up all inbound edges
///
-/// @FUN{inEdges(@FA{vertices})}
+/// @FUN{@FA{edge-collection}.inEdges(@FA{vertex})}
+///
+/// The @FN{edges} operator finds all edges ending in (inbound) @FA{vertex}.
+///
+/// @FUN{@FA{edge-collection}.inEdges(@FA{vertices})}
///
/// The @FN{edges} operator finds all edges ending in (inbound) a document from
/// @FA{vertices}.
@@ -1757,7 +1766,12 @@ static v8::Handle<v8::Value> JS_NearQuery (v8::Arguments const& argv) {
////////////////////////////////////////////////////////////////////////////////
/// @brief looks up all outbound edges
///
-/// @FUN{outEdges(@FA{vertices})}
+/// @FUN{@FA{edge-collection}.outEdges(@FA{vertex})}
+///
+/// The @FN{edges} operator finds all edges starting from (outbound)
+/// @FA{vertices}.
+///
+/// @FUN{@FA{edge-collection}.outEdges(@FA{vertices})}
///
/// The @FN{edges} operator finds all edges starting from (outbound) a document
/// from @FA{vertices}.
@@ -4633,7 +4647,7 @@ static v8::Handle<v8::Value> JS_PropertiesVocbaseCol (v8::Arguments const& argv)
////////////////////////////////////////////////////////////////////////////////
/// @brief renames a collection
///
-/// @FUN{rename(@FA{new-name})}
+/// @FUN{@FA{collection}.rename(@FA{new-name})}
///
/// Renames a collection using the @FA{new-name}. The @FA{new-name} must not
/// already be used for a different collection. If it is an error is thrown.
@@ -4876,7 +4890,7 @@ static v8::Handle<v8::Value> JS_UnloadVocbaseCol (v8::Arguments const& argv) {
////////////////////////////////////////////////////////////////////////////////
/// @brief saves a new document
///
-/// @FUN{save(@FA{from}, @FA{to}, @FA{document})}
+/// @FUN{@FA{edge-collection}.save(@FA{from}, @FA{to}, @FA{document})}
///
/// Saves a new edge and returns the document-handle. @FA{from} and @FA{to}
/// must be documents or document references.
View
6 js/common/bootstrap/js-modules.h
@@ -184,11 +184,11 @@ static string JS_common_bootstrap_modules =
"///\n"
"/// Assume that your module file is @CODE{test1.js} and contains\n"
"///\n"
- "/// @verbinclude modules1\n"
+ "/// @verbinclude modules-require-1\n"
"///\n"
- "/// Then you can use require to load the file and access the exports.\n"
+ "/// Then you can use @FN{require} to load the file and access the exports.\n"
"///\n"
- "/// @verbinclude modules2\n"
+ "/// @verbinclude modules-require-2\n"
"///\n"
"/// @FN{require} follows the specification\n"
"/// <a href=\"http://wiki.commonjs.org/wiki/Modules/1.1.1\">Modules/1.1.1</a>.\n"
View
6 js/common/bootstrap/modules.js
@@ -183,11 +183,11 @@ ModuleCache["/"] = module = new Module("/");
///
/// Assume that your module file is @CODE{test1.js} and contains
///
-/// @verbinclude modules1
+/// @verbinclude modules-require-1
///
-/// Then you can use require to load the file and access the exports.
+/// Then you can use @FN{require} to load the file and access the exports.
///
-/// @verbinclude modules2
+/// @verbinclude modules-require-2
///
/// @FN{require} follows the specification
/// <a href="http://wiki.commonjs.org/wiki/Modules/1.1.1">Modules/1.1.1</a>.
View
20 js/server/js-server.h
@@ -154,9 +154,15 @@ static string JS_server_server =
"///\n"
"/// Drops a @FA{collection} and all its indexes.\n"
"///\n"
+ "/// @FUN{db._drop(@FA{collection-identifier})}\n"
+ "///\n"
+ "/// Drops a collection identified by @FA{collection-identifier} and all its\n"
+ "/// indexes. No error is thrown if there is no such collection.\n"
+ "///\n"
"/// @FUN{db._drop(@FA{collection-name})}\n"
"///\n"
- "/// Drops a collection named @FA{collection-name} and all its indexes.\n"
+ "/// Drops a collection named @FA{collection-name} and all its indexes. No error\n"
+ "/// is thrown if there is no such collection.\n"
"///\n"
"/// @EXAMPLES\n"
"///\n"
@@ -172,7 +178,7 @@ static string JS_server_server =
"AvocadoDatabase.prototype._drop = function(name) {\n"
" var collection = name;\n"
"\n"
- " if (typeof name === \"string\") {\n"
+ " if (! (name instanceof AvocadoCollection || name instanceof AvocadoEdgesCollection)) {\n"
" collection = db._collection(name);\n"
" }\n"
"\n"
@@ -193,9 +199,15 @@ static string JS_server_server =
"/// Truncates a @FA{collection}, removing all documents but keeping all its\n"
"/// indexes.\n"
"///\n"
+ "/// @FUN{db._truncate(@FA{collection-identifier})}\n"
+ "///\n"
+ "/// Truncates a collection identified by @FA{collection-identified}. No error is\n"
+ "/// thrown if there is no such collection.\n"
+ "///\n"
"/// @FUN{db._truncate(@FA{collection-name})}\n"
"///\n"
- "/// Truncates a collection named @FA{collection-name}.\n"
+ "/// Truncates a collection named @FA{collection-name}. No error is thrown if\n"
+ "/// there is no such collection.\n"
"///\n"
"/// @EXAMPLES\n"
"///\n"
@@ -211,7 +223,7 @@ static string JS_server_server =
"AvocadoDatabase.prototype._truncate = function(name) {\n"
" var collection = name;\n"
"\n"
- " if (typeof name === \"string\") {\n"
+ " if (! (name instanceof AvocadoCollection || name instanceof AvocadoEdgesCollection)) {\n"
" collection = db._collection(name);\n"
" }\n"
"\n"
View
4 js/server/modules/actions.js
@@ -179,7 +179,7 @@ function DefineHttp (options) {
////////////////////////////////////////////////////////////////////////////////
/// @brief get an error message string for an error code
///
-/// @FUN{actions.getErrorMessage(@FA{code})
+/// @FUN{actions.getErrorMessage(@FA{code})}
///
/// Returns the error message for an error code.
////////////////////////////////////////////////////////////////////////////////
@@ -202,7 +202,7 @@ function GetErrorMessage (code) {
/// The functions generates an error response. The response body is an array
/// with an attribute @LIT{errorMessage} containing the error message
/// @FA{errorMessage}, @LIT{error} containing @LIT{true}, @LIT{code} containing
-/// @FA{code}, @LIT{errorNum} containing @FA{errorNum}, and $LIT{errorMessage}
+/// @FA{code}, @LIT{errorNum} containing @FA{errorNum}, and @LIT{errorMessage}
/// containing the error message @FA{errorMessage}. @FA{keyvals} are mixed
/// into the result.
////////////////////////////////////////////////////////////////////////////////
View
20 js/server/server.js
@@ -153,9 +153,15 @@ AvocadoError.prototype.toString = function() {
///
/// Drops a @FA{collection} and all its indexes.
///
+/// @FUN{db._drop(@FA{collection-identifier})}
+///
+/// Drops a collection identified by @FA{collection-identifier} and all its
+/// indexes. No error is thrown if there is no such collection.
+///
/// @FUN{db._drop(@FA{collection-name})}
///
-/// Drops a collection named @FA{collection-name} and all its indexes.
+/// Drops a collection named @FA{collection-name} and all its indexes. No error
+/// is thrown if there is no such collection.
///
/// @EXAMPLES
///
@@ -171,7 +177,7 @@ AvocadoError.prototype.toString = function() {
AvocadoDatabase.prototype._drop = function(name) {
var collection = name;
- if (typeof name === "string") {
+ if (! (name instanceof AvocadoCollection || name instanceof AvocadoEdgesCollection)) {
collection = db._collection(name);
}
@@ -192,9 +198,15 @@ AvocadoEdges.prototype._drop = AvocadoDatabase.prototype._drop;
/// Truncates a @FA{collection}, removing all documents but keeping all its
/// indexes.
///
+/// @FUN{db._truncate(@FA{collection-identifier})}
+///
+/// Truncates a collection identified by @FA{collection-identified}. No error is
+/// thrown if there is no such collection.
+///
/// @FUN{db._truncate(@FA{collection-name})}
///
-/// Truncates a collection named @FA{collection-name}.
+/// Truncates a collection named @FA{collection-name}. No error is thrown if
+/// there is no such collection.
///
/// @EXAMPLES
///
@@ -210,7 +222,7 @@ AvocadoEdges.prototype._drop = AvocadoDatabase.prototype._drop;
AvocadoDatabase.prototype._truncate = function(name) {
var collection = name;
- if (typeof name === "string") {
+ if (! (name instanceof AvocadoCollection || name instanceof AvocadoEdgesCollection)) {
collection = db._collection(name);
}

0 comments on commit beaaf3b

Please sign in to comment.
Something went wrong with that request. Please try again.