Changeset 825Tweet

Timestamp:

Apr 21, 2006, 8:09:30 PM (16 years ago)

Author:

Sam Hocevar

Message:

• Minor documentation improvements.

Location:

libcaca/trunk/cucul

Files:

• colour.c (modified) (1 diff)
• dither.c (modified) (8 diffs)
• export.c (modified) (2 diffs)
• font.c (modified) (6 diffs)

libcaca/trunk/cucul/colour.c

@@ -34 +34 @@
  *  will use these colours.
  *
- *  Color values are those defined in \e cucul.h, such as CUCUL_COLOR_RED
+ *  Color values are those defined in cucul.h, such as CUCUL_COLOR_RED
  *  or CUCUL_COLOR_TRANSPARENT.
  *

libcaca/trunk/cucul/dither.c

@@ -422 +422 @@
 /** \brief Set dither antialiasing
  *
- *  Tell the renderer whether to antialias the dither. Antialiasing smoothen
+ *  Tell the renderer whether to antialias the dither. Antialiasing smoothens
  *  the rendered image and avoids the commonly seen staircase effect.
  *
- *  \li \e "none": no antialiasing.
- *
- *  \li \e "prefilter": simple prefilter antialiasing. This is the default
+ *  \li \c "none": no antialiasing.
+ *
+ *  \li \c "prefilter": simple prefilter antialiasing. This is the default
  *      value.
  *
@@ -447 +447 @@
  *  list is a NULL-terminated array of strings, interleaving a string
  *  containing the internal value for the antialiasing method to be used with
- *  \e cucul_set_dither_antialias(), and a string containing the natural
+ *  cucul_set_dither_antialias(), and a string containing the natural
  *  language description for that antialiasing method.
  *
@@ -469 +469 @@
  *
  *  Tell the renderer which colours should be used to render the
- *  bitmap. Valid values for \e str are:
- *
- *  \li \e "mono": use light gray on a black background.
- *
- *  \li \e "gray": use white and two shades of gray on a black background.
- *
- *  \li \e "8": use the 8 ANSI colours on a black background.
- *
- *  \li \e "16": use the 16 ANSI colours on a black background.
- *
- *  \li \e "fullgray": use black, white and two shades of gray for both the
+ *  bitmap. Valid values for \c str are:
+ *
+ *  \li \c "mono": use light gray on a black background.
+ *
+ *  \li \c "gray": use white and two shades of gray on a black background.
+ *
+ *  \li \c "8": use the 8 ANSI colours on a black background.
+ *
+ *  \li \c "16": use the 16 ANSI colours on a black background.
+ *
+ *  \li \c "fullgray": use black, white and two shades of gray for both the
  *      characters and the background.
  *
- *  \li \e "full8": use the 8 ANSI colours for both the characters and the
+ *  \li \c "full8": use the 8 ANSI colours for both the characters and the
  *      background.
  *
- *  \li \e "full16": use the 16 ANSI colours for both the characters and the
+ *  \li \c "full16": use the 16 ANSI colours for both the characters and the
  *      background. This is the default value.
  *
@@ -515 +515 @@
  *  is a NULL-terminated array of strings, interleaving a string containing
  *  the internal value for the colour mode, to be used with
- *  \e cucul_set_dither_color(), and a string containing the natural
+ *  cucul_set_dither_color(), and a string containing the natural
  *  language description for that colour mode.
  *
@@ -542 +542 @@
  *
  *  Tell the renderer which characters should be used to render the
- *  dither. Valid values for \e str are:
- *
- *  \li \e "ascii": use only ASCII characters. This is the default value.
- *
- *  \li \e "shades": use Unicode characters "U+2591 LIGHT SHADE", "U+2592
+ *  dither. Valid values for \c str are:
+ *
+ *  \li \c "ascii": use only ASCII characters. This is the default value.
+ *
+ *  \li \c "shades": use Unicode characters "U+2591 LIGHT SHADE", "U+2592
  *      MEDIUM SHADE" and "U+2593 DARK SHADE". These characters are also
  *      present in the CP437 codepage available on DOS and VGA.
  *
- *  \li \e "blocks": use Unicode quarter-cell block combinations. These
+ *  \li \c "blocks": use Unicode quarter-cell block combinations. These
  *      characters are only found in the Unicode set.
  *
@@ -581 +581 @@
  *  is a NULL-terminated array of strings, interleaving a string containing
  *  the internal value for the character set, to be used with
- *  \e cucul_set_dither_charset(), and a string containing the natural
+ *  cucul_set_dither_charset(), and a string containing the natural
  *  language description for that character set.
  *
@@ -604 +604 @@
  *  Tell the renderer which dithering method should be used. Dithering is
  *  necessary because the picture being rendered has usually far more colours
- *  than the available palette. Valid values for \e str are:
- *
- *  \li \e "none": no dithering is used, the nearest matching colour is used.
- *
- *  \li \e "ordered2": use a 2x2 Bayer matrix for dithering.
- *
- *  \li \e "ordered4": use a 4x4 Bayer matrix for dithering.
- *
- *  \li \e "ordered8": use a 8x8 Bayer matrix for dithering.
- *
- *  \li \e "random": use random dithering.
- *
- *  \li \e "fstein": use Floyd-Steinberg dithering. This is the default value.
+ *  than the available palette. Valid values for \c str are:
+ *
+ *  \li \c "none": no dithering is used, the nearest matching colour is used.
+ *
+ *  \li \c "ordered2": use a 2x2 Bayer matrix for dithering.
+ *
+ *  \li \c "ordered4": use a 4x4 Bayer matrix for dithering.
+ *
+ *  \li \c "ordered8": use a 8x8 Bayer matrix for dithering.
+ *
+ *  \li \c "random": use random dithering.
+ *
+ *  \li \c "fstein": use Floyd-Steinberg dithering. This is the default value.
  *
  *  \param d Dither object.
@@ -667 +667 @@
  *  is a NULL-terminated array of strings, interleaving a string containing
  *  the internal value for the dithering method, to be used with
- *  \e cucul_set_dither_dithering(), and a string containing the natural
+ *  cucul_set_dither_dithering(), and a string containing the natural
  *  language description for that dithering method.
  *

libcaca/trunk/cucul/export.c

@@ -44 +44 @@
  *  data is valid until cucul_free_buffer() is called.
  *
- *  Valid values for \e format are:
- *
- *  \li \e "caca": export native libcaca files.
- *
- *  \li \e "ansi": export ANSI art (CP437 charset with ANSI colour codes).
- *
- *  \li \e "html": export an HTML page with CSS information.
- *
- *  \li \e "html3": export an HTML table that should be compatible with
+ *  Valid values for \c format are:
+ *
+ *  \li \c "caca": export native libcaca files.
+ *
+ *  \li \c "ansi": export ANSI art (CP437 charset with ANSI colour codes).
+ *
+ *  \li \c "html": export an HTML page with CSS information.
+ *
+ *  \li \c "html3": export an HTML table that should be compatible with
  *      most navigators, including textmode ones.
  *
- *  \li \e "irc": export UTF-8 text with mIRC colour codes.
- *
- *  \li \e "ps": export a PostScript document.
- *
- *  \li \e "svg": export an SVG vector image.
- *
- *  \li \e "tga": export a TGA image.
+ *  \li \c "irc": export UTF-8 text with mIRC colour codes.
+ *
+ *  \li \c "ps": export a PostScript document.
+ *
+ *  \li \c "svg": export an SVG vector image.
+ *
+ *  \li \c "tga": export a TGA image.
  *
  *  \param cv A libcucul canvas
@@ -104 +104 @@
  *  Return a list of available export formats. The list is a NULL-terminated
  *  array of strings, interleaving a string containing the internal value for
- *  the export format, to be used with \e cucul_create_export(), and a string
+ *  the export format, to be used with cucul_create_export(), and a string
  *  containing the natural language description for that export format.
  *

libcaca/trunk/cucul/font.c

@@ -93 +93 @@
  *
  *  This function loads a font and returns a handle to its internal
- *  structure. The handle can then be used with \e cucul_render_canvas()
+ *  structure. The handle can then be used with cucul_render_canvas()
  *  for bitmap output.
  *
- *  Internal fonts can also be loaded: if \e size is set to 0, \e data must
+ *  Internal fonts can also be loaded: if \c size is set to 0, \c data must
  *  be a string containing the internal font name.
  *
- *  If \e size is non-zero, the \e size bytes of memory at address \e data
+ *  If \c size is non-zero, the \c size bytes of memory at address \c data
  *  are loaded as a font. This memory are must not be freed by the calling
- *  program until the font handle has been freed with \e cucul_free_font().
+ *  program until the font handle has been freed with cucul_free_font().
  *
  *  \param data The memory area containing the font or its name.
@@ -219 +219 @@
  *  This function returns the maximum value for the current font's glyphs
  *
- *  \param f The font, as returned by \e cucul_load_font()
+ *  \param f The font, as returned by cucul_load_font()
  *  \return The maximum glyph width.
  */
@@ -231 +231 @@
  *  This function returns the maximum value for the current font's glyphs
  *
- *  \param f The font, as returned by \e cucul_load_font()
+ *  \param f The font, as returned by cucul_load_font()
  *  \return The maximum glyph height.
  */
@@ -241 +241 @@
 /** \brief Free a font structure.
  *
- *  This function frees all data allocated by \e cucul_load_font(). The
+ *  This function frees all data allocated by cucul_load_font(). The
  *  font structure is no longer usable by other libcucul functions. Once
  *  this function has returned, the memory area that was given to
- *  \e cucul_load_font() can be freed.
- *
- *  \param f The font, as returned by \e cucul_load_font()
+ *  cucul_load_font() can be freed.
+ *
+ *  \param f The font, as returned by cucul_load_font()
  */
 void cucul_free_font(cucul_font_t *f)
@@ -261 +261 @@
  *
  *  The required image width can be computed using
- *  \e cucul_get_canvas_width(cv) and \e cucul_get_font_width(f). The required
- *  height can be computed using \e cucul_get_canvas_height(cv) and
- *  \e cucul_get_font_height(f).
+ *  cucul_get_canvas_width() and cucul_get_font_width(). The required
+ *  height can be computed using cucul_get_canvas_height() and
+ *  cucul_get_font_height().
  *
  *  Glyphs that do not fit in the image buffer are currently not rendered at
@@ -269 +269 @@
  *
  *  \param cv The canvas to render
- *  \param f The font, as returned by \e cucul_load_font()
+ *  \param f The font, as returned by cucul_load_font()
  *  \param buf The image buffer
  *  \param width The width (in pixels) of the image buffer