Documentation|Doxygen: Cleaned up Module grouping

The various public and internal flags are now under appropriate
groups, removing clutter from the Modules index page.

doomsday/engine/portable/include/cbuffer.h

@@ -30,7 +30,8 @@ extern "C" {
 #endif
 
 /**
- * @defgroup consoleBufferLineFlags Console Buffer Line Flags.
+ * @defgroup consoleBufferLineFlags Console Buffer Line Flags
+ * @ingroup flags
  *
  * These correspond to the good old text mode VGA colors.
  * @{
@@ -55,7 +56,8 @@ typedef struct cbline_s {
 } cbline_t;
 
 /**
- * @defgroup consoleBufferFlags Console Buffer Flags.
+ * @defgroup consoleBufferFlags Console Buffer Flags
+ * @ingroup flags
  * @{
  */
 #define CBF_ALWAYSFLUSH  0x00000001 // don't leave data in the write buffer.
@@ -120,12 +122,13 @@ uint CBuffer_NumLines(CBuffer* cb);
 const cbline_t* CBuffer_GetLine(CBuffer* cb, uint idx);
 
 /**
- * @defgroup bufferLineFlags Buffer Line Flags.
+ * @defgroup bufferLineFlags Buffer Line Flags
+ * @ingroup flags
+ * @{
  */
-/*@{*/
 #define BLF_OMIT_RULER      0x1 /// Ignore rulers.
 #define BLF_OMIT_EMPTYLINE  0x2 /// Ignore empty lines.
-/*@}*/
+/// @}
 
 /**
  * Collate an array of ptrs to the immutable @c cbline_t objects owned by

doomsday/engine/portable/include/cl_mobj.h

@@ -31,7 +31,7 @@
 
 /**
  * @defgroup clMobjFlags Client Mobj Flags
- * @ingroup client flags
+ * @ingroup flags
  */
 ///@{
 #define CLMF_HIDDEN         0x01 ///< Not officially created yet

doomsday/engine/portable/include/colorpalette.h

@@ -26,6 +26,7 @@
 
 /**
  * @defgroup colorPaletteFlags  Color Palette Flags
+ * @ingroup flags
  * @{
  */
 #define CPF_UPDATE_18TO8        0x1 /// The 18To8 LUT needs updating.

doomsday/engine/portable/include/con_main.h

@@ -364,6 +364,7 @@ void Con_PrintRuler(void);
 
 /**
  * @defgroup printPathFlags Print Path Flags
+ * @ingroup flags
  */
 /*{@*/
 #define PPF_MULTILINE           0x1 // Use multiple lines.

doomsday/engine/portable/include/finaleinterpreter.h

@@ -32,6 +32,7 @@
 
 /**
  * @defgroup finaleInterpreterCommandDirective Finale Interpreter Command Directive
+ * @ingroup infine
  */
 /*@{*/
 #define FID_NORMAL          0

doomsday/engine/portable/include/font.h

@@ -42,7 +42,8 @@ typedef enum {
 #define VALID_FONTTYPE(v)       ((v) >= FT_FIRST && (v) <= FT_LAST)
 
 /**
- * @defgroup fontFlags  Font Flags.
+ * @defgroup fontFlags  Font Flags
+ * @ingroup flags
  */
 /*@{*/
 #define FF_COLORIZE             0x1 /// Font can be colored.

doomsday/engine/portable/include/game.h

@@ -32,7 +32,8 @@ extern "C" {
 #endif
 
 /**
- * @defgroup printGameFlags  Print Game Flags.
+ * @defgroup printGameFlags  Print Game Flags
+ * @ingroup flags
  */
 ///@{
 #define PGF_BANNER                 0x1

doomsday/engine/portable/include/image.h

@@ -31,7 +31,8 @@ extern "C" {
 #endif
 
 /**
- * @defgroup imageConversionFlags Image Conversion Flags.
+ * @defgroup imageConversionFlags Image Conversion Flags
+ * @ingroup flags
  */
 /*@{*/
 #define ICF_UPSCALE_SAMPLE_WRAPH    (0x1)
@@ -41,6 +42,7 @@ extern "C" {
 
 /**
  * @defgroup imageFlags Image Flags
+ * @ingroup flags
  */
 /*@{*/
 #define IMGF_IS_MASKED              (0x1)

doomsday/engine/portable/include/lumpindex.h

@@ -41,14 +41,15 @@ namespace de {
 
 /**
  * @defgroup lumpIndexFlags Lump Index Flags
+ * @ingroup flags
+ * @{
  */
-///{
 
 /// Lumps in the index must have unique paths. Inserting a lump with the same
 /// path as one which already exists will result in the earlier lump being pruned.
 #define LIF_UNIQUE_PATHS                0x1
 
-///}
+/// @}
 
 class LumpIndex
 {

doomsday/engine/portable/include/mapdata.hs

@@ -107,7 +107,7 @@ end
 internal
 /**
  * @defgroup bspLeafFlags  Bsp Leaf Flags
- * @addtogroup map
+ * @ingroup flags
  */
 ///@{
 #define BLF_UPDATE_FANBASE      0x1 ///< The tri-fan base requires an update.

doomsday/engine/portable/include/p_maptypes.h

@@ -111,7 +111,7 @@ typedef struct hedge_s {
 
 /**
  * @defgroup bspLeafFlags  Bsp Leaf Flags
- * @addtogroup map
+ * @ingroup flags
  */
 ///@{
 #define BLF_UPDATE_FANBASE      0x1 ///< The tri-fan base requires an update.

doomsday/engine/portable/include/p_particle.h

@@ -33,6 +33,7 @@
 
 /**
  * @defgroup generatorFlags  Generator Flags
+ * @ingroup flags
  */
 ///@{
 #define PGF_STATIC              0x1 ///< Can't be replaced by anything.
@@ -70,6 +71,7 @@ typedef enum {
 
 /**
  * @defgroup particleFlags  Particle Flags
+ * @ingroup flags
  */
 ///@{
 #define PTCF_STAGE_TOUCH        0x1 ///< Touching ends current stage.

doomsday/engine/portable/include/pathtree.h

@@ -52,6 +52,7 @@
 
 /**
  * @defgroup pathTreeFlags  Path Tree Flags
+ * @ingroup flags
  */
 ///@{
 #define PATHTREE_MULTI_LEAF 0x1 ///< There can be more than one leaf with a given name.

doomsday/engine/portable/include/r_data.h

@@ -66,6 +66,7 @@ struct font_s;
 
 /**
  * @defgroup textureUnitFlags  Texture Unit Flags
+ * @ingroup flags
  */
 ///@{
 #define TUF_TEXTURE_IS_MANAGED    0x1 ///< A managed texture is bound to this unit.

doomsday/engine/portable/include/r_lumobjs.h

@@ -189,7 +189,8 @@ int LO_LumobjsRadiusIterator(BspLeaf* bspLeaf, coord_t x, coord_t y, coord_t rad
     int (*callback) (const lumobj_t* lum, coord_t distance, void* paramaters)); /* paramaters = NULL */
 
 /**
- * @defgroup projectLightFlags  Flags for LO_ProjectToSurface.
+ * @defgroup projectLightFlags  Flags for LO_ProjectToSurface
+ * @ingroup flags
  */
 ///@{
 #define PLF_SORT_LUMINOSITY_DESC    0x1 ///< Sort by descending luminosity, brightest to dullest.

doomsday/engine/portable/include/r_world.h

@@ -233,6 +233,7 @@ LineDef* R_FindLineBackNeighbor(const Sector* sector, const LineDef* line,
 
 /**
  * @defgroup skyCapFlags  Sky Cap Flags
+ * @ingroup flags
  */
 ///@{
 #define SKYCAP_LOWER                0x1

doomsday/engine/portable/include/render/rend_list.h

@@ -49,7 +49,8 @@ typedef enum primtype_e {
 } primtype_t;
 
 /**
- * @defgroup rendpolyFlags  Rendpoly Flags.
+ * @defgroup rendpolyFlags  Rendpoly Flags
+ * @ingroup flags
  * @{
  */
 #define RPF_SKYMASK                 0x1 /// This primitive is to be added to the sky mask.

doomsday/engine/portable/include/resource/texturevariantspecification.h

@@ -59,6 +59,7 @@ typedef enum {
 
 /**
  * @defgroup textureVariantSpecificationFlags  Texture Variant Specification Flags
+ * @ingroup flags
  */
 /*@{*/
 #define TSF_ZEROMASK                0x1 // Set pixel alpha to fully opaque.

doomsday/engine/portable/include/resourcenamespace.h

@@ -30,6 +30,7 @@
 
 /**
  * @defgroup searchPathFlags  Search Path Flags
+ * @ingroup flags
  */
 ///@{
 #define SPF_NO_DESCEND                  0x1 ///< Do not decend into branches when populating paths.

doomsday/engine/portable/include/s_main.h

@@ -22,7 +22,7 @@
  * Boston, MA  02110-1301  USA
  */
 
-/**
+/*
  * Sound Subsystem.
  */
 
@@ -37,12 +37,18 @@
 extern "C" {
 #endif
 
+/**
+ * @defgroup soundPlayFlags Sound Start Flags
+ * @ingroup flags
+ * @{
+ */
 #define SF_RANDOM_SHIFT     0x1    ///< Random frequency shift.
 #define SF_RANDOM_SHIFT2    0x2    ///< 2x bigger random frequency shift.
 #define SF_GLOBAL_EXCLUDE   0x4    ///< Exclude all emitters.
 #define SF_NO_ATTENUATION   0x8    ///< Very, very loud...
 #define SF_REPEAT           0x10   ///< Repeats until stopped.
 #define SF_DONT_STOP        0x20   ///< Sound can't be stopped while playing.
+/// @}
 
 extern int showSoundInfo;
 extern int soundMinDist, soundMaxDist;
@@ -61,7 +67,18 @@ void S_SetupForChangedMap(void);
 void S_Reset(void);
 void S_StartFrame(void);
 void S_EndFrame(void);
-sfxinfo_t* S_GetSoundInfo(int soundId, float* freq, float* volume);
+
+/**
+ * Gets information about a defined sound. Linked sounds are resolved.
+ *
+ * @param soundID  ID number of the sound.
+ * @param freq     Defined frequency for the sound is returned here. May be @c NULL.
+ * @param volume   Defined volume for the sound is returned here. May be @c NULL.
+ *
+ * @return  Sound info (from definitions).
+ */
+sfxinfo_t* S_GetSoundInfo(int soundID, float* freq, float* volume);
+
 mobj_t* S_GetListenerMobj(void);
 int S_LocalSoundAtVolumeFrom(int soundId, mobj_t* origin, coord_t* fixedpos, float volume);
 int S_LocalSoundAtVolume(int soundId, mobj_t* origin, float volume);

doomsday/engine/portable/include/s_sfx.h

@@ -76,8 +76,25 @@ void            Sfx_StartFrame(void);
 void            Sfx_EndFrame(void);
 void            Sfx_PurgeCache(void);
 void            Sfx_RefreshChannels(void);
-int             Sfx_StartSound(sfxsample_t* sample, float volume, float freq,
-                               mobj_t* emitter, coord_t* fixedpos, int flags);
+
+/**
+ * Used by the high-level sound interface to play sounds on the local system.
+ *
+ * @param sample        Sample to play. Ptr must be stored persistently!
+ *                      No copying is done here.
+ * @param volume        Volume at which the sample should be played.
+ * @param freq          Relative and modifies the sample's rate.
+ * @param emitter       If @c NULL, @a fixedpos is checked for a position.
+ *                      If both @a emitter and @a fixedpos are @c NULL, then
+ *                      the sound is played as centered 2D.
+ * @param fixedpos      Fixed position where the sound if emitted, or @c NULL.
+ * @param flags         Additional flags (@ref soundPlayFlags).
+ *
+ * @return              @c true, if a sound is started.
+ */
+int Sfx_StartSound(sfxsample_t* sample, float volume, float freq,
+                   mobj_t* emitter, coord_t* fixedpos, int flags);
+
 int             Sfx_StopSound(int id, mobj_t* emitter);
 int             Sfx_StopSoundWithLowerPriority(int id, mobj_t* emitter, ddboolean_t byPriority);
 void            Sfx_StopSoundGroup(int group, mobj_t* emitter);

doomsday/engine/portable/include/sv_sound.h

@@ -32,6 +32,7 @@ extern "C" {
 /**
  * @defgroup soundPacketFlags  Sound Packet Flags
  * Used with PSV_SOUND packets.
+ * @ingroup flags
  */
 ///@{
 #define SNDF_ORIGIN             0x01 ///< Sound has an origin.
@@ -46,6 +47,7 @@ extern "C" {
 /**
  * @defgroup stopSoundPacketFlags  Stop Sound Packet Flags
  * Used with PSV_STOP_SOUND packets.
+ * @ingroup flags
  */
 ///@{
 #define STOPSNDF_SOUND_ID       0x01
@@ -56,6 +58,7 @@ extern "C" {
 /**
  * @defgroup svsoundFlags  Flags for Sv_Sound
  * Used to select the target audience for a sound delta.
+ * @ingroup flags
  */
 ///@{
 #define SVSF_TO_ALL             0x01000000

doomsday/engine/portable/include/sys_reslocator.h

@@ -94,6 +94,7 @@ typedef uint resourcenamespaceid_t;
  *
  * Flags used with the F_FindResource family of functions which dictate the
  * logic used during resource location.
+ * @ingroup flags
  */
 ///@{
 #define RLF_MATCH_EXTENSION     0x1 /// If an extension is specified in the search term the found file should have it too.

doomsday/engine/portable/include/texturecontent.h

@@ -26,7 +26,8 @@
 #define LIBDENG_TEXTURECONTENT_H
 
 /**
- * @defgroup textureContentFlags  Texture Content Flags.
+ * @defgroup textureContentFlags  Texture Content Flags
+ * @ingroup flags
  */
 /*@{*/
 #define TXCF_NO_COMPRESSION             0x1

doomsday/engine/portable/include/updater.h

@@ -21,7 +21,7 @@
  */
 
 /**
- * @defgroup updater Automatic updater
+ * @defgroup updater Automatic Updater
  */
 
 #ifndef LIBDENG_UPDATER_H

doomsday/engine/portable/include/window.h

@@ -39,7 +39,8 @@ typedef enum {
 #define WINDOW_MIN_HEIGHT       240
 
 /**
- * @defgroup consoleCommandlineFlags Console Commandline flags
+ * @defgroup consoleCommandlineFlags Console Command Line Flags
+ * @ingroup flags
  * @{
  */
 #define CLF_CURSOR_LARGE        0x1 // Use the large command line cursor.

doomsday/engine/portable/src/fonts.cpp

@@ -183,6 +183,7 @@ static int unlinkRecordInUniqueIdMap(FontRepository::Node& node, void* parameter
 
 /**
  * @defgroup validateFontUriFlags  Validate Font Uri Flags
+ * @ingroup flags
  */
 ///@{
 #define VFUF_ALLOW_NAMESPACE_ANY    0x1 ///< The namespace of the uri may be of zero-length; signifying "any namespace".
@@ -1362,6 +1363,7 @@ static int composeAndCompareDirectoryNodePaths(void const* a, void const* b)
 
 /**
  * @defgroup printFontFlags  Print Font Flags
+ * @ingroup flags
  */
 ///@{
 #define PFF_TRANSFORM_PATH_NO_NAMESPACE 0x1 /// Do not print the namespace.

doomsday/engine/portable/src/fs_main.cpp

@@ -1606,7 +1606,8 @@ AutoStr* F_ComposeLumpPath(struct file1_s* file, int lumpIdx)
 }
 
 /**
- * @defgroup pathToStringFlags  Path To String Flags.
+ * @defgroup pathToStringFlags  Path To String Flags
+ * @ingroup flags
  */
 ///@{
 #define PTSF_QUOTED                     0x1 ///< Add double quotes around the path.

doomsday/engine/portable/src/r_lumobjs.c

@@ -56,6 +56,7 @@ typedef struct listnode_s {
 
 /**
  * @defgroup lightProjectionListFlags  Light Projection List Flags
+ * @ingroup flags
  * @{
  */
 #define SPLF_SORT_LUMINOUS_DESC  0x1 /// Sort by luminosity in descending order.

doomsday/engine/portable/src/r_sky.c

@@ -35,6 +35,7 @@
 
 /**
  * @defgroup skyLayerFlags  Sky Layer Flags
+ * @ingroup flags
  * @{
  */
 #define SLF_ACTIVE              0x1 /// Layer is active and will be rendered.