Documentation: Fixed more Doxygen issues

doomsday/engine/engine-mac.doxy

@@ -8,4 +8,4 @@ OUTPUT_DIRECTORY    = ../apidoc/mac/
 
 INPUT               = api mac portable unix
 
-PREDEFINED          = __DOOMSDAY__ UNIX MACOSX
+PREDEFINED          = __DOOMSDAY__ UNIX MACOSX __cplusplus

doomsday/engine/portable/include/bspleaf.h

@@ -43,11 +43,11 @@ void BspLeaf_Delete(BspLeaf* bspLeaf);
  * We are assured by the node build process that BspLeaf->hedges has been ordered
  * by angle, clockwise starting from the smallest angle.
  *
- * @algorithm:
- * For each vertex
+ * @par Algorithm
+ * <pre>For each vertex
  *    For each triangle
  *        if area is not greater than minimum bound, move to next vertex
- *    Vertex is suitable
+ *    Vertex is suitable</pre>
  *
  * If a vertex exists which results in no zero-area triangles it is suitable for
  * use as the center of our trifan. If a suitable vertex is not found then the

doomsday/engine/portable/include/edit_bsp.h

@@ -48,9 +48,9 @@ BspBuilder_c* BspBuilder_SetSplitCostFactor(BspBuilder_c* builder, int factor);
 /**
  * Build the BSP for the given map.
  *
- * @param map  The map to build the BSP for.
+ * @param builder  BSP builder instance.
  *
- * @return  @c true= iff completed successfully.
+ * @return  @c true, iff completed successfully.
  */
 boolean BspBuilder_Build(BspBuilder_c* builder);
 

doomsday/engine/portable/include/map/bsp/partitioner.h

@@ -51,14 +51,14 @@ class Partitioner
     /**
      * Build the BSP for the given map.
      *
-     * @algorithm High-level description (courtesy of Raphael Quinet)
-     *   1 - Create one Seg for each SideDef: pick each LineDef in turn.  If it
-     *       has a "first" SideDef, then create a normal Seg.  If it has a
-     *       "second" SideDef, then create a flipped Seg.
-     *   2 - Call CreateNodes with the current list of Segs.  The list of Segs is
-     *       the only argument to CreateNodes.
-     *   3 - Save the Nodes, Segs and BspLeafs to disk.  Start with the leaves of
-     *       the Nodes tree and continue up to the root (last Node).
+     * High-level description (courtesy of Raphael Quinet):
+     *   1. Create one Seg for each SideDef: pick each LineDef in turn.  If it
+     *      has a "first" SideDef, then create a normal Seg.  If it has a
+     *      "second" SideDef, then create a flipped Seg.
+     *   2. Call CreateNodes with the current list of Segs.  The list of Segs is
+     *      the only argument to CreateNodes.
+     *   3. Save the Nodes, Segs and BspLeafs to disk.  Start with the leaves of
+     *      the Nodes tree and continue up to the root (last Node).
      *
      * @return  @c true= iff completed successfully.
      */

doomsday/engine/portable/include/p_maputil.h

@@ -78,30 +78,49 @@ BspLeaf* P_BspLeafAtPoint(coord_t const point[2]);
 BspLeaf* P_BspLeafAtPointXY(coord_t x, coord_t y);
 
 /**
- * Is the point inside the sector, according to the edge lines of the BspLeaf.
+ * Is the point inside the sector, according to the edge lines of the BspLeaf?
  *
- * @param  X coordinate to test.
- * @param  Y coordinate to test.
- * @param  Sector to test.
+ * @param point   XY coordinate to test.
+ * @param sector  Sector to test.
  *
  * @return  @c true, if the point is inside the sector.
  */
 boolean P_IsPointInSector(coord_t const point[2], const Sector* sector);
+
+/**
+ * Is the point inside the sector, according to the edge lines of the BspLeaf?
+ *
+ * @param x       X coordinate to test.
+ * @param y       Y coordinate to test.
+ * @param sector  Sector to test.
+ *
+ * @return  @c true, if the point is inside the sector.
+ */
 boolean P_IsPointXYInSector(coord_t x, coord_t y, const Sector* sector);
 
 /**
- * Is the point inside the BspLeaf (according to the edges).
+ * Is the point inside the BspLeaf (according to the edges)?
  *
- * @algorithm Uses the well-known algorithm described here:
- * http://www.alienryderflex.com/polygon/
+ * Uses the well-known algorithm described here: http://www.alienryderflex.com/polygon/
  *
- * @param x  X coordinate to test.
- * @param y  Y coordinate to test.
+ * @param point    XY coordinate to test.
  * @param bspLeaf  BspLeaf to test.
  *
  * @return  @c true, if the point is inside the BspLeaf.
  */
 boolean P_IsPointInBspLeaf(coord_t const point[2], const BspLeaf* bspLeaf);
+
+/**
+ * Is the point inside the BspLeaf (according to the edges)?
+ *
+ * Uses the well-known algorithm described here: http://www.alienryderflex.com/polygon/
+ *
+ * @param x        X coordinate to test.
+ * @param y        Y coordinate to test.
+ * @param bspLeaf  BspLeaf to test.
+ *
+ * @return  @c true, if the point is inside the BspLeaf.
+ */
 boolean P_IsPointXYInBspLeaf(coord_t x, coord_t y, const BspLeaf* bspLeaf);
 
 void P_MobjLink(mobj_t* mo, byte flags);
@@ -119,7 +138,7 @@ void P_LinkMobjToLineDefs(mobj_t* mo);
 boolean P_UnlinkMobjFromLineDefs(mobj_t* mo);
 
 /**
- * @important The mobj must be currently unlinked.
+ * @note  The mobj must be currently unlinked.
  */
 void P_LinkMobjInBlockmap(mobj_t* mo);
 

doomsday/engine/portable/src/edit_bsp.cpp

@@ -1,5 +1,5 @@
 /**
- * @file bsp_map.cpp
+ * @file edit_bsp.cpp
  * BSP Builder. @ingroup map
  *
  * @authors Copyright © 2006-2012 Daniel Swanson <danij@dengine.net>

doomsday/engine/portable/src/p_objlink.c

@@ -326,9 +326,9 @@ int RIT_LinkObjToBspLeaf(BspLeaf* bspLeaf, void* paramaters)
  * BspLeaf and into the (relative) back BspLeaf.
  *
  * @param bspLeaf  BspLeaf to attempt to spread over to.
- * @param data  @see contactfinderparams_t
+ * @param parameters  @see contactfinderparams_t
  *
- * @return  @c true (always - this function is also used as an iterator).
+ * @return  Always @c true. (This function is also used as an iterator.)
  */
 static void spreadInBspLeaf(BspLeaf* bspLeaf, void* paramaters)
 {
@@ -501,10 +501,11 @@ static void findContacts(objlink_t* link)
  * Spread contacts in the object => BspLeaf objlink blockmap to all
  * other BspLeafs within the block.
  *
- * @param bspLeaf  BspLeaf to spread the contacts of.
+ * @param obm        Objlink blockmap.
+ * @param bspLeaf    BspLeaf to spread the contacts of.
+ * @param maxRadius  Maximum radius for the spread.
  */
-void R_ObjlinkBlockmapSpreadInBspLeaf(objlinkblockmap_t* obm,
-    const BspLeaf* bspLeaf, float maxRadius)
+void R_ObjlinkBlockmapSpreadInBspLeaf(objlinkblockmap_t* obm, const BspLeaf* bspLeaf, float maxRadius)
 {
     uint minBlock[2], maxBlock[2], x, y;
     objlink_t* iter;

doomsday/libdeng2/include/de/libdeng2.h

@@ -21,7 +21,7 @@
 #define LIBDENG2_H
 
 /**
- * @file Common definitions for libdeng2.
+ * @file libdeng2.h  Common definitions for libdeng2.
  */
 
 #ifdef __cplusplus
@@ -43,8 +43,8 @@
 #include <assert.h>
 
 /*
- * The DENG2_PUBLIC macro is used to declare symbols for exporting. It must
- * be applied in all exported classes and functions. DEF files are not used for
+ * The DENG2_PUBLIC macro is used for declaring exported symbols. It must be
+ * applied in all exported classes and functions. DEF files are not used for
  * exporting symbols out of libdeng2.
  */
 #if defined(_WIN32) && defined(_MSC_VER)