Changeset 3473 for libcacaTweet

Timestamp:

May 19, 2009, 2:52:10 AM (12 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:

• caca/event.c (modified) (1 diff)
• doc/doxygen.cfg.in (modified) (1 diff)
• doc/migrating.dox (modified) (5 diffs)
• doc/style.dox (modified) (1 diff)
• doc/tutorial.dox (modified) (1 diff)
• doc/user.dox (modified) (1 diff)
• ruby/ruby-caca.dox (modified) (4 diffs)

libcaca/trunk/caca/event.c

@@ -230 +230 @@
  *
  *  \param ev The libcaca event.
+ *  \param utf8 A string buffer with enough bytes to hold the pressed
+ *              key value in UTF-8. Though fewer bytes may be written to
+ *              it, 7 bytes is the minimum safe size.
  *  \return This function always returns 0.
  */

libcaca/trunk/doc/doxygen.cfg.in

@@ -568 +568 @@
                          @top_srcdir@/doc \
                          @top_srcdir@/caca \
+                         @top_srcdir@/caca/codec \
+                         @top_srcdir@/caca/driver \
                          @top_srcdir@/ruby
 

libcaca/trunk/doc/migrating.dox

@@ -48 +48 @@
     caca_canvas_t *cv;
     caca_display_t *dp;
-    dp = caca_create_display(cv);
+    dp = caca_create_display(NULL);
     cv = caca_get_canvas(dp);
     /* Set window title */
@@ -72 +72 @@
  Note the following important things:
 
- - Functions now take an object handle as their first argument.
- - All input/output functions start with \b caca_ and all
-   drawing and text handling functions start with \b caca_ .
+ - Most functions now take an object handle as their first argument.
 
  \section foo2 Migration strategy
@@ -105 +103 @@
 \endcode
 </td></tr></table>
+
+ The modified code is guaranteed to build both with \e libcaca 0.x and
+ \e libcaca 1.0.
 
  \section foo3 Function equivalence list
@@ -147 +148 @@
  - \b caca_putchar(): use caca_put_char().
  - \b caca_putstr(): use caca_put_str().
- - \b caca_printf(): use caca_printf().
+ - \b caca_printf(): unchanged.
  - \b caca_clear(): use caca_clear_canvas().
 
@@ -155 +156 @@
  fact that they now act on a given canvas.
 
- - \b caca_draw_line(): use caca_draw_line().
- - \b caca_draw_polyline(): use caca_draw_polyline().
- - \b caca_draw_thin_line(): use caca_draw_thin_line().
- - \b caca_draw_thin_polyline(): use caca_draw_thin_polyline().
-
- - \b caca_draw_circle(): use caca_draw_circle().
- - \b caca_draw_ellipse(): use caca_draw_ellipse().
- - \b caca_draw_thin_ellipse(): use caca_draw_thin_ellipse().
- - \b caca_fill_ellipse(): use caca_fill_ellipse().
-
- - \b caca_draw_box(): use caca_draw_box().
+ - \b caca_draw_line(): unchanged.
+ - \b caca_draw_polyline(): unchanged.
+ - \b caca_draw_thin_line(): unchanged.
+ - \b caca_draw_thin_polyline(): unchanged.
+
+ - \b caca_draw_circle(): unchanged.
+ - \b caca_draw_ellipse(): unchanged.
+ - \b caca_draw_thin_ellipse(): unchanged.
+ - \b caca_fill_ellipse(): unchanged.
+
+ - \b caca_draw_box(): unchanged.
  - \b caca_draw_thin_box(): use caca_draw_thin_box() or caca_draw_cp437_box().
- - \b caca_fill_box(): use caca_fill_box().
-
- - \b caca_draw_triangle(): use caca_draw_triangle().
- - \b caca_draw_thin_triangle(): use caca_draw_thin_triangle().
- - \b caca_fill_triangle(): use caca_fill_triangle().
+ - \b caca_fill_box(): unchanged.
+
+ - \b caca_draw_triangle(): unchanged.
+ - \b caca_draw_thin_triangle(): unchanged.
+ - \b caca_fill_triangle(): unchanged.
 
  \subsection bar5 Mathematical functions
 
- - \b caca_rand(): use caca_rand(). The second argument is different, make
+ - \b caca_rand(): unchanged, but the second argument is different, make
    sure you take that into account.
  - \b caca_sqrt(): this function is now deprecated, use your system's

libcaca/trunk/doc/style.dox

@@ -48 +48 @@
  \code
 int function(int);
+ \endcode
 
+ A space can be inserted after keywords such as \c for, \c while or \c if,
+ but consistency with the rest of the page is encouraged:
+
+ \code
 if(a == b)
     return;
+
+if (p == NULL)
  \endcode
 

libcaca/trunk/doc/tutorial.dox

@@ -39 +39 @@
    nothing otherwise).
  - Set the current canvas colours to black background and white foreground.
- - Write the string "This is a message" using the current colors onto the
-   canvas.
- - Refresh the display.
- - Wait for an event of type "CACA_EVENT_KEY_PRESS".
+ - Write the string \c "This is a message" onto the canvas, using the current
+   colour pair.
+ - Refresh the display, causing the text to be effectively displayed.
+ - Wait for an event of type \c CACA_EVENT_KEY_PRESS.
  - Free the display (release memory). Since it was created together with the
    display, the canvas will be automatically freed as well.
 
 You can then compile this code on an UNIX-like system using the following
-comman (requiring pkg-config and gcc):
+commans (requiring \c pkg-config and \c gcc):
 \code
 gcc `pkg-config --libs --cflags caca` example.c -o example

libcaca/trunk/doc/user.dox

@@ -4 +4 @@
 
  Some environment variables can be used to change the behaviour of
- \e libcaca without having to modify the program which uses them. These
+ \e libcaca without having to modify the program which uses it. These
  variables are:
 

libcaca/trunk/ruby/ruby-caca.dox

@@ -1 +1 @@
 /*$Id$ */ /** \page libcaca-ruby-api Libcaca Ruby API
 
-Theclasses available for libcaca are :
+The classes available for libcaca are :
 
 \li\b Caca::Canvas : functions that have a caca_canvas_t* as first argument
@@ -19 +19 @@
 \li\b Caca::Event::Quit
 
-Thecharacter set conversion functions are not available yet in the binding.
+The character set conversion functions are not available yet in the binding.
 
 \code
@@ -118 +118 @@
 \endcode
 
-\sectionSamples
+\section Samples
 
 \code
@@ -133 +133 @@
 [5,2],[0,0]]).export_memory("irc")'
 -.
-|`.  
+| `.
 ----`-
 \endcode