Changeset 7303 for code/branches/doc

Timestamp:

Aug 31, 2010, 11:44:09 PM (14 years ago)

Author:

rgrieder

Message:

Fixed missing parameters in documentation for input and command line parser.

Location:

code/branches/doc/src/libraries/core

Files:

• CommandLineParser.cc (modified) (3 diffs)
• CommandLineParser.h (modified) (1 diff)
• input/InputManager.h (modified) (1 diff)
• input/KeyBinder.cc (modified) (1 diff)

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

@@ -127 +127 @@
         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)
@@ -247 +247 @@
         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)
@@ -262 +262 @@
         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)

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

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

code/branches/doc/src/libraries/core/input/InputManager.h

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

code/branches/doc/src/libraries/core/input/KeyBinder.cc

@@ -500 +500 @@
         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)