diff options
| author | Dave Davenport <qball@gmpclient.org> | 2018-06-12 11:28:31 +0200 |
|---|---|---|
| committer | Dave Davenport <qball@gmpclient.org> | 2018-06-12 11:28:31 +0200 |
| commit | c856c1a8abb292b06bba4ef05a4338b6b4ad6832 (patch) | |
| tree | 7c5904c6323e7d957d5ace0a83c56e6224eb4bad /include | |
| parent | 75811fd5a573cd570645d56ac91093b5722a291b (diff) | |
[Widget::Icon] Fix doxygen documentation in header file.
Diffstat (limited to 'include')
| -rw-r--r-- | include/css-colors.h | 21 | ||||
| -rw-r--r-- | include/widgets/icon.h | 4 |
2 files changed, 25 insertions, 0 deletions
diff --git a/include/css-colors.h b/include/css-colors.h index 0c47b393..9dd36c92 100644 --- a/include/css-colors.h +++ b/include/css-colors.h @@ -1,12 +1,33 @@ #ifndef ROFI_INCLUDE_CSS_COLORS_H #define ROFI_INCLUDE_CSS_COLORS_H +/** + * @defgroup CSSCOLORS CssColors + * @ingroup HELPERS + * + * Lookup table for CSS 4.0 named colors. Like `Navo`. + * + * @{ + */ + +/** + * Structure of colors. + */ typedef struct CSSColor { + /** CSS name of the color. */ char *name; + /** BGRA 8 bit color components. */ uint8_t b, g, r, a; }CSSColor; +/** + * Array with all the named colors. Of type #CSSColor, there are #num_CSSColors items in this array. + */ extern const CSSColor CSSColors[]; +/** + * Number of named colors. + */ extern const unsigned int num_CSSColors; +/* @} */ #endif // ROFI_INCLUDE_CSS_COLORS_H diff --git a/include/widgets/icon.h b/include/widgets/icon.h index d2dfb1d2..315eda8a 100644 --- a/include/widgets/icon.h +++ b/include/widgets/icon.h @@ -58,6 +58,10 @@ icon * icon_create ( widget *parent, const char *name ); */ void icon_set_size ( widget *icon, const int size ); +/** + * @param icon The icon widget handle. + * @param surf The surface to display. + */ void icon_set_surface ( icon *icon, cairo_surface_t *surf ); /*@}*/ #endif // ROFI_ICON_H |