Changeset 3473 for libcaca/trunk


Ignore:
Timestamp:
May 19, 2009, 2:52:10 AM (10 years ago)
Author:
Sam Hocevar
Message:

A lot of documentation updates here and there, including bugfixes dating
back to the libcucul merge.

Location:
libcaca/trunk
Files:
7 edited

Legend:

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

    r2821 r3473  
    230230 *
    231231 *  \param ev The libcaca event.
     232 *  \param utf8 A string buffer with enough bytes to hold the pressed
     233 *              key value in UTF-8. Though fewer bytes may be written to
     234 *              it, 7 bytes is the minimum safe size.
    232235 *  \return This function always returns 0.
    233236 */
  • libcaca/trunk/doc/doxygen.cfg.in

    r3472 r3473  
    568568                         @top_srcdir@/doc \
    569569                         @top_srcdir@/caca \
     570                         @top_srcdir@/caca/codec \
     571                         @top_srcdir@/caca/driver \
    570572                         @top_srcdir@/ruby
    571573
  • libcaca/trunk/doc/migrating.dox

    r2824 r3473  
    4848    caca_canvas_t *cv;
    4949    caca_display_t *dp;
    50     dp = caca_create_display(cv);
     50    dp = caca_create_display(NULL);
    5151    cv = caca_get_canvas(dp);
    5252    /* Set window title */
     
    7272 Note the following important things:
    7373
    74  - Functions now take an object handle as their first argument.
    75  - All input/output functions start with \b caca_ and all
    76    drawing and text handling functions start with \b caca_ .
     74 - Most functions now take an object handle as their first argument.
    7775
    7876 \section foo2 Migration strategy
     
    105103\endcode
    106104</td></tr></table>
     105
     106 The modified code is guaranteed to build both with \e libcaca 0.x and
     107 \e libcaca 1.0.
    107108
    108109 \section foo3 Function equivalence list
     
    147148 - \b caca_putchar(): use caca_put_char().
    148149 - \b caca_putstr(): use caca_put_str().
    149  - \b caca_printf(): use caca_printf().
     150 - \b caca_printf(): unchanged.
    150151 - \b caca_clear(): use caca_clear_canvas().
    151152
     
    155156 fact that they now act on a given canvas.
    156157
    157  - \b caca_draw_line(): use caca_draw_line().
    158  - \b caca_draw_polyline(): use caca_draw_polyline().
    159  - \b caca_draw_thin_line(): use caca_draw_thin_line().
    160  - \b caca_draw_thin_polyline(): use caca_draw_thin_polyline().
    161 
    162  - \b caca_draw_circle(): use caca_draw_circle().
    163  - \b caca_draw_ellipse(): use caca_draw_ellipse().
    164  - \b caca_draw_thin_ellipse(): use caca_draw_thin_ellipse().
    165  - \b caca_fill_ellipse(): use caca_fill_ellipse().
    166 
    167  - \b caca_draw_box(): use caca_draw_box().
     158 - \b caca_draw_line(): unchanged.
     159 - \b caca_draw_polyline(): unchanged.
     160 - \b caca_draw_thin_line(): unchanged.
     161 - \b caca_draw_thin_polyline(): unchanged.
     162
     163 - \b caca_draw_circle(): unchanged.
     164 - \b caca_draw_ellipse(): unchanged.
     165 - \b caca_draw_thin_ellipse(): unchanged.
     166 - \b caca_fill_ellipse(): unchanged.
     167
     168 - \b caca_draw_box(): unchanged.
    168169 - \b caca_draw_thin_box(): use caca_draw_thin_box() or caca_draw_cp437_box().
    169  - \b caca_fill_box(): use caca_fill_box().
    170 
    171  - \b caca_draw_triangle(): use caca_draw_triangle().
    172  - \b caca_draw_thin_triangle(): use caca_draw_thin_triangle().
    173  - \b caca_fill_triangle(): use caca_fill_triangle().
     170 - \b caca_fill_box(): unchanged.
     171
     172 - \b caca_draw_triangle(): unchanged.
     173 - \b caca_draw_thin_triangle(): unchanged.
     174 - \b caca_fill_triangle(): unchanged.
    174175
    175176 \subsection bar5 Mathematical functions
    176177
    177  - \b caca_rand(): use caca_rand(). The second argument is different, make
     178 - \b caca_rand(): unchanged, but the second argument is different, make
    178179   sure you take that into account.
    179180 - \b caca_sqrt(): this function is now deprecated, use your system's
  • libcaca/trunk/doc/style.dox

    r1879 r3473  
    4848 \code
    4949int function(int);
     50 \endcode
    5051
     52 A space can be inserted after keywords such as \c for, \c while or \c if,
     53 but consistency with the rest of the page is encouraged:
     54
     55 \code
    5156if(a == b)
    5257    return;
     58
     59if (p == NULL)
    5360 \endcode
    5461
  • libcaca/trunk/doc/tutorial.dox

    r2879 r3473  
    3939   nothing otherwise).
    4040 - Set the current canvas colours to black background and white foreground.
    41  - Write the string "This is a message" using the current colors onto the
    42    canvas.
    43  - Refresh the display.
    44  - Wait for an event of type "CACA_EVENT_KEY_PRESS".
     41 - Write the string \c "This is a message" onto the canvas, using the current
     42   colour pair.
     43 - Refresh the display, causing the text to be effectively displayed.
     44 - Wait for an event of type \c CACA_EVENT_KEY_PRESS.
    4545 - Free the display (release memory). Since it was created together with the
    4646   display, the canvas will be automatically freed as well.
    4747
    4848You can then compile this code on an UNIX-like system using the following
    49 comman (requiring pkg-config and gcc):
     49commans (requiring \c pkg-config and \c gcc):
    5050\code
    5151gcc `pkg-config --libs --cflags caca` example.c -o example
  • libcaca/trunk/doc/user.dox

    r1879 r3473  
    44
    55 Some environment variables can be used to change the behaviour of
    6  \e libcaca without having to modify the program which uses them. These
     6 \e libcaca without having to modify the program which uses it. These
    77 variables are:
    88
  • libcaca/trunk/ruby/ruby-caca.dox

    r2822 r3473  
    11/*$Id$ */ /** \page libcaca-ruby-api Libcaca Ruby API
    22
    3 Theclasses available for libcaca are :
     3The classes available for libcaca are :
    44
    55\li\b Caca::Canvas : functions that have a caca_canvas_t* as first argument
     
    1919\li\b Caca::Event::Quit
    2020
    21 Thecharacter set conversion functions are not available yet in the binding.
     21The character set conversion functions are not available yet in the binding.
    2222
    2323\code
     
    118118\endcode
    119119
    120 \sectionSamples
     120\section Samples
    121121
    122122\code
     
    133133[5,2],[0,0]]).export_memory("irc")'
    134134-.
    135 |`. 
     135| `.
    136136----`-
    137137\endcode
Note: See TracChangeset for help on using the changeset viewer.