Documentation|Fixed: A bunch more apidoc and Doxygen markup fixes

doomsday/engine/portable/include/fonts.h

@@ -162,7 +162,7 @@ fontid_t Fonts_ResolveUri(const Uri* uri); /*quiet=!(verbose >= 1)*/
 
 /**
  * @copydoc Fonts_ResolveUri()
- * @param queit  Suppresses the console message that is printed if the Uri cannot be found.
+ * @param quiet  Suppresses the console message that is printed if the Uri cannot be found.
  */
 fontid_t Fonts_ResolveUri2(const Uri* uri, boolean quiet);
 

doomsday/engine/portable/include/fs_util.h

@@ -181,13 +181,15 @@ int F_MatchFileName(const char* filePath, const char* pattern);
 /**
  * Write the data associated with the specified lump index to @a fileName.
  *
- * @param absolutelumpNum   Absolute index of the lump to open.
+ * @param lumpNum           Absolute index of the lump to open.
  * @param fileName          If not @c NULL write the associated data to this path.
  *                          Can be @c NULL in which case the fileName will be chosen automatically.
  *
  * @return  @c true iff successful.
  */
 boolean F_DumpLump2(lumpnum_t lumpNum, char const* fileName);
+
+/// @copydoc F_DumpLump2
 boolean F_DumpLump(lumpnum_t lumpNum/*, fileName = 0*/);
 
 /**

doomsday/engine/portable/include/gamemap.h

@@ -467,16 +467,16 @@ Polyobj* GameMap_PolyobjByBase(GameMap* map, void* ddMobjBase);
 
 /**
  * Have the thinker lists been initialized yet?
- * @param map           GameMap instance.
+ * @param map       GameMap instance.
  */
 boolean GameMap_ThinkerListInited(GameMap* map);
 
 /**
  * Init the thinker lists.
  *
- * @param map  GameMap instance.
- * @params flags  0x1 = Init public thinkers.
- *                0x2 = Init private (engine-internal) thinkers.
+ * @param map       GameMap instance.
+ * @param flags     @c 0x1 = Init public thinkers.
+ *                  @c 0x2 = Init private (engine-internal) thinkers.
  */
 void GameMap_InitThinkerLists(GameMap* map, byte flags);
 
@@ -506,25 +506,30 @@ void GameMap_ThinkerAdd(GameMap* map, thinker_t* thinker, boolean makePublic);
  * Deallocation is lazy -- it will not actually be freed until its
  * thinking turn comes up.
  *
- * @param map  GameMap instance.
+ * @param map   GameMap instance.
  */
 void GameMap_ThinkerRemove(GameMap* map, thinker_t* thinker);
 
 /**
  * Locates a mobj by it's unique identifier in the map.
- * @param map  GameMap instance.
+ *
+ * @param map   GameMap instance.
+ * @param id    Unique id of the mobj to lookup.
  */
 struct mobj_s* GameMap_MobjByID(GameMap* map, int id);
 
 /**
- * @param map  GameMap instance.
+ * @param map   GameMap instance.
+ * @param id    Thinker id to test.
  */
 boolean GameMap_IsUsedMobjID(GameMap* map, thid_t id);
 
 /**
- * @param map  GameMap instance.
+ * @param map   GameMap instance.
+ * @param id    New thinker id.
+ * @param inUse In-use state of @a id. @c true = the id is in use.
  */
-void GameMap_SetMobjID(GameMap* map, thid_t id, boolean state);
+void GameMap_SetMobjID(GameMap* map, thid_t id, boolean inUse);
 
 /**
  * @param map  GameMap instance.
@@ -555,7 +560,10 @@ void GameMap_ClMobjReset(GameMap* map);
  * Iterate the client mobj hash, exec the callback on each. Abort if callback
  * returns @c false.
  *
- * @param map  GameMap instance.
+ * @param map       GameMap instance.
+ * @param callback  Function to callback for each client mobj.
+ * @param context   Data pointer passed to the callback.
+ *
  * @return  If the callback returns @c false.
  */
 boolean GameMap_ClMobjIterator(GameMap* map, boolean (*callback) (struct mobj_s*, void*), void* context);
@@ -767,6 +775,7 @@ BspLeaf* GameMap_BspLeafAtPoint(GameMap* map, coord_t const point[2]);
 /**
  * Construct an initial (empty) Mobj Blockmap for this map.
  *
+ * @param map  GameMap instance.
  * @param min  Minimal coordinates for the map.
  * @param max  Maximal coordinates for the map.
  */
@@ -775,6 +784,7 @@ void GameMap_InitMobjBlockmap(GameMap* map, const_pvec2d_t min, const_pvec2d_t m
 /**
  * Construct an initial (empty) LineDef Blockmap for this map.
  *
+ * @param map  GameMap instance.
  * @param min  Minimal coordinates for the map.
  * @param max  Maximal coordinates for the map.
  */
@@ -783,6 +793,7 @@ void GameMap_InitLineDefBlockmap(GameMap* map, const_pvec2d_t min, const_pvec2d_
 /**
  * Construct an initial (empty) BspLeaf Blockmap for this map.
  *
+ * @param map  GameMap instance.
  * @param min  Minimal coordinates for the map.
  * @param max  Maximal coordinates for the map.
  */
@@ -791,6 +802,7 @@ void GameMap_InitBspLeafBlockmap(GameMap* map, const_pvec2d_t min, const_pvec2d_
 /**
  * Construct an initial (empty) Polyobj Blockmap for this map.
  *
+ * @param map  GameMap instance.
  * @param min  Minimal coordinates for the map.
  * @param max  Maximal coordinates for the map.
  */

doomsday/engine/portable/include/pathtree.h

@@ -375,6 +375,7 @@ typedef int (*pathtree_searchcallback_t) (PathTreeNode* node, int flags, PathMap
  * hierarchy can be performed using nodes pre-selected by the caller or using
  * @see PathTree_Iterate().
  *
+ * @param pt                PathTree instance.
  * @param flags             @ref pathComparisonFlags
  * @param mappedSearchPath  Fragment mapped search path.
  * @param callback          Callback function ptr. The callback should only return
@@ -393,10 +394,13 @@ PathTreeNode* PathTree_Find(PathTree* pt, int flags, char const* path/*, delimit
  * Iterate over nodes in the hierarchy making a callback for each. Iteration ends
  * when all nodes have been visited or a callback returns non-zero.
  *
+ * @param pt            PathTree instance.
  * @param flags         @ref pathComparisonFlags
  * @param parent        Parent node reference, used when restricting processing
  *                      to the child nodes of this node. Only used when the flag
  *                      PCF_MATCH_PARENT is set in @a flags.
+ * @param hash          If not @c PATHTREE_NOHASH only consider nodes whose hashed
+ *                      name matches this.
  * @param callback      Callback function ptr.
  * @param parameters    Passed to the callback.
  *

doomsday/engine/portable/src/dd_main.cpp

@@ -580,9 +580,10 @@ static bool parsePathLumpMapping(lumpname_t lumpName, ddstring_t* path, char con
 }
 
 /**
- * <pre>LUMPNAM0 \Path\In\The\Base.ext
- * LUMPNAM1 Path\In\The\RuntimeDir.ext
- *  :</pre>
+ * <pre>
+ *     LUMPNAM0 \Path\In\The\Base.ext
+ *     LUMPNAM1 Path\In\The\RuntimeDir.ext
+ * </pre>
  */
 static bool parsePathLumpMappings(char const* buffer)
 {

doomsday/engine/portable/src/p_think.c

@@ -56,15 +56,13 @@ boolean GameMap_IsUsedMobjID(GameMap* map, thid_t id)
     return map->thinkers.idtable[id >> 5] & (1 << (id & 31) /*(id % 32) */ );
 }
 
-void GameMap_SetMobjID(GameMap* map, thid_t id, boolean state)
+void GameMap_SetMobjID(GameMap* map, thid_t id, boolean inUse)
 {
     int c = id >> 5, bit = 1 << (id & 31); //(id % 32);
     assert(map);
 
-    if(state)
-        map->thinkers.idtable[c] |= bit;
-    else
-        map->thinkers.idtable[c] &= ~bit;
+    if(inUse) map->thinkers.idtable[c] |= bit;
+    else      map->thinkers.idtable[c] &= ~bit;
 }
 
 typedef struct mobjidlookup_s {

doomsday/engine/portable/src/pathtreenode.cpp

@@ -54,10 +54,10 @@ struct PathTree::Node::Instance
 };
 
 PathTree::Node::Node(PathTree& tree, PathTree::NodeType type, PathTree::FragmentId fragmentId,
-    PathTree::Node* parent, void* userData, int userValue)
+    PathTree::Node* parent, void* userPointer, int userValue)
 {
     d = new Instance(tree, type, fragmentId, parent);
-    setUserPointer(userData);
+    setUserPointer(userPointer);
     setUserValue(userValue);
 }