box, bubble, calendar: Fix and clean up doxygen documentation.

2014-11-20 23:29:17 +09:00 · 2014-11-20 23:29:17 +09:00 · e23421f2e9
parent 0b820975b6
commit e23421f2e9
3 changed files with 54 additions and 63 deletions
--- a/legacy/elementary/src/lib/elm_box_common.h
+++ b/legacy/elementary/src/lib/elm_box_common.h
@ -1,3 +1,9 @@
+/**
+ * @addtogroup Box
+ *
+ * @{
+ */
+
 /**
 * @typedef Elm_Box_Transition
 *
@ -41,8 +47,6 @@ typedef struct _Elm_Box_Transition Elm_Box_Transition;
 * @see elm_box_transition_new
 * @see elm_box_transition_free
 * @see elm_box_layout_set
- *
- * @ingroup Box
 */
 EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);

@ -76,8 +80,6 @@ EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object
 *
 * @see elm_box_transition_new
 * @see elm_box_layout_transition
- *
- * @ingroup Box
 */
 EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Object_Box_Layout start_layout, void *start_layout_data, Ecore_Cb start_layout_free_data, Evas_Object_Box_Layout end_layout, void *end_layout_data, Ecore_Cb end_layout_free_data, Ecore_Cb transition_end_cb, void *transition_end_data);

@ -91,7 +93,9 @@ EAPI Elm_Box_Transition *elm_box_transition_new(const double duration, Evas_Obje
 *
 * @see elm_box_transition_new
 * @see elm_box_layout_transition
- *
- * @ingroup Box
 */
 EAPI void                elm_box_transition_free(void *data);
+
+/**
+ * @}
+ */
--- a/legacy/elementary/src/lib/elm_bubble_common.h
+++ b/legacy/elementary/src/lib/elm_bubble_common.h
@ -1,3 +1,9 @@
+/**
+ * @addtogroup Bubble
+ *
+ * @{
+ */
+
 /**
 * Defines the corner values for a bubble.
 *
@ -13,3 +19,6 @@ typedef enum
  ELM_BUBBLE_POS_BOTTOM_RIGHT, /**< the arrow of the bubble points to the bottom right corner. */
 } Elm_Bubble_Pos;

+/**
+ * @}
+ */
--- a/legacy/elementary/src/lib/elm_calendar_common.h
+++ b/legacy/elementary/src/lib/elm_calendar_common.h
@ -1,17 +1,10 @@
-typedef enum
-{
-   ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
-   ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
-   ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
-   ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
-   ELM_CALENDAR_ANNUALLY, /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
-   ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive).  @since 1.7 */
-} _Elm_Calendar_Mark_Repeat_Type;
-
 /**
- * @enum _Elm_Calendar_Mark_Repeat_Type
- * @typedef Elm_Calendar_Mark_Repeat_Type
+ * @addtogroup Calendar
 *
+ * @{
+ */
+/**
+ * @enum Elm_Calendar_Mark_Repeat_Type
 * Event periodicity, used to define if a mark should be repeated
 * @b beyond event's day. It's set when a mark is added.
 *
@ -22,11 +15,23 @@ typedef enum
 * Values don't work as bitmask, only one can be chosen.
 *
 * @see elm_calendar_mark_add()
- *
- * @ingroup Calendar
 */
-typedef _Elm_Calendar_Mark_Repeat_Type Elm_Calendar_Mark_Repeat_Type;
+typedef enum
+{
+   ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
+   ELM_CALENDAR_DAILY, /**< Marks will be displayed every day after event day (inclusive). */
+   ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
+   ELM_CALENDAR_MONTHLY, /**< Marks will be displayed every month day that coincides to event day. E.g.: if an event is set to 30th Jan, no marks will be displayed on Feb, but will be displayed on 30th Mar*/
+   ELM_CALENDAR_ANNUALLY, /**< Marks will be displayed every year that coincides to event day (and month). E.g. an event added to 30th Jan 2012 will be repeated on 30th Jan 2013. */
+   ELM_CALENDAR_LAST_DAY_OF_MONTH /**< Marks will be displayed every last day of month after event day (inclusive).  @since 1.7 */
+} Elm_Calendar_Mark_Repeat_Type;

+/**
+ * @enum Elm_Calendar_Weekday
+ * A weekday
+ *
+ * @see elm_calendar_first_day_of_week_set()
+ */
 typedef enum
 {
   ELM_DAY_SUNDAY,
@ -37,68 +42,44 @@ typedef enum
   ELM_DAY_FRIDAY,
   ELM_DAY_SATURDAY,
   ELM_DAY_LAST
-} _Elm_Calendar_Weekday;
+} Elm_Calendar_Weekday;

 /**
- * @enum _Elm_Calendar_Weekday
- * @typedef Elm_Calendar_Weekday
+ * @enum Elm_Calendar_Select_Mode
 *
- * a weekday
+ * The mode, who determine how user could select a day
 *
- * @see elm_calendar_first_day_of_week_set()
- *
- * @ingroup Calendar
+ * @see elm_calendar_select_mode_set()
 */
-typedef _Elm_Calendar_Weekday Elm_Calendar_Weekday;
-
-
 typedef enum
 {
   ELM_CALENDAR_SELECT_MODE_DEFAULT = 0, /**< Default value. a day is always selected. */
   ELM_CALENDAR_SELECT_MODE_ALWAYS, /**< a day is always selected. */
   ELM_CALENDAR_SELECT_MODE_NONE, /**< None of the days can be selected. */
   ELM_CALENDAR_SELECT_MODE_ONDEMAND /**< User may have selected a day or not. */
-} _Elm_Calendar_Select_Mode;
+} Elm_Calendar_Select_Mode;

 /**
- * @enum _Elm_Calendar_Select_Mode
- * @typedef Elm_Calendar_Select_Mode
+ * @Elm_Calendar_Selectable
 *
- * the mode, who determine how user could select a day
+ * A bitmask used to define which fields of a @b tm struct will be taken into
+ * account, when elm_calendar_selected_time_set() is invoked.
 *
- * @see elm_calendar_select_mode_set()
- *
- * @ingroup Calendar
+ * @see elm_calendar_selectable_set()
+ * @see elm_calendar_selected_time_set()
+ * @since 1.8
 */
-typedef _Elm_Calendar_Select_Mode Elm_Calendar_Select_Mode;
-
 typedef enum
 {
   ELM_CALENDAR_SELECTABLE_NONE = 0,
   ELM_CALENDAR_SELECTABLE_YEAR = (1 << 0),
   ELM_CALENDAR_SELECTABLE_MONTH = (1 << 1),
   ELM_CALENDAR_SELECTABLE_DAY = (1 << 2)
-} _Elm_Calendar_Selectable;
-
-/**
- * @enum _Elm_Calendar_Selectable
- * @typedef Elm_Calendar_Selectable
- *
- * A bitmask used to define which fields of a @b tm struct will be taken into
- * account, when elm_calendar_selected_time_set() is invoked.
- *
- * @ingroup Calendar
- * @see elm_calendar_selectable_set()
- * @see elm_calendar_selected_time_set()
- * @since 1.8
- */
-typedef _Elm_Calendar_Selectable Elm_Calendar_Selectable;
+} Elm_Calendar_Selectable;

 typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;    /**< Item handle for a calendar mark. Created with elm_calendar_mark_add() and deleted with elm_calendar_mark_del(). */

 /**
- * @typedef Elm_Calendar_Format_Cb
- *
 * This callback type is used to format the string that will be used
 * to display month and year.
 *
@ -106,8 +87,6 @@ typedef struct _Elm_Calendar_Mark Elm_Calendar_Mark;    /**< Item handle for a c
 * @return String representing time that will be set to calendar's text.
 *
 * @see elm_calendar_format_function_set()
- *
- * @ingroup Calendar
 */
 typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);

@ -137,8 +116,6 @@ typedef char * (*Elm_Calendar_Format_Cb)(struct tm *stime);
 * @see elm_calendar_weekdays_name_get()
 *
 * @ref calendar_example_02
- *
- * @ingroup Calendar
 */
 EAPI void                 elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]);

@ -153,8 +130,9 @@ EAPI void                 elm_calendar_weekdays_names_set(Evas_Object *obj, cons
 * @see elm_calendar_mark_add()
 *
 * @ref calendar_example_06
- *
- * @ingroup Calendar
 */
 EAPI void                 elm_calendar_mark_del(Elm_Calendar_Mark *mark);

+/**
+ * @}
+ */