[Orxonox-commit 2598] r7303 - in code/branches/doc/src/libraries/core: . input

[rgrieder at orxonox.net]

Author: rgrieder
Date: 2010-08-31 23:44:09 +0200 (Tue, 31 Aug 2010)
New Revision: 7303

Modified:
   code/branches/doc/src/libraries/core/CommandLineParser.cc
   code/branches/doc/src/libraries/core/CommandLineParser.h
   code/branches/doc/src/libraries/core/input/InputManager.h
   code/branches/doc/src/libraries/core/input/KeyBinder.cc
Log:
Fixed missing parameters in documentation for input and command line parser.

Modified: code/branches/doc/src/libraries/core/CommandLineParser.cc
===================================================================
--- code/branches/doc/src/libraries/core/CommandLineParser.cc	2010-08-31 21:36:34 UTC (rev 7302)
+++ code/branches/doc/src/libraries/core/CommandLineParser.cc	2010-08-31 21:44:09 UTC (rev 7303)
@@ -126,7 +126,7 @@
     @param arguments
         Vector of space separated strings.
     @param bParsingFile
-        FIXME - add doc!
+        Parsing a file or the command line itself
     */
     void CommandLineParser::_parse(const std::vector<std::string>& arguments, bool bParsingFile)
     {
@@ -246,7 +246,7 @@
     @param value
         String containing the value
     @param bParsingFile
-        FIXME - add doc!
+        Parsing a file or the command line itself
     */
     void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value, bool bParsingFile)
     {
@@ -261,11 +261,11 @@
     @brief
         Parses an argument based on its shortcut.
     @param shortcut
-        Shotcut to the argument
+        Shortcut to the argument
     @param value
         String containing the value
     @param bParsingFile
-        FIXME - add doc!
+        Parsing a file or the command line itself
     */
     void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value, bool bParsingFile)
     {

Modified: code/branches/doc/src/libraries/core/CommandLineParser.h
===================================================================
--- code/branches/doc/src/libraries/core/CommandLineParser.h	2010-08-31 21:36:34 UTC (rev 7302)
+++ code/branches/doc/src/libraries/core/CommandLineParser.h	2010-08-31 21:44:09 UTC (rev 7303)
@@ -207,7 +207,7 @@
     @param defaultValue
         Default value that is used when argument was not given.
     @param bCommandLineOnly
-        FIXME - add doc!
+        Parsing a file or the command line itself
     */
     template <class T>
     CommandLineArgument& CommandLineParser::addArgument(const std::string& name, T defaultValue, bool bCommandLineOnly)

Modified: code/branches/doc/src/libraries/core/input/InputManager.h
===================================================================
--- code/branches/doc/src/libraries/core/input/InputManager.h	2010-08-31 21:36:34 UTC (rev 7302)
+++ code/branches/doc/src/libraries/core/input/InputManager.h	2010-08-31 21:44:09 UTC (rev 7303)
@@ -122,9 +122,9 @@
         @param name
             Unique name of the InputState when referenced as string
         @param bAlwaysGetsInput
-            FIXME - add doc!
+            InputState always gets the input when activated
         @param bTransparent
-            FIXME - add doc!
+            InputState will not prevent underlaying state from receiving input
         @param priority
             Priority matters when multiple states are active. You can specify any
             number, but 1 - 99 is preferred (99 means high priority).

Modified: code/branches/doc/src/libraries/core/input/KeyBinder.cc
===================================================================
--- code/branches/doc/src/libraries/core/input/KeyBinder.cc	2010-08-31 21:36:34 UTC (rev 7302)
+++ code/branches/doc/src/libraries/core/input/KeyBinder.cc	2010-08-31 21:44:09 UTC (rev 7303)
@@ -499,7 +499,7 @@
     @param rel_
         The relative movement of the mouse
     @param clippingSize
-        FIXME - no doc? param not even used?
+        Mouse screen area in pixels (usually 1024x1024)
     */
     void KeyBinder::mouseMoved(IntVector2 abs_, IntVector2 rel_, IntVector2 clippingSize)
     {