From 46f4e388d9391ed496649af1735bfee1460e897d Mon Sep 17 00:00:00 2001
From: Tavian Barnes <tavianator@gmail.com>
Date: Fri, 17 Jun 2011 16:18:41 -0600
Subject: Fix up some Doxygen documentation.

---
 libdimension/dimension/finish.h   | 2 ++
 libdimension/dimension/pigments.h | 2 ++
 libdimension/dimension/refcount.h | 6 +++---
 libdimension/dimension/texture.h  | 2 +-
 4 files changed, 8 insertions(+), 4 deletions(-)

(limited to 'libdimension/dimension')

diff --git a/libdimension/dimension/finish.h b/libdimension/dimension/finish.h
index a16ea1b..a1b8f0e 100644
--- a/libdimension/dimension/finish.h
+++ b/libdimension/dimension/finish.h
@@ -36,6 +36,7 @@ typedef struct dmnsn_ambient dmnsn_ambient;
 typedef dmnsn_color dmnsn_ambient_fn(const dmnsn_ambient *ambient,
                                      dmnsn_color pigment);
 
+/** Ambient finish component. */
 struct dmnsn_ambient {
   dmnsn_ambient_fn *ambient_fn; /**< Ambient callback. */
   dmnsn_free_fn    *free_fn;    /**< Destructor callback. */
@@ -97,6 +98,7 @@ typedef dmnsn_color dmnsn_specular_fn(const dmnsn_specular *specular,
                                       dmnsn_vector ray, dmnsn_vector normal,
                                       dmnsn_vector viewer);
 
+/** Specular finish component. */
 struct dmnsn_specular {
   dmnsn_specular_fn *specular_fn; /**< Specular callback. */
   dmnsn_free_fn     *free_fn;     /**< Destructor callback. */
diff --git a/libdimension/dimension/pigments.h b/libdimension/dimension/pigments.h
index e62963e..60dc658 100644
--- a/libdimension/dimension/pigments.h
+++ b/libdimension/dimension/pigments.h
@@ -56,6 +56,7 @@ typedef enum dmnsn_pigment_map_flags {
  * A color-mapped pigment.
  * @param[in,out] pattern  The pattern of the pigment.
  * @param[in,out] map      The color map to apply to the pattern.
+ * @param[in]     flags    Gradient flags
  * @return A pigment mapping the pattern to color values.
  */
 dmnsn_pigment *dmnsn_new_color_map_pigment(dmnsn_pattern *pattern,
@@ -72,6 +73,7 @@ dmnsn_map *dmnsn_new_pigment_map(void);
  * A pigment-mapped pigment.
  * @param[in,out] pattern  The pattern of the pigment.
  * @param[in,out] map      The pigment map to apply to the pattern.
+ * @param[in]     flags    Gradient flags
  * @return A pigment mapping the pattern to other pigments.
  */
 dmnsn_pigment *dmnsn_new_pigment_map_pigment(dmnsn_pattern *pattern,
diff --git a/libdimension/dimension/refcount.h b/libdimension/dimension/refcount.h
index be437a8..5ffde4c 100644
--- a/libdimension/dimension/refcount.h
+++ b/libdimension/dimension/refcount.h
@@ -32,7 +32,7 @@ typedef unsigned int dmnsn_refcount;
  * Increment a reference count.
  * @param[in,out] object  The reference-counted object to acquire.
  */
-#define DMNSN_INCREF(obj) ((void)((obj) && ++(obj)->refcount))
+#define DMNSN_INCREF(object) ((void)((object) && ++(object)->refcount))
 
 /**
  * @internal
@@ -40,5 +40,5 @@ typedef unsigned int dmnsn_refcount;
  * @param[in,out] object  The reference-counted object to release.
  * @return Whether the object is now garbage.
  */
-#define DMNSN_DECREF(obj)                                       \
-  ((obj) && ((obj)->refcount == 0 || --(obj)->refcount == 0))
+#define DMNSN_DECREF(object)                                            \
+  ((object) && ((object)->refcount == 0 || --(object)->refcount == 0))
diff --git a/libdimension/dimension/texture.h b/libdimension/dimension/texture.h
index 0c944a9..e1d8f16 100644
--- a/libdimension/dimension/texture.h
+++ b/libdimension/dimension/texture.h
@@ -61,4 +61,4 @@ void dmnsn_initialize_texture(dmnsn_texture *texture);
  * @param[in,out] texturep         A pointer to the texture to fill.
  */
 void dmnsn_texture_cascade(dmnsn_texture *default_texture,
-                           dmnsn_texture **texture);
+                           dmnsn_texture **texturep);
-- 
cgit v1.2.3