Mercurial > MadButterfly
diff src/shapes.h @ 101:d6f9af55b0d0
More documentation.
1. main page
2. copyright
author | Thinker K.F. Li <thinker@branda.to> |
---|---|
date | Wed, 10 Sep 2008 13:35:56 +0800 |
parents | 7dfa4e60b26d |
children | 565b55508c8d |
line wrap: on
line diff
--- a/src/shapes.h Wed Sep 10 10:02:31 2008 +0800 +++ b/src/shapes.h Wed Sep 10 13:35:56 2008 +0800 @@ -1,10 +1,16 @@ +/*! \file + * \brief Declare interfaces of shapes. + * + * \todo Add ellipse shape. + * \todo Add circle shape. + */ #ifndef __SHAPES_H_ #define __SHAPES_H_ #include <cairo.h> #include "mb_types.h" -/* Define a shape +/*! \page define_shape How to Define Shapes * * A shape must include * - *_new() and *_free() @@ -14,32 +20,43 @@ * - struct of shape must include an shape_t as type of first member. * * Must modify - * - event.c:draw_shape_path - * - redraw_man.c:clean_shape - * - redraw_man.c:draw_shape - * - * \todo Add arc for path shape. - * \todo Add ellipse shape. - * \todo Add circle shape. + * - event.c::draw_shape_path() + * - redraw_man.c::clean_shape() + * - redraw_man.c::draw_shape() */ +/*! \defgroup shapes Shapes + * @{ + */ +/*! \defgroup shape_path Shape of Path + * @{ + */ extern shape_t *sh_path_new(char *data); extern void sh_path_transform(shape_t *shape); extern void sh_path_draw(shape_t *shape, cairo_t *cr); +/* @} */ - +/*! \defgroup shape_text Shape of Text + * @{ + */ extern shape_t *sh_text_new(const char *txt, co_aix x, co_aix y, co_aix font_size, cairo_font_face_t *face); extern void sh_text_set_text(shape_t *shape, const char *txt); extern void sh_text_transform(shape_t *shape); extern void sh_text_draw(shape_t *shape, cairo_t *cr); +/* @} */ +/*! \defgroup shape_rect Shape of Rectangle + * @{ + */ extern shape_t *sh_rect_new(co_aix x, co_aix y, co_aix w, co_aix h, co_aix rx, co_aix ry); extern void sh_rect_transform(shape_t *shape); extern void sh_rect_draw(shape_t *shape, cairo_t *cr); extern void sh_rect_set(shape_t *shape, co_aix x, co_aix y, co_aix w, co_aix h, co_aix rx, co_aix ry); +/* @} */ +/* @} */ #endif /* __SHAPES_H_ */