Changeset 7335 for code/branches/doc

Timestamp:

Sep 3, 2010, 1:30:59 PM (14 years ago)

Author:

rgrieder

Message:

Added separate page for a commandline argument reference.
It's not too useful, but better than nothing.

Location:

code/branches/doc

Files:

• doc/api/Groups.dox (modified) (1 diff)
• doc/api/doxy.config.in (modified) (1 diff)
• src/libraries/core/CommandLineParser.cc (modified) (1 diff)
• src/libraries/core/Core.cc (modified) (1 diff)
• src/libraries/core/PathConfig.cc (modified) (1 diff)
• src/libraries/core/input/InputManager.cc (modified) (1 diff)
• src/orxonox/LevelManager.cc (modified) (1 diff)
• src/orxonox/Main.cc (modified) (2 diffs)
• src/orxonox/gamestates/GSClient.cc (modified) (1 diff)
• src/orxonox/gamestates/GSServer.cc (modified) (1 diff)

code/branches/doc/doc/api/Groups.dox

@@ -56 +56 @@
     @defgroup Command Command
     @ingroup Core
+*/
+
+/**
+    @defgroup CmdArgs Commandline Arguments
+    @ingroup Command
+    @brief For a reference see @ref cmdargs
 */
 

code/branches/doc/doc/api/doxy.config.in

@@ -191 +191 @@
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                =
+ALIASES                = "cmdarg=\xrefitem cmdargs \"Commandline Argment\" \"Commandline Arguments Reference\""
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C

code/branches/doc/src/libraries/core/CommandLineParser.cc

@@ -41 +41 @@
 namespace orxonox
 {
+    //! @cmdarg
     SetCommandLineOnlyArgument(optionsFile, "start.ini").shortcut("o");
 

code/branches/doc/src/libraries/core/Core.cc

@@ -77 +77 @@
     Core* Core::singletonPtr_s  = 0;
 
+    //! @cmdarg
     SetCommandLineArgument(settingsFile, "orxonox.ini").information("THE configuration file");
+    //! @cmdarg
     SetCommandLineSwitch(noIOConsole).information("Use this if you don't want to use the IOConsole (for instance for Lua debugging)");
 
 #ifdef ORXONOX_PLATFORM_WINDOWS
+    //! @cmdarg
     SetCommandLineArgument(limitToCPU, 1).information("Limits the program to one CPU/core (1, 2, 3, etc.). Default is the first core (faster than off)");
 #endif

code/branches/doc/src/libraries/core/PathConfig.cc

@@ -70 +70 @@
     PathConfig* PathConfig::singletonPtr_s  = 0;
 
+    //! @cmdarg
     SetCommandLineArgument(externalDataPath, "").information("Path to the external data files");
+    //! @cmdarg
     SetCommandLineOnlyArgument(writingPathSuffix, "").information("Additional subfolder for config and log files");
 

code/branches/doc/src/libraries/core/input/InputManager.cc

@@ -60 +60 @@
 namespace orxonox
 {
+    //! @cmdarg
     SetCommandLineSwitch(keyboard_no_grab).information("Whether not to exclusively grab the keyboard");
 

code/branches/doc/src/orxonox/LevelManager.cc

@@ -42 +42 @@
 namespace orxonox
 {
+    //! @cmdarg
     SetCommandLineArgument(level, "").shortcut("l").information("Default level file (overrides LevelManager::defaultLevelName_ configValue)");
 

code/branches/doc/src/orxonox/Main.cc

@@ -43 +43 @@
 #include "Main.h"
 
-SetCommandLineSwitch(console).information("Start in console mode (text IO only)");
-// Shortcuts for easy direct loading
-SetCommandLineSwitch(server).information("Start in server mode");
-SetCommandLineSwitch(client).information("Start in client mode");
-SetCommandLineSwitch(dedicated).information("Start in dedicated server mode");
-SetCommandLineSwitch(standalone).information("Start in standalone mode");
-SetCommandLineSwitch(dedicatedClient).information("Start in dedicated client mode");
-
 DeclareToluaInterface(Orxonox);
 DeclareToluaInterface(Network);
@@ -56 +48 @@
 namespace orxonox
 {
+    //! @cmdarg
+    SetCommandLineSwitch(console).information("Start in console mode (text IO only)");
+    //! @cmdarg
+    SetCommandLineSwitch(server).information("Start in server mode");
+    //! @cmdarg
+    SetCommandLineSwitch(client).information("Start in client mode");
+    //! @cmdarg
+    SetCommandLineSwitch(dedicated).information("Start in dedicated server mode");
+    //! @cmdarg
+    SetCommandLineSwitch(standalone).information("Start in standalone mode");
+    //! @cmdarg
+    SetCommandLineSwitch(dedicatedClient).information("Start in dedicated client mode");
+
     /**
     @brief

code/branches/doc/src/orxonox/gamestates/GSClient.cc

@@ -40 +40 @@
     DeclareGameState(GSClient, "client", false, false);
 
+    //! @cmdarg
     SetCommandLineArgument(dest, "127.0.0.1").information("Server hostname/IP (IP in the form of #.#.#.#)");
 

code/branches/doc/src/orxonox/gamestates/GSServer.cc

@@ -39 +39 @@
     DeclareGameState(GSServer, "server", false, false);
 
+    //! @cmdarg
     SetCommandLineArgument(port, 55556).shortcut("p").information("Network communication port to be used 0-65535 (default: 55556)");