Changeset 7297 for code/branches/doc/src/libraries/core/GUIManager.cc

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.

File:

• code/branches/doc/src/libraries/core/GUIManager.cc (modified) (2 diffs)

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

@@ -110 +110 @@
         After Lua setup tolua++-elements are linked to Lua-state to give Lua access to C++-code.
         Finally initial Lua code is executed (maybe we can do this with the CEGUI startup script automatically).
-    @param renderWindow
-        Ogre's render window. Without this, the GUI cannot be displayed.
     @return true if success, otherwise false
     */
@@ -237 +235 @@
     @param name
         The name of the GUI
+    @param bHidePrevious
+        FIXME - add doc!
 
         The function executes the Lua function with the same name in case the GUIManager is ready.