[Orxonox-commit 2630] r7335 - in code/branches/doc: doc/api src/libraries/core src/libraries/core/input src/orxonox src/orxonox/gamestates
rgrieder at orxonox.net
rgrieder at orxonox.net
Fri Sep 3 13:30:59 CEST 2010
Author: rgrieder
Date: 2010-09-03 13:30:59 +0200 (Fri, 03 Sep 2010)
New Revision: 7335
Modified:
code/branches/doc/doc/api/Groups.dox
code/branches/doc/doc/api/doxy.config.in
code/branches/doc/src/libraries/core/CommandLineParser.cc
code/branches/doc/src/libraries/core/Core.cc
code/branches/doc/src/libraries/core/PathConfig.cc
code/branches/doc/src/libraries/core/input/InputManager.cc
code/branches/doc/src/orxonox/LevelManager.cc
code/branches/doc/src/orxonox/Main.cc
code/branches/doc/src/orxonox/gamestates/GSClient.cc
code/branches/doc/src/orxonox/gamestates/GSServer.cc
Log:
Added separate page for a commandline argument reference.
It's not too useful, but better than nothing.
Modified: code/branches/doc/doc/api/Groups.dox
===================================================================
--- code/branches/doc/doc/api/Groups.dox 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/doc/api/Groups.dox 2010-09-03 11:30:59 UTC (rev 7335)
@@ -58,6 +58,12 @@
*/
/**
+ @defgroup CmdArgs Commandline Arguments
+ @ingroup Command
+ @brief For a reference see @ref cmdargs
+*/
+
+/**
@defgroup Config Config
@ingroup Core
*/
Modified: code/branches/doc/doc/api/doxy.config.in
===================================================================
--- code/branches/doc/doc/api/doxy.config.in 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/doc/api/doxy.config.in 2010-09-03 11:30:59 UTC (rev 7335)
@@ -190,7 +190,7 @@
# will result in a user-defined paragraph with heading "Side Effects:".
# You can put \n's in the value part of an alias to insert newlines.
-ALIASES =
+ALIASES = "cmdarg=\xrefitem cmdargs \"Commandline Argment\" \"Commandline Arguments Reference\""
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
# sources only. Doxygen will then generate output that is more tailored for C.
Modified: code/branches/doc/src/libraries/core/CommandLineParser.cc
===================================================================
--- code/branches/doc/src/libraries/core/CommandLineParser.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/libraries/core/CommandLineParser.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -40,6 +40,7 @@
namespace orxonox
{
+ //! @cmdarg
SetCommandLineOnlyArgument(optionsFile, "start.ini").shortcut("o");
/**
Modified: code/branches/doc/src/libraries/core/Core.cc
===================================================================
--- code/branches/doc/src/libraries/core/Core.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/libraries/core/Core.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -76,10 +76,13 @@
//! Static pointer to the singleton
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
Modified: code/branches/doc/src/libraries/core/PathConfig.cc
===================================================================
--- code/branches/doc/src/libraries/core/PathConfig.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/libraries/core/PathConfig.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -69,7 +69,9 @@
//! Static pointer to the singleton
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");
PathConfig::PathConfig()
Modified: code/branches/doc/src/libraries/core/input/InputManager.cc
===================================================================
--- code/branches/doc/src/libraries/core/input/InputManager.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/libraries/core/input/InputManager.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -59,6 +59,7 @@
namespace orxonox
{
+ //! @cmdarg
SetCommandLineSwitch(keyboard_no_grab).information("Whether not to exclusively grab the keyboard");
static const std::string __CC_InputManager_name = "InputManager";
Modified: code/branches/doc/src/orxonox/LevelManager.cc
===================================================================
--- code/branches/doc/src/orxonox/LevelManager.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/orxonox/LevelManager.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -41,6 +41,7 @@
namespace orxonox
{
+ //! @cmdarg
SetCommandLineArgument(level, "").shortcut("l").information("Default level file (overrides LevelManager::defaultLevelName_ configValue)");
ManageScopedSingleton(LevelManager, ScopeID::Root, false);
Modified: code/branches/doc/src/orxonox/Main.cc
===================================================================
--- code/branches/doc/src/orxonox/Main.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/orxonox/Main.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -42,19 +42,24 @@
#include "ToluaBindNetwork.h"
#include "Main.h"
-SetCommandLineSwitch(console).information("Start in console mode (text IO only)");
-// Shortcuts for easy direct loading
-SetCommandLineSwitch(server).information("Start in server mode");
-SetCommandLineSwitch(client).information("Start in client mode");
-SetCommandLineSwitch(dedicated).information("Start in dedicated server mode");
-SetCommandLineSwitch(standalone).information("Start in standalone mode");
-SetCommandLineSwitch(dedicatedClient).information("Start in dedicated client mode");
-
DeclareToluaInterface(Orxonox);
DeclareToluaInterface(Network);
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");
+
/**
@brief
Starting point of orxonox (however not the entry point of the program!)
Modified: code/branches/doc/src/orxonox/gamestates/GSClient.cc
===================================================================
--- code/branches/doc/src/orxonox/gamestates/GSClient.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/orxonox/gamestates/GSClient.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -39,6 +39,7 @@
{
DeclareGameState(GSClient, "client", false, false);
+ //! @cmdarg
SetCommandLineArgument(dest, "127.0.0.1").information("Server hostname/IP (IP in the form of #.#.#.#)");
GSClient::GSClient(const GameStateInfo& info)
Modified: code/branches/doc/src/orxonox/gamestates/GSServer.cc
===================================================================
--- code/branches/doc/src/orxonox/gamestates/GSServer.cc 2010-09-03 11:12:42 UTC (rev 7334)
+++ code/branches/doc/src/orxonox/gamestates/GSServer.cc 2010-09-03 11:30:59 UTC (rev 7335)
@@ -38,6 +38,7 @@
{
DeclareGameState(GSServer, "server", false, false);
+ //! @cmdarg
SetCommandLineArgument(port, 55556).shortcut("p").information("Network communication port to be used 0-65535 (default: 55556)");
GSServer::GSServer(const GameStateInfo& info)
More information about the Orxonox-commit
mailing list