Changeset 7357 for code/branches/doc/src/libraries/core/Core.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/Core.cc (modified) (3 diffs)

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;
+        }
     }