Ignore:
Timestamp:
Dec 23, 2003, 12:08:37 PM (19 years ago)
Author:
Sam Hocevar
Message:
  • More API documentation.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/src/caca.c

    r266 r267  
    174174}
    175175
    176 /**
    177  * \brief Translate a colour value into its name.
    178  *
    179  * \param color The colour value.
    180  * \return A static string containing the colour's name.
     176/** \brief Translate a colour index into the colour's name.
     177 *
     178 *  This function translates a caca_color enum into a human-readable
     179 *  description string of the associated colour.
     180 *
     181 *  \param color The colour value.
     182 *  \return A static string containing the colour's name.
    181183 */
    182184const char *caca_get_color_name(enum caca_color color)
     
    269271}
    270272
    271 /**
    272  * \brief Translate a feature value into its name.
    273  *
    274  * \param feature The feature value.
    275  * \return A static string containing the feature's name.
     273/** \brief Translate a feature value into the feature's name.
     274 *
     275 *  This function translates a caca_feature enum into a human-readable
     276 *  description string of the associated feature.
     277 *
     278 *  \param feature The feature value.
     279 *  \return A static string containing the feature's name.
    276280 */
    277281const char *caca_get_feature_name(enum caca_feature feature)
Note: See TracChangeset for help on using the changeset viewer.