Documentation|libdeng2: Cleaning up apidoc

skyjake · Jan 26, 2013 · f93a6d9 · f93a6d9
1 parent 1079f9c
commit f93a6d9
Show file tree

Hide file tree

Showing 11 changed files with 21 additions and 9 deletions.
diff --git a/doomsday/libdeng2/include/de/core/logsink.h b/doomsday/libdeng2/include/de/core/logsink.h
@@ -36,14 +36,14 @@ class DENG2_PUBLIC LogSink
     {
         Disabled,
         Enabled,
-        OnlyNormalEntries,
-        OnlyWarningEntries
+        OnlyNormalEntries,  ///< Info or lower.
+        OnlyWarningEntries  ///< Warning or higher.
     };
 
 public:
     /**
      * Formatters are responsible for converting LogEntry instances to a
-     * human-presentable, print-ready format suitable for the sink.. It may,
+     * human-presentable, print-ready format suitable for the sink. It may,
      * for instance, apply indenting and omit repeating parts.
      */
     class DENG2_PUBLIC IFormatter

diff --git a/doomsday/libdeng2/include/de/widgets/animation.h b/doomsday/libdeng2/include/de/widgets/animation.h
@@ -1,5 +1,4 @@
 /** @file animation.h Animation function.
- * @ingroup widgets
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
@@ -49,7 +48,7 @@ class Animation : public ISerializable
     };
 
     /// Animation has no defined time source. @ingroup errors
-    DENG2_ERROR(ClockMissing);
+    DENG2_ERROR(ClockMissingError);
 
 public:
     Animation(float value = 0, Style style = EaseIn);

diff --git a/doomsday/libdeng2/include/de/widgets/animationvector.h b/doomsday/libdeng2/include/de/widgets/animationvector.h
@@ -1,5 +1,4 @@
 /** @file animationvector.h Vector whose components are Animation instances.
- * @ingroup widgets
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
@@ -27,6 +26,7 @@ namespace de {
 
 /**
  * Animated 2D vector.
+ * @ingroup math
  */
 class AnimationVector2
 {
@@ -74,6 +74,7 @@ class AnimationVector2
 
 /**
  * Animated 3D vector.
+ * @ingroup math
  */
 class AnimationVector3
 {

diff --git a/doomsday/libdeng2/include/de/widgets/constantrule.h b/doomsday/libdeng2/include/de/widgets/constantrule.h
@@ -26,6 +26,7 @@ namespace de {
 
 /**
  * The value of a constant rule never changes unless manually changed.
+ * @ingroup widgets
  *
  * @see ScalarRule
  */

diff --git a/doomsday/libdeng2/include/de/widgets/delegaterule.h b/doomsday/libdeng2/include/de/widgets/delegaterule.h
@@ -33,6 +33,8 @@ namespace de {
  * on their own but instead only as part of another rule. (Delegated reference
  * counting means that references held to the derived rule actually are held to
  * the delegate target.)
+ *
+ * @ingroup widgets
  */
 class DelegateRule : public ConstantRule
 {

diff --git a/doomsday/libdeng2/include/de/widgets/operatorrule.h b/doomsday/libdeng2/include/de/widgets/operatorrule.h
@@ -27,6 +27,7 @@ namespace de {
 /**
  * Calculates a value by applying a mathematical operator to the values of one
  * or two other rules.
+ * @ingroup widgets
  */
 class OperatorRule : public Rule
 {

diff --git a/doomsday/libdeng2/include/de/widgets/rectanglerule.h b/doomsday/libdeng2/include/de/widgets/rectanglerule.h
@@ -32,6 +32,8 @@ namespace de {
  * The value of the rectangle rule is the area of the rectangle (width *
  * height). RectangleRule::rect() returns the rectangle itself. The output
  * rules for the sides can be used normally in other rules.
+ *
+ * @ingroup widgets
  */
 class RectangleRule : public Rule
 {

diff --git a/doomsday/libdeng2/include/de/widgets/rootwidget.h b/doomsday/libdeng2/include/de/widgets/rootwidget.h
@@ -1,5 +1,4 @@
 /** @file rootwidget.h Widget for managing the root of the UI.
- * @ingroup widget
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
@@ -36,6 +35,8 @@ class Rule;
  *
  * The view dimensions are available as Rule instances so that widgets'
  * position rules may be defined relative to them.
+ *
+ * @ingroup widgets
  */
 class RootWidget : public Widget
 {

diff --git a/doomsday/libdeng2/include/de/widgets/scalarrule.h b/doomsday/libdeng2/include/de/widgets/scalarrule.h
@@ -29,6 +29,7 @@ namespace de {
 
 /**
  * Rule with a scalar value. The value is animated over time.
+ * @ingroup widgets
  */
 class ScalarRule : public Rule
 {

diff --git a/doomsday/libdeng2/include/de/widgets/widget.h b/doomsday/libdeng2/include/de/widgets/widget.h
@@ -1,5 +1,6 @@
 /** @file widget.h Base class for widgets.
- * @ingroup widget
+ *
+ * @defgroup widgets  Widget Framework
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *
@@ -27,6 +28,10 @@ namespace de {
 
 class RootWidget;
 
+/**
+ * Base class for widgets.
+ * @ingroup widgets
+ */
 class Widget
 {
 public:

diff --git a/doomsday/libdeng2/src/widgets/animation.cpp b/doomsday/libdeng2/src/widgets/animation.cpp
@@ -1,5 +1,4 @@
 /** @file animation.h Animation function.
- * @ingroup widgets
  *
  * @authors Copyright © 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
  *