Changeset 7357

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

Files:

• doc/api/CMakeLists.txt (modified) (1 diff)
• doc/api/Groups.dox (modified) (1 diff)
• doc/api/doxy.config.in (modified) (1 diff)
• src/libraries/core/CommandLineParser.cc (modified) (3 diffs)
• src/libraries/core/CommandLineParser.h (modified) (2 diffs)
• src/libraries/core/Core.cc (modified) (3 diffs)
• src/libraries/core/Core.h (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) (3 diffs)
• src/orxonox/gamestates/GSClient.cc (modified) (1 diff)
• src/orxonox/gamestates/GSServer.cc (modified) (1 diff)

code/branches/doc/doc/api/CMakeLists.txt

@@ -55 +55 @@
     OUTPUT ${INTERNAL_DOCFILE}
     COMMAND orxonox-main
-    ARGS --noIOConsole --generateDoc --docFile ${INTERNAL_DOCFILE}
+    ARGS --noIOConsole --generateDoc ${INTERNAL_DOCFILE}
     WORKING_DIRECTORY ${_working_dir}
     COMMENT "Generating additional Doxygen documentation from Orxonox executable"

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

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

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                = "cmdarg=\xrefitem cmdargs \"Commandline Argment\" \"Commandline Arguments Reference\""
+ALIASES                = 
 
 # 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");
 
@@ -315 +314 @@
     }
 
+    void CommandLineParser::generateDoc(std::ofstream& file)
+    {
+        file << "/** @page cmdargspage Command Line Arguments Reference" << endl;
+        file << "    @verbatim"; /*no endl*/
+        file << getUsageInformation(); /*no endl*/
+        file << "    @endverbatim" << endl;
+        file << "*/" << endl;
+    }
+
     /**
     @brief
@@ -320 +328 @@
         The method throws an exception if 'name' was not found or the value could not be converted.
     @note
-        You shold of course not call this method before the command line has been parsed.
+        You should of course not call this method before the command line has been parsed.
     */
     const CommandLineArgument* CommandLineParser::getArgument(const std::string& name)

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

@@ -32 +32 @@
 #include "CorePrereqs.h"
 
+#include <fstream>
 #include <map>
 #include "util/OrxAssert.h"
@@ -164 +165 @@
 
         static void destroyAllArguments();
+
+        static void generateDoc(std::ofstream& file);
 
     private:

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

@@ -37 +37 @@
 
 #include <cassert>
+#include <fstream>
 #include <vector>
 
@@ -77 +78 @@
     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
@@ -174 +172 @@
         // Create singletons that always exist (in other libraries)
         this->rootScope_.reset(new Scope<ScopeID::Root>());
+
+        // Generate documentation instead of normal run?
+        std::string docFilename;
+        CommandLineParser::getValue("generateDoc", &docFilename);
+        if (!docFilename.empty())
+        {
+            std::ofstream docFile(docFilename.c_str());
+            if (docFile.is_open())
+            {
+                CommandLineParser::generateDoc(docFile);
+                docFile.close();
+            }
+            else
+                COUT(0) << "Error: Could not open file for documentation writing" << endl;
+        }
     }
 

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

@@ -33 +33 @@
 #include "CorePrereqs.h"
 
-#include <cassert>
 #include <string>
 #include <boost/scoped_ptr.hpp>

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

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