Documentation|SDK: Reorganized and updated logical groupings

These changes are largely aiming to create a nice tree of logical
groupings for the Doomsday SDK Modules page.

doomsday/sdk/libappfw/include/de/dialogs/inputdialog.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_INPUTDIALOG_H
@@ -26,6 +26,8 @@ namespace de {
 
 /**
  * Dialog for querying a string of text from the user.
+ *
+ * @ingroup dialogs
  */
 class LIBAPPFW_PUBLIC InputDialog : public MessageDialog
 {

doomsday/sdk/libappfw/include/de/dialogs/messagedialog.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_MESSAGEDIALOG_H
@@ -25,6 +25,8 @@ namespace de {
 
 /**
  * Dialog for showing a message.
+ *
+ * @ingroup dialogs
  */
 class LIBAPPFW_PUBLIC MessageDialog : public DialogWidget
 {

doomsday/sdk/libappfw/include/de/framework/actionitem.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_UI_ACTIONITEM_H
@@ -29,6 +29,8 @@ namespace ui {
 
 /**
  * UI context item that represents a user action.
+ *
+ * @ingroup uidata
  */
 class LIBAPPFW_PUBLIC ActionItem : public ImageItem
 {

doomsday/sdk/libappfw/include/de/framework/atlasproceduralimage.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_ATLASPROCEDURALIMAGE_H
@@ -32,6 +32,8 @@ namespace de {
 
 /**
  * Procedural image that draws a simple 2D texture stored on an atlas.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC AtlasProceduralImage : public ProceduralImage
 {

doomsday/sdk/libappfw/include/de/framework/baseguiapp.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_BASEGUIAPP_H
@@ -39,6 +39,8 @@ class VRConfig;
  * Base class for GUI applications.
  *
  * Contains all the shared resources and other data that is needed by the UI framework.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC BaseGuiApp : public GuiApp
 {

doomsday/sdk/libappfw/include/de/framework/basewindow.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_BASEWINDOW_H
@@ -36,6 +36,8 @@ class WindowTransform;
  * additionally specify a content transformation using a WindowTransform object, which
  * will override the built-in transformation. The built-in transformation specifies an
  * "identity" transformation that doesn't differ from the logical layout.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC BaseWindow : public PersistentCanvasWindow
 {

doomsday/sdk/libappfw/include/de/framework/childwidgetorganizer.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_CHILDWIDGETORGANIZER_H
@@ -39,6 +39,8 @@ namespace de {
  * are represented by widgets on screen at the same time. In contexts with
  * large numbers of items, virtualization should be applied to keep only a
  * subset/range of items present as widgets.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC ChildWidgetOrganizer
 {
@@ -96,22 +98,6 @@ class LIBAPPFW_PUBLIC ChildWidgetOrganizer
                                     ui::Data::Pos pos) const = 0;
     };
 
-    /**
-     * Notified when the organizer creates a widget for a context item. Allows
-     * third parties to customize the widget as needed.
-     */
-    DENG2_DEFINE_AUDIENCE2(WidgetCreation,
-                          void widgetCreatedForItem(GuiWidget &widget,
-                                                    ui::Item const &item))
-
-    /**
-     * Notified when the organizer updates a widget for a changed context item.
-     * Allows third parties to customize the widget as needed.
-     */
-    DENG2_DEFINE_AUDIENCE2(WidgetUpdate,
-                          void widgetUpdatedForItem(GuiWidget &widget,
-                                                    ui::Item const &item))
-
 public:
     ChildWidgetOrganizer(GuiWidget &container);
 
@@ -152,6 +138,23 @@ class LIBAPPFW_PUBLIC ChildWidgetOrganizer
 
     ui::Item const *findItemForWidget(GuiWidget const &widget) const;
 
+public:
+    /**
+     * Notified when the organizer creates a widget for a context item. Allows
+     * third parties to customize the widget as needed.
+     */
+    DENG2_DEFINE_AUDIENCE2(WidgetCreation,
+                          void widgetCreatedForItem(GuiWidget &widget,
+                                                    ui::Item const &item))
+
+    /**
+     * Notified when the organizer updates a widget for a changed context item.
+     * Allows third parties to customize the widget as needed.
+     */
+    DENG2_DEFINE_AUDIENCE2(WidgetUpdate,
+                          void widgetUpdatedForItem(GuiWidget &widget,
+                                                    ui::Item const &item))
+
 private:
     DENG2_PRIVATE(d)
 };

doomsday/sdk/libappfw/include/de/framework/data.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_UI_DATA_H
@@ -40,6 +40,8 @@ class Item;
  * Data has ownership of all the items in it.
  *
  * @see ChildWidgetOrganizer
+ *
+ * @ingroup uidata
  */
 class LIBAPPFW_PUBLIC Data
 {

doomsday/sdk/libappfw/include/de/framework/dialogcontentstylist.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_DIALOGCONTENTSTYLIST_H
@@ -30,6 +30,8 @@ class DialogWidget;
 
 /**
  * Sets the style for widgets in a dialog.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC DialogContentStylist
         : public ui::Stylist,

doomsday/sdk/libappfw/include/de/framework/fontlinewrapping.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_FONTLINEWRAPPING_H
@@ -39,6 +39,8 @@ namespace de {
  *
  * FontLineWrapping locks itself automatically when any of its methods are
  * being executed. Instances can be used from multiple threads.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC FontLineWrapping : public Lockable, public shell::ILineWrapping
 {

doomsday/sdk/libappfw/include/de/framework/gltextcomposer.h

@@ -35,6 +35,8 @@ namespace de {
  *
  * Relies on a pre-existing FontLineWrapping where the text content has been
  * wrapped onto multiple lines and laid out appropriately.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC GLTextComposer : public Asset
 {

doomsday/sdk/libappfw/include/de/framework/gridlayout.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_GRIDLAYOUT_H
@@ -30,6 +30,8 @@ namespace de {
  * Layouts are utilities that modify the placement of widgets. The layout
  * instance itself does not need to remain in memory -- widget rules are
  * modified immediately as the widgets are added to the layout.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC GridLayout
 {

doomsday/sdk/libappfw/include/de/framework/guirootwidget.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_GUIROOTWIDGET_H
@@ -35,7 +35,7 @@ class GuiWidget;
 /**
  * Graphical root widget.
  *
- * @ingroup gui
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC GuiRootWidget : public RootWidget
 {

doomsday/sdk/libappfw/include/de/framework/guiwidget.h

@@ -81,7 +81,7 @@ class BlurWidget;
  * @note Always use GuiWidget::destroy() to delete any GUI widget. It will
  * ensure that the widget is properly deinitialized before destruction.
  *
- * @ingroup gui
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC GuiWidget : public QObject, public Widget
 {

doomsday/sdk/libappfw/include/de/framework/guiwidgetprivate.h

@@ -37,6 +37,8 @@ class Style;
  * Note that GuiWidgetPrivate automatically observes the root widget's atlas
  * content repositioning, so derived private implementations can just override
  * the observer method if necessary.
+ *
+ * @ingroup appfw
  */
 template <typename PublicType>
 class GuiWidgetPrivate : public Private<PublicType>,

doomsday/sdk/libappfw/include/de/framework/imageitem.h

@@ -27,6 +27,8 @@ namespace ui {
 
 /**
  * UI context item that represents a user action.
+ *
+ * @ingroup uidata
  */
 class LIBAPPFW_PUBLIC ImageItem : public Item
 {

doomsday/sdk/libappfw/include/de/framework/ipersistent.h

@@ -30,6 +30,8 @@ class PersistentState;
  *
  * GuiWidget instances that implement IPersistent will automatically be saved and
  * restored when the widget is (de)initialized.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC IPersistent
 {

doomsday/sdk/libappfw/include/de/framework/item.h

@@ -39,6 +39,8 @@ class Data;
  * in different ways by different widgets/contexts.
  *
  * @see ui::Data
+ *
+ * @ingroup uidata
  */
 class LIBAPPFW_PUBLIC Item
 {

doomsday/sdk/libappfw/include/de/framework/listdata.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_UI_LISTDATA_H
@@ -29,6 +29,8 @@ namespace ui {
 
 /**
  * List-based UI data context.
+ *
+ * @ingroup uidata
  */
 class LIBAPPFW_PUBLIC ListData : public Data
 {

doomsday/sdk/libappfw/include/de/framework/margins.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_UI_MARGINS_H
@@ -30,6 +30,8 @@ namespace ui {
 
 /**
  * Margin rules for a widget.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC Margins
 {

doomsday/sdk/libappfw/include/de/framework/persistentstate.h

@@ -29,6 +29,8 @@ class IPersistent;
 
 /**
  * Stores and recalls persistent state across running sessions.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC PersistentState : public Refuge
 {

doomsday/sdk/libappfw/include/de/framework/proceduralimage.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_PROCEDURALIMAGE_H
@@ -31,6 +31,8 @@ namespace de {
  *
  * A procedural image can be used instead of a static one to generate geometry
  * on the fly (see LabelWidget).
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC ProceduralImage
 {

doomsday/sdk/libappfw/include/de/framework/sequentiallayout.h

@@ -13,7 +13,7 @@
  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
  * General Public License for more details. You should have received a copy of
  * the GNU Lesser General Public License along with this program; if not, see:
- * http://www.gnu.org/licenses</small> 
+ * http://www.gnu.org/licenses</small>
  */
 
 #ifndef LIBAPPFW_SEQUENTIALLAYOUT_H
@@ -30,6 +30,8 @@ namespace de {
  * Layouts are utilities that modify the placement of widgets. The layout
  * instance itself does not need to remain in memory -- widget rules are
  * modified immediately as the widgets are added to the layout.
+ *
+ * @ingroup appfw
  */
 class LIBAPPFW_PUBLIC SequentialLayout
 {