@@ -1,7 +1,7 @@ | |||||
# $Id$ | # $Id$ | ||||
EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS) \ | EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS) \ | ||||
libcaca.dox user.dox migrating.dox tutorial.dox | |||||
libcaca.dox user.dox migrating.dox tutorial.dox style.dox | |||||
man_MANS = caca-config.1 cacafire.1 cacaview.1 | man_MANS = caca-config.1 cacafire.1 cacaview.1 | ||||
@@ -35,6 +35,10 @@ | |||||
- \subpage tutorial | - \subpage tutorial | ||||
- \subpage migrating | - \subpage migrating | ||||
There is also information specially targeted at \e libcaca developers: | |||||
- \subpage style | |||||
\section user User's documentation | \section user User's documentation | ||||
- \subpage env | - \subpage env | ||||
@@ -1,8 +1,8 @@ | |||||
/* $Id$ */ | /* $Id$ */ | ||||
/** \page migrating Migrating from libcaca 0.9 to the 1.0 API | |||||
/** \page migrating Migrating from libcaca 0.x to the 1.0 API | |||||
This section will guide you through the migration of a \e libcaca 0.9 | |||||
This section will guide you through the migration of a \e libcaca 0.x | |||||
application to the latest API version. | application to the latest API version. | ||||
\section foo1 Overview | \section foo1 Overview | ||||
@@ -0,0 +1,7 @@ | |||||
/* $Id$ */ | |||||
/** \page style Coding style | |||||
Code qui fait des warnings == code de porc == deux baffes dans ta gueule | |||||
*/ |
@@ -0,0 +1,35 @@ | |||||
/* $Id$ */ | |||||
/** \page tutorial A libcucul and libcaca tutorial | |||||
Super short example: | |||||
\code | |||||
#include <cucul.h> | |||||
#include <caca.h> | |||||
int main(void) | |||||
{ | |||||
/* Initialise libcaca */ | |||||
cucul_canvas_t *cv; caca_display_t *dp; caca_event_t ev; | |||||
cv = cucul_create_canvas(0, 0); | |||||
dp = caca_create_display(cv); | |||||
/* Set window title */ | |||||
caca_set_display_title(dp, "Hello!"); | |||||
/* Choose drawing colours */ | |||||
cucul_set_color(cv, CUCUL_COLOR_BLACK, CUCUL_COLOR_WHITE); | |||||
/* Draw a string at coordinates (0, 0) */ | |||||
cucul_putstr(cv, 0, 0, "This is a message"); | |||||
/* Refresh display */ | |||||
caca_refresh_display(); | |||||
/* Wait for a key press event */ | |||||
caca_get_event(dp, CACA_EVENT_KEY_PRESS, &ev, -1); | |||||
/* Clean up library */ | |||||
caca_free_display(dp); | |||||
cucul_free_canvas(cv); | |||||
return 0; | |||||
} | |||||
\endcode | |||||
*/ |