Changeset 7335 for code/branches/doc/src/orxonox

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/src/orxonox

Files:

• LevelManager.cc (modified) (1 diff)
• Main.cc (modified) (2 diffs)
• gamestates/GSClient.cc (modified) (1 diff)
• gamestates/GSServer.cc (modified) (1 diff)

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)");