From 4c23d2b5ede215ab2ebc95ff813e875f37c9c67c Mon Sep 17 00:00:00 2001 From: Sam Hocevar Date: Sun, 7 Feb 2010 15:57:52 +0000 Subject: [PATCH] Add brief documentation to figfont functions. --- caca/figfont.c | 3 +++ 1 file changed, 3 insertions(+) diff --git a/caca/figfont.c b/caca/figfont.c index e86ec94..52470e4 100644 --- a/caca/figfont.c +++ b/caca/figfont.c @@ -52,6 +52,7 @@ static uint32_t hsmush(uint32_t ch1, uint32_t ch2, int rule); static caca_figfont_t * open_figfont(char const *); static int free_figfont(caca_figfont_t *); +/** \brief load a figfont and attach it to a canvas */ int caca_canvas_set_figfont(caca_canvas_t *cv, char const *path) { caca_figfont_t *ff = NULL; @@ -127,6 +128,7 @@ int caca_canvas_set_figfont(caca_canvas_t *cv, char const *path) return 0; } +/** \brief paste a character using the current figfont */ int caca_put_figchar(caca_canvas_t *cv, uint32_t ch) { caca_figfont_t *ff = cv->ff; @@ -250,6 +252,7 @@ int caca_put_figchar(caca_canvas_t *cv, uint32_t ch) return 0; } +/** \brief flush the figlet context */ int caca_flush_figlet(caca_canvas_t *cv) { caca_figfont_t *ff = cv->ff;