Documentation: Fixed a couple of Doxygen issues

skyjake · Dec 18, 2012 · 5ec7cab · 5ec7cab
1 parent 511759e
commit 5ec7cab
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/doomsday/engine/include/map/sector.h b/doomsday/engine/include/map/sector.h
@@ -36,7 +36,7 @@ extern "C" {
  *
  * @pre LineDef list must have been initialized.
  *
- * @param Sector  Sector instance.
+ * @param sector  Sector instance.
  */
 void Sector_UpdateAABox(Sector* sector);
 
@@ -45,7 +45,7 @@ void Sector_UpdateAABox(Sector* sector);
  *
  * @pre Axis-aligned bounding box must have been initialized.
  *
- * @param Sector  Sector instance.
+ * @param sector  Sector instance.
  */
 void Sector_UpdateArea(Sector* sector);
 

diff --git a/doomsday/engine/include/map/sidedef.h b/doomsday/engine/include/map/sidedef.h
@@ -35,7 +35,7 @@ extern "C" {
  * defined by the associated LineDef's vertices and the plane heights of the
  * Sector on this side. If no LineDef is presently associated this is a no-op.
  *
- * @param sideDef  SideDef instance.
+ * @param side  SideDef instance.
  */
 void SideDef_UpdateBaseOrigins(SideDef* side);
 
@@ -51,7 +51,7 @@ void SideDef_UpdateSurfaceTangents(SideDef* sideDef);
 /**
  * Get a property value, selected by DMU_* name.
  *
- * @param sidedef  SideDef instance.
+ * @param sideDef  SideDef instance.
  * @param args  Property arguments.
  * @return  Always @c 0 (can be used as an iterator).
  */
@@ -60,7 +60,7 @@ int SideDef_GetProperty(const SideDef* sideDef, setargs_t* args);
 /**
  * Update a property value, selected by DMU_* name.
  *
- * @param sidedef  SideDef instance.
+ * @param sideDef  SideDef instance.
  * @param args  Property arguments.
  * @return  Always @c 0 (can be used as an iterator).
  */

diff --git a/doomsday/engine/include/map/surface.h b/doomsday/engine/include/map/surface.h
@@ -98,24 +98,44 @@ boolean Surface_SetMaterialOriginY(Surface* surface, float y);
 
 /**
  * Change surface color tint and alpha.
+ *
  * @param surface  Surface instance.
+ * @param red      Red color component (0...1).
+ * @param green    Green color component (0...1).
+ * @param blue     Blue color component (0...1).
+ * @param alpha    Alpha component (0...1).
  */
 boolean Surface_SetColorAndAlpha(Surface* surface, float red, float green, float blue, float alpha);
 
 /**
  * Change surfacecolor tint.
  *
  * @param surface  Surface instance.
+ * @param red      Red color component (0...1).
  */
 boolean Surface_SetColorRed(Surface* surface, float red);
+
+/**
+ * Change surfacecolor tint.
+ *
+ * @param surface  Surface instance.
+ * @param green    Green color component (0...1).
+ */
 boolean Surface_SetColorGreen(Surface* surface, float green);
+
+/**
+ * Change surfacecolor tint.
+ *
+ * @param surface  Surface instance.
+ * @param blue     Blue color component (0...1).
+ */
 boolean Surface_SetColorBlue(Surface* surface, float blue);
 
 /**
  * Change surface alpha.
  *
  * @param surface  Surface instance.
- * @param alpha  New alpha value.
+ * @param alpha    New alpha value (0...1).
  */
 boolean Surface_SetAlpha(Surface* surface, float alpha);