# HG changeset patch # User Thinker K.F. Li # Date 1290581117 -28800 # Node ID 1f93f38688c2ce402b46aaa9b3326769968d6b65 # Parent 8679b03f72e8465f1f1bef7b83850d3d27c8aec6 Define doxygen groups for symbols of rdman. diff -r 8679b03f72e8 -r 1f93f38688c2 include/mb_redraw_man.h --- a/include/mb_redraw_man.h Wed Nov 24 14:19:00 2010 +0800 +++ b/include/mb_redraw_man.h Wed Nov 24 14:45:17 2010 +0800 @@ -9,8 +9,14 @@ #include "mb_observer.h" #include "mb_img_ldr.h" +/*! \defgroup rdman Redraw Manager + * @{ + */ typedef struct _redraw_man redraw_man_t; +/*! \defgroup rdman_private Private Types of Redraw Manager + * @{ + */ typedef void (*free_func_t)(redraw_man_t *rdman, void *obj); struct _free_obj { void *obj; @@ -25,6 +31,7 @@ DARRAY(coords, coord_t *); DARRAY(geos, geo_t *); +/* @} */ /*! \brief Manage redrawing of shapes (graphic elements). * @@ -147,6 +154,10 @@ } \ shnode_free(rdman, __last); \ } while(0) + +/*! \defgroup rdman_paints Paints Supporting of Redraw Manger + * @{ + */ #define _rdman_paint_child(rdman, paint, shape) \ do { \ shnode_t *__node; \ @@ -190,13 +201,22 @@ (shape)->stroke = paint; \ } while(0) extern int rdman_paint_changed(redraw_man_t *rdman, paint_t *paint); +/* @} */ +/*! \defgroup rdman_pos Position/Overlay Detection for Managed Objects + * @{ + */ extern shape_t *find_shape_at_pos(redraw_man_t *rdman, co_aix x, co_aix y, int *in_stroke); extern int mb_obj_pos_is_in(redraw_man_t *rdman, mb_obj_t *obj, co_aix x, co_aix y, int *in_stroke); extern int mb_objs_are_overlay(redraw_man_t *rdman, mb_obj_t *obj1, mb_obj_t *obj2); +/* @} */ + +/*! \defgroup rdman_accessors Accessors of Redraw Manager + * @{ + */ #define rdman_get_ob_factory(rdman) (&(rdman)->ob_factory) #define rdman_get_redraw_subject(rdman) ((rdman)->redraw) #define rdman_get_root(rdman) ((rdman)->root_coord) @@ -215,6 +235,7 @@ #define rdman_img_ldr(rdman) ((rdman)->img_ldr) #define rdman_set_img_ldr(rdman, ldr) \ do { (rdman)->img_ldr = ldr; } while(0) +/* @} */ /*! \brief Attach backend to the redraw manager so that we can hide the backend from the users. * @@ -223,5 +244,6 @@ extern paint_t *rdman_img_ldr_load_paint(redraw_man_t *rdman, const char *img_id); +/* @} */ #endif /* __REDRAW_MAN_H_ */