[elementary] Documenting/exemplifying the following:
[framework/uifw/elementary.git] / src / lib / elm_clock.c
index f2abe28..ad8565b 100644 (file)
@@ -1,17 +1,6 @@
 #include <Elementary.h>
 #include "elm_priv.h"
 
-/**
- * @defgroup Clock Clock
- *
- * It's a widget to show clock with animation. The update of time is
- * shown in an animation like the flip of a sheet.
- *
- * Signals that you can add callbacks for are:
- *
- * "changed" - the user changed the time
- */
-
 typedef struct _Widget_Data Widget_Data;
 
 struct _Widget_Data
@@ -524,16 +513,6 @@ _time_update(Evas_Object *obj)
      wd->cur.ampm = -1;
 }
 
-/**
- * Add a new clock to the parent
- *
- * @param parent The parent object
- *
- * This function inserts a clock widget on a given canvas to show a
- * animated clock.
- *
- * @ingroup Clock
- */
 EAPI Evas_Object *
 elm_clock_add(Evas_Object *parent)
 {
@@ -574,18 +553,6 @@ elm_clock_add(Evas_Object *parent)
    return obj;
 }
 
-/**
- * Set the clock time
- *
- * @param obj The clock object
- * @param hrs The hours to set
- * @param min The minutes to set
- * @param sec The secondes to set
- *
- * This function updates the time that is showed by the clock widget
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec)
 {
@@ -599,22 +566,6 @@ elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec)
    _time_update(obj);
 }
 
-/**
- * Get clock time
- *
- * @param obj The clock object
- * @param hrs Pointer to the variable to get the hour of this clock
- * object
- * @param min Pointer to the variable to get the minute of this clock
- * object
- * @param sec Pointer to the variable to get the second of this clock
- * object
- *
- * This function gets the time set of the clock widget and returns it
- * on the variables passed as the arguments to function
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec)
 {
@@ -626,19 +577,6 @@ elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec)
    if (sec) *sec = wd->sec;
 }
 
-/**
- * Set if the clock settings can be edited
- *
- * @param obj The clock object
- * @param edit Bool option for edited (1 = yes, 0 = no)
- *
- * This function sets if the clock settings can be edited or not.
- * By default or if digit_edit option was previously set to ELM_CLOCK_NONE,
- * all digits are editable. To choose what digits to make editable
- * use elm_clock_digit_edit_set().
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit)
 {
@@ -654,16 +592,6 @@ elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit)
      _time_update(obj);
 }
 
-/**
- * Get if the clock settings can be edited
- *
- * @param obj The clock object
- * @return Bool option for edited (1 = yes, 0 = no)
- *
- * This function gets if the clock settings can be edited or not.
- *
- * @ingroup Clock
- */
 EAPI Eina_Bool
 elm_clock_edit_get(const Evas_Object *obj)
 {
@@ -673,16 +601,6 @@ elm_clock_edit_get(const Evas_Object *obj)
    return wd->edit;
 }
 
-/**
- * Set what digits of the clock are editable
- *
- * @param obj The clock object
- * @param digedit Bit mask indicating the digits to edit
- *
- * If the digedit param is ELM_CLOCK_NONE, editing will be disabled.
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit)
 {
@@ -696,14 +614,6 @@ elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit)
      _time_update(obj);
 }
 
-/**
- * Get what digits of the clock are editable
- *
- * @param obj The clock object
- * @return Bit mask indicating the digits.
- *
- * @ingroup Clock
- */
 EAPI Elm_Clock_Digedit
 elm_clock_digit_edit_get(const Evas_Object *obj)
 {
@@ -713,20 +623,6 @@ elm_clock_digit_edit_get(const Evas_Object *obj)
    return wd->digedit;
 }
 
-/**
- * Set if the clock shows hours in military or am/pm mode
- *
- * @param obj The clock object
- * @param am_pm Bool option for the hours mode
- * (1 = am/pm, 0 = military)
- *
- * This function sets the clock to show hours in military or am/pm
- * mode. Some countries like Brazil the military mode (00-24h-format)
- * is used in opposition to the USA where the am/pm mode is more
- * common used.
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm)
 {
@@ -737,20 +633,6 @@ elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm)
    _time_update(obj);
 }
 
-/**
- * Get if the clock shows hours in military or am/pm mode
- *
- * @param obj The clock object
- * @return Bool option for the hours mode
- * (1 = am/pm, 0 = military)
- *
- * This function gets if the clock show hours in military or am/pm
- * mode. Some countries like Brazil the military mode (00-24h-format)
- * is used in opposition to the USA where the am/pm mode is more
- * common used.
- *
- * @ingroup Clock
- */
 EAPI Eina_Bool
 elm_clock_show_am_pm_get(const Evas_Object *obj)
 {
@@ -760,18 +642,6 @@ elm_clock_show_am_pm_get(const Evas_Object *obj)
    return wd->am_pm;
 }
 
-/**
- * Set if the clock shows hour with the seconds
- *
- * @param obj The clock object
- * @param seconds Bool option for the show seconds
- * (1 = show seconds, 0 = not show seconds)
- *
- * This function sets the clock to show or not to show the elapsed
- * seconds.
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds)
 {
@@ -782,18 +652,6 @@ elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds)
    _time_update(obj);
 }
 
-/**
- * Get if the clock shows hour with the seconds
- *
- * @param obj The clock object
- * @return Bool option for the show seconds
- * (1 = show seconds, 0 = not show seconds)
- *
- * This function gets if the clock show or not show the elapsed
- * seconds.
- *
- * @ingroup Clock
- */
 EAPI Eina_Bool
 elm_clock_show_seconds_get(const Evas_Object *obj)
 {
@@ -803,18 +661,6 @@ elm_clock_show_seconds_get(const Evas_Object *obj)
    return wd->seconds;
 }
 
-/**
- * Set the interval for the clock
- *
- * @param obj The clock object
- * @param interval The interval value in seconds
- *
- * The interval value is decreased while the user increments or decrements
- * the clock value. The next interval value is the previous interval / 1.05,
- * so it speed up a bit. Default value is 0.85 seconds.
- *
- * @ingroup Clock
- */
 EAPI void
 elm_clock_interval_set(Evas_Object *obj, double interval)
 {
@@ -824,18 +670,6 @@ elm_clock_interval_set(Evas_Object *obj, double interval)
    wd->first_interval = interval;
 }
 
-/**
- * Get the interval of the clock
- *
- * @param obj The clock object
- * @return The value of the first interval in seconds
- *
- * The interval value is decreased while the user increments or decrements
- * the clock value. The next interval value is the previous interval / 1.05,
- * so it speed up a bit. Default value is 0.85 seconds.
- *
- * @ingroup Clock
- */
 EAPI double
 elm_clock_interval_get(const Evas_Object *obj)
 {