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

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/libraries/core

Files:

• CommandLineParser.cc (modified) (1 diff)
• Core.cc (modified) (1 diff)
• PathConfig.cc (modified) (1 diff)
• input/InputManager.cc (modified) (1 diff)

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

@@ -41 +41 @@
 namespace orxonox
 {
+    //! @cmdarg
     SetCommandLineOnlyArgument(optionsFile, "start.ini").shortcut("o");
 

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

@@ -77 +77 @@
     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

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