libdeng2|Documentation: Apidoc improvements

skyjake · Jul 20, 2012 · 09719b0 · 09719b0
1 parent 06e1090
commit 09719b0
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 23 deletions.
diff --git a/doomsday/libdeng2/include/de/data/archive.h b/doomsday/libdeng2/include/de/data/archive.h
@@ -102,9 +102,9 @@ namespace de
          * Loads a copy of the compressed data into memory for all the entries that
          * don't already have uncompressed data stored. 
          *
-         * @param op  If DetachFromSource, the archive becomes a standalone
-         *            archive that no longer needs the source byte array to
-         *            remain in existence.
+         * @param attach  If DetachFromSource, the archive becomes a standalone
+         *                archive that no longer needs the source byte array to
+         *                remain in existence.
          */
         void cache(CacheAttachment attach = DetachFromSource);
 

diff --git a/doomsday/libdeng2/include/de/data/value.h b/doomsday/libdeng2/include/de/data/value.h
@@ -24,12 +24,6 @@
 #include "../ISerializable"
 #include "../String"
 
-/**
- * @defgroup data Data
- *
- * Classes related to accessing, storing, and processing of data.
- */
-
 namespace de
 {
     class Process;

diff --git a/doomsday/libdeng2/include/de/data/variable.h b/doomsday/libdeng2/include/de/data/variable.h
@@ -104,10 +104,10 @@ namespace de
          * @param name  Name for the variable. Any periods (.) are not allowed.
          * @param initial  Initial value. Variable gets ownership. If no value is given here,
          *      a NoneValue will be created for the variable.
-         * @param mode  Mode flags.
+         * @param varMode  Mode flags.
          */
         Variable(const String& name = "", Value* initial = 0,
-                 const Flags& _mode = DefaultMode);
+                 const Flags& varMode = DefaultMode);
 
         /**
          * Constructs a copy of another variable.

diff --git a/doomsday/libdeng2/include/de/libdeng2.h b/doomsday/libdeng2/include/de/libdeng2.h
@@ -25,19 +25,25 @@
  */
 
 /**
- * @defgroup core     Core
- * @defgroup data     Data Types and Structures
- * @defgroup input    Input Subsystem
+ * @defgroup core  Core
  *
- * @defgroup net      Network
+ * @defgroup data  Data Types and Structures
+ * Classes related to accessing, storing, and processing of data.
+ *
+ * @defgroup input  Input Subsystem
+ *
+ * @defgroup net  Network
  * Classes responsible for network communications.
  *
- * @defgroup resource Resources
- * @defgroup render   Renderer
- * @defgroup GL       Graphics Library
- * @defgroup math     Math Utilities
+ * @defgroup resource  Resources
+ *
+ * @defgroup render  Renderer
+ *
+ * @defgroup GL  Graphics Library
+ *
+ * @defgroup math  Math Utilities
  *
- * @defgroup types    Basic Types
+ * @defgroup types  Basic Types
  * Basic data types.
  */
 

diff --git a/doomsday/libdeng2/include/de/vector.h b/doomsday/libdeng2/include/de/vector.h
@@ -35,7 +35,7 @@ namespace de
      * Template class for 2D vectors (points). The members are public for
      * convenient access. The used value type must be serializable.
      *
-     * @ingroup types
+     * @ingroup math
      */ 
     template <typename Type>
     class Vector2 : public ISerializable
@@ -140,7 +140,7 @@ namespace de
      * Template class for 3D vectors (points).
      * The members are public for convenient access.
      *
-     * @ingroup types
+     * @ingroup math
      */ 
     template <typename Type>
     class Vector3 : public Vector2<Type>
@@ -248,7 +248,7 @@ namespace de
      * Template class for 4D vectors.
      * The members are public for convenient access.
      *
-     * @ingroup types
+     * @ingroup math
      */ 
     template <typename Type>
     class Vector4 : public Vector3<Type>