Changeset 7357 for code/branches/doc/src/libraries/core/CommandLineParser.cc

Timestamp:

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

Author:

rgrieder

Message:

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

File:

• code/branches/doc/src/libraries/core/CommandLineParser.cc (modified) (3 diffs)

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)