Document libdimension with Doxygen.

1 files changed, 46 insertions, 7 deletions

diff --git a/libdimension/dimension/pigments.h b/libdimension/dimension/pigments.h
index 31c0598..68a9c66 100644
--- a/libdimension/dimension/pigments.h
+++ b/libdimension/dimension/pigments.h
@@ -18,28 +18,67 @@
  * <http://www.gnu.org/licenses/>.                                       *
  *************************************************************************/
 
-/*
- * Custom pigments.
+/**
+ * @file
+ * Pre-defined pigments.
  */
 
 #ifndef DIMENSION_PIGMENTS_H
 #define DIMENSION_PIGMENTS_H
 
-/* A solid color */
+/**
+ * A solid color.
+ * @param[in] color  The color of the pigment.
+ * @return A pigment with the color \p color everywhere.
+ */
 dmnsn_pigment *dmnsn_new_solid_pigment(dmnsn_color color);
-/* An image map */
+
+/**
+ * An image map.  The image (regardless of its real dimensions) is projected
+ * on the x-y plane in tesselating unit squares.
+ * @param[in] canvas  The canvas holding the image.
+ * @return An image-mapped pigment.
+ */
 dmnsn_pigment *dmnsn_new_canvas_pigment(dmnsn_canvas *canvas);
 
-/* Color maps */
+/** Color map. */
 typedef dmnsn_array dmnsn_color_map;
 
-dmnsn_color_map *dmnsn_new_color_map();
+/**
+ * Create an empty color map.
+ * @return A color map with no entries.
+ */
+dmnsn_color_map *dmnsn_new_color_map(void);
+
+/**
+ * Delete a color map.
+ * @param[in,out] map  The color map to delete.
+ */
 void dmnsn_delete_color_map(dmnsn_color_map *map);
 
+/**
+ * Add an entry (a scalar-color pair) to a color map.
+ * @param[in,out] map  The color map to add to.
+ * @param[in]     n    The index of the entry.
+ * @param[in]     c    The value of the entry.
+ */
 void dmnsn_add_color_map_entry(dmnsn_color_map *map, double n, dmnsn_color c);
+
+/**
+ * Evaluate a color map.
+ * @param[in] map  The map to evaluate.
+ * @param[in] n    The index to evaluate.
+ * @return The value of the gradient between the the two indicies closest to
+ * \p n.
+ */
 dmnsn_color dmnsn_color_map_value(const dmnsn_color_map *map, double n);
 
-/* Color-mapped pigments */
+/**
+ * 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.
+ * @return A pigment mapping the pattern to color values.
+ */
 dmnsn_pigment *dmnsn_new_color_map_pigment(dmnsn_pattern *pattern,
                                            dmnsn_color_map *map);