Changeset 1104 for libcacaTweet

Timestamp:

Sep 25, 2006, 6:00:10 PM (16 years ago)

Author:

Sam Hocevar

Message:

• Fix enumeration layout in the manpage documentation.

Location:

libcaca/trunk

Files:

• TODO (modified) (1 diff)
• caca/caca.h (modified) (2 diffs)
• cucul/dither.c (modified) (4 diffs)
• cucul/export.c (modified) (1 diff)
• cucul/import.c (modified) (1 diff)

libcaca/trunk/TODO

@@ -13 +13 @@
   - Error distribution dithering
   - Add a random factor to the random ditherer. No need to change the API
-     for that, we can just pass "random:10" instead of "random" to the
+     for that, we can just pass \c "random:10" instead of \c "random" to the
      cucul_set_bitmap_dithering() function.
   - Implement the colour modes set in cucul_set_bitmap_color(). For the
-     moment only "full16" and "16" are implemented.
+     moment only \c "full16" and \c "16" are implemented.
   - Fix the thin ellipse rendering (currently it's only |s and -s, we
      could make them smoother by using ' ` , etc).

libcaca/trunk/caca/caca.h

@@ -44 +44 @@
  *  The \e type field is always valid. The validity of the \e data union
  *  depends on the value of the \e type field:
- *
- *  \li \b CACA_EVENT_NONE: no other field is valid.
- *
- *  \li \b CACA_EVENT_KEY_PRESS, \b CACA_EVENT_KEY_RELEASE: the \e data.key.ch
+ *  - \b CACA_EVENT_NONE: no other field is valid.
+ *  - \b CACA_EVENT_KEY_PRESS, \b CACA_EVENT_KEY_RELEASE: the \e data.key.ch
  *      field is valid and contains either the ASCII value for the key, or
  *      an \e enum \e caca_key value. If the value is a printable ASCII
@@ -54 +52 @@
  *      representations of the character. Otherwise, their content is
  *      undefined.
- *
- *  \li \b CACA_EVENT_MOUSE_PRESS, \b CACA_EVENT_MOUSE_RELEASE: the
+ *  - \b CACA_EVENT_MOUSE_PRESS, \b CACA_EVENT_MOUSE_RELEASE: the
  *      \e data.mouse.button field is valid and contains the index of the
  *      mouse button that was pressed.
- *
- *  \li \b CACA_EVENT_MOUSE_MOTION: the \e data.mouse.x and \e data.mouse.y
+ *  - \b CACA_EVENT_MOUSE_MOTION: the \e data.mouse.x and \e data.mouse.y
  *      fields are valid and contain the mouse coordinates in character
  *      cells.
- *
- *  \li \b CACA_EVENT_RESIZE: the \e data.resize.w and \e data.resize.h
+ *  - \b CACA_EVENT_RESIZE: the \e data.resize.w and \e data.resize.h
  *      fields are valid and contain the new width and height values of
  *      the \e libcucul canvas attached to \e libcaca.
- *
- *  \li \b CACA_EVENT_QUIT: no other field is valid.
+ *  - \b CACA_EVENT_QUIT: no other field is valid.
  *
  *  The result of accessing data members outside the above conditions is

libcaca/trunk/cucul/dither.c

@@ -490 +490 @@
  *  Tell the renderer whether to antialias the dither. Antialiasing smoothens
  *  the rendered image and avoids the commonly seen staircase effect.
- *
- *  \li \c "none": no antialiasing.
- *
- *  \li \c "prefilter" or \c "default": simple prefilter antialiasing. This
- *      is the default value.
+ *  - \c "none": no antialiasing.
+ *  - \c "prefilter" or \c "default": simple prefilter antialiasing. This
+ *    is the default value.
  *
  *  If an error occurs, -1 is returned and \b errno is set accordingly:
@@ -551 +549 @@
  *  Tell the renderer which colours should be used to render 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 \c "full8": use the 8 ANSI colours for both the characters and the
- *      background.
- *
- *  \li \c "full16" or \c "default": use the 16 ANSI colours for both the
- *      characters and the background. This is the default value.
+ *  - \c "mono": use light gray on a black background.
+ *  - \c "gray": use white and two shades of gray on a black background.
+ *  - \c "8": use the 8 ANSI colours on a black background.
+ *  - \c "16": use the 16 ANSI colours on a black background.
+ *  - \c "fullgray": use black, white and two shades of gray for both the
+ *    characters and the background.
+ *  - \c "full8": use the 8 ANSI colours for both the characters and the
+ *    background.
+ *  - \c "full16" or \c "default": use the 16 ANSI colours for both the
+ *    characters and the background. This is the default value.
  *
  *  If an error occurs, -1 is returned and \b errno is set accordingly:
@@ -639 +630 @@
  *  Tell the renderer which characters should be used to render the
  *  dither. Valid values for \c str are:
- *
- *  \li \c "ascii" or "default": 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 \c "blocks": use Unicode quarter-cell block combinations. These
- *      characters are only found in the Unicode set.
+ *  - \c "ascii" or \c "default": use only ASCII characters. This is the
+ *    default value.
+ *  - \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.
+ *  - \c "blocks": use Unicode quarter-cell block combinations. These
+ *    characters are only found in the Unicode set.
  *
  *  If an error occurs, -1 is returned and \b errno is set accordingly:
@@ -717 +705 @@
  *  necessary because the picture being rendered has usually far more colours
  *  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.
+ *  - \c "none": no dithering is used, the nearest matching colour is used.
+ *  - \c "ordered2": use a 2x2 Bayer matrix for dithering.
+ *  - \c "ordered4": use a 4x4 Bayer matrix for dithering.
+ *  - \c "ordered8": use a 8x8 Bayer matrix for dithering.
+ *  - \c "random": use random dithering.
+ *  - \c "fstein": use Floyd-Steinberg dithering. This is the default value.
  *
  *  If an error occurs, -1 is returned and \b errno is set accordingly:

libcaca/trunk/cucul/export.c

@@ -50 +50 @@
  *
  *  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 \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.
+ *  - \c "caca": export native libcaca files.
+ *  - \c "ansi": export ANSI art (CP437 charset with ANSI colour codes).
+ *  - \c "html": export an HTML page with CSS information.
+ *  - \c "html3": export an HTML table that should be compatible with
+ *    most navigators, including textmode ones.
+ *  - \c "irc": export UTF-8 text with mIRC colour codes.
+ *  - \c "ps": export a PostScript document.
+ *  - \c "svg": export an SVG vector image.
+ *  - \c "tga": export a TGA image.
  *
  *  If an error occurs, NULL is returned and \b errno is set accordingly:

libcaca/trunk/cucul/import.c

@@ -52 +52 @@
  *
  *  Valid values for \c format are:
- *
- *  \li \c "": attempt to autodetect the file format.
- *
- *  \li \c "ansi": import ANSI files.
- *
- *  \li \c "caca": import native libcaca files.
+ *  - \c "": attempt to autodetect the file format.
+ *  - \c "ansi": import ANSI files.
+ *  - \c "caca": import native libcaca files.
  *
  *  If an error occurs, NULL is returned and \b errno is set accordingly: