Changeset 267 for libcaca/trunk/src/caca.cTweet

Timestamp:

Dec 23, 2003, 12:08:37 PM (19 years ago)

Author:

Sam Hocevar

Message:

• More API documentation.

File:

• libcaca/trunk/src/caca.c (modified) (2 diffs)

libcaca/trunk/src/caca.c

@@ -174 +174 @@
 }
 
-/**
- * \brief Translate a colour value into its name.
- *
- * \param color The colour value.
- * \return A static string containing the colour's name.
+/** \brief Translate a colour index into the colour's name.
+ *
+ *  This function translates a caca_color enum into a human-readable
+ *  description string of the associated colour.
+ *
+ *  \param color The colour value.
+ *  \return A static string containing the colour's name.
  */
 const char *caca_get_color_name(enum caca_color color)
@@ -269 +271 @@
 }
 
-/**
- * \brief Translate a feature value into its name.
- *
- * \param feature The feature value.
- * \return A static string containing the feature's name.
+/** \brief Translate a feature value into the feature's name.
+ *
+ *  This function translates a caca_feature enum into a human-readable
+ *  description string of the associated feature.
+ *
+ *  \param feature The feature value.
+ *  \return A static string containing the feature's name.
  */
 const char *caca_get_feature_name(enum caca_feature feature)