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

Timestamp:

Sep 5, 2010, 6:50:17 PM (14 years ago)

Author:

rgrieder

Message:

Changed command line arguments reference to a simple Doxygen page containing the usage information text.

Location:

code/branches/doc/src/orxonox

Files:

• LevelManager.cc (modified) (1 diff)
• Main.cc (modified) (3 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

@@ -48 +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");
 
-    //! @cmdarg
-    SetCommandLineSwitch(generateDoc)
+    SetCommandLineArgument(generateDoc, "")
         .information("Generates a Doxygen file from things like SetConsoleCommand");
-    //! @cmdarg
-    SetCommandLineArgument(docFile, "Internal.dox")
-        .information("Name of the doc file to be generated with --generateDoc");
 
     /**
@@ -76 +66 @@
         Game* game = new Game(strCmdLine);
 
-        if (CommandLineParser::getValue("generateDoc").getBool())
-        {
-            // Generate additional documentation written to ONE file
-            std::string filename;
-            CommandLineParser::getValue("docFile", &filename);
-        }
-        else
+        if (CommandLineParser::getValue("generateDoc").getString().empty())
         {
             game->setStateHierarchy(
@@ -96 +80 @@
             game->requestState("root");
 
-            // Some development hacks (not really, but in the future, this calls won't make sense anymore)
+            // Some development hacks (not really, but in the future, these calls won't make sense anymore)
             if (CommandLineParser::getValue("standalone").getBool())
                 Game::getInstance().requestStates("graphics, standalone, level");

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