Changeset 7297 for code/branches/doc/src/libraries/core/input

Timestamp:

Aug 31, 2010, 8:37:29 PM (14 years ago)

Author:

landauf

Message:

fixed lots of Doxygen warnings

Note: Doxygen prints a warning if only a part of the parameters of a function are documented.

Added documentation for missing parameters (as good as I could), removed documentation of obsolete parameters and fixed names of renamed parameters.
Some parameters are tagged with "FIXME", please replace this with an appropriate documentation if you know what it does.

Location:

code/branches/doc/src/libraries/core/input

Files:

• InputManager.cc (modified) (1 diff)
• InputManager.h (modified) (1 diff)
• KeyBinder.cc (modified) (2 diffs)

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

@@ -140 +140 @@
         Creates the OIS::InputMananger, the keyboard, the mouse and
         the joys ticks. If either of the first two fail, this method throws an exception.
-    @param windowWidth
-        The width of the render window
-    @param windowHeight
-        The height of the render window
     */
     void InputManager::loadDevices()

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

@@ -122 +122 @@
         @param name
             Unique name of the InputState when referenced as string
+        @param bAlwaysGetsInput
+            FIXME - add doc!
+        @param bTransparent
+            FIXME - add doc!
         @param priority
             Priority matters when multiple states are active. You can specify any

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

@@ -495 +495 @@
     @brief
         Event handler for the mouseMoved Event.
-    @param e
-        Mouse state information
+    @param abs_
+        The absolute position of the mouse
+    @param rel_
+        The relative movement of the mouse
+    @param clippingSize
+        FIXME - no doc? param not even used?
     */
     void KeyBinder::mouseMoved(IntVector2 abs_, IntVector2 rel_, IntVector2 clippingSize)
@@ -551 +555 @@
     /**
     @brief Event handler for the mouseScrolled Event.
-    @param e Mouse state information
+    @param abs The absolute position of the scroll wheel
+    @param rel The relative movement of the scroll wheel
     */
     void KeyBinder::mouseScrolled(int abs, int rel)