[radio] remove documentation
authorMike McCormack <mj.mccormack@samsung.com>
Mon, 7 Nov 2011 09:06:45 +0000 (18:06 +0900)
committerMike McCormack <mj.mccormack@samsung.com>
Mon, 7 Nov 2011 09:36:08 +0000 (18:36 +0900)
src/lib/elm_radio.c

index a2021be..b22837e 100644 (file)
@@ -1,41 +1,6 @@
 #include <Elementary.h>
 #include "elm_priv.h"
 
-/**
- * @defgroup Radio Radio
- * @ingroup Elementary
- *
- * The radio button allows for 1 or more selectors to be created to select 1
- * of a set of options.
- *
- * Signals that you can add callbacks for are:
- *
- * changed - This is called whenever the user changes the state of one of the
- * radio objects within the group of radio objects that work together.
- *
- * A radio object contains an indicator, an optional Label and an optional
- * icon object. They work normally in groups of 2 or more. When you create a
- * radio (if it is not the first member of the group), simply add it to the
- * group by adding it to any other member of the group that already exists
- * (or the first member) with elm_radio_group_add() with the second parameter
- * being the existing group member. The radio object(s) will select from one
- * of a set of integer values, so any value they are configuring needs to be
- * mapped to a set of integers. To configure what value that radio object
- * represents, use  elm_radio_state_value_set() to set the integer it
- * represents. To set the value the whole group is to indicate use
- * elm_radio_value_set() on any group member, and to get the groups value use
- * elm_radio_value_get(). For convenience the radio objects are also able to
- * directly set an integer (int) to the value that is selected. To specify
- * the pointer to this integer to modify, use elm_radio_value_pointer_set().
- * The radio objects will modify this directly. That implies the pointer must
- * point to valid memory for as long as the radio objects exist.
- *
- * Signals that you can add callbacks for are:
- *
- * "changed" - when the radio status is changed
- *
- */
-
 typedef struct _Widget_Data Widget_Data;
 typedef struct _Group Group;
 
@@ -306,14 +271,6 @@ _elm_radio_label_get(const Evas_Object *obj, const char *item)
    return wd->label;
 }
 
-/**
- * Add a new radio to the parent
- *
- * @param parent The parent object
- * @return The new object or NULL if it cannot be created
- *
- * @ingroup Radio
- */
 EAPI Evas_Object *
 elm_radio_add(Evas_Object *parent)
 {
@@ -358,48 +315,18 @@ elm_radio_add(Evas_Object *parent)
    return obj;
 }
 
-/**
- * Set the text label of the radio object
- *
- * @param obj The radio object
- * @param label The text label string in UTF-8
- *
- * @ingroup Radio
- * @deprecated use elm_object_text_set() instead.
- */
 EAPI void
 elm_radio_label_set(Evas_Object *obj, const char *label)
 {
    _elm_radio_label_set(obj, NULL, label);
 }
 
-/**
- * Get the text label of the radio object
- *
- * @param obj The radio object
- * @return The text label string in UTF-8
- *
- * @ingroup Radio
- * @deprecated use elm_object_text_set() instead.
- */
 EAPI const char *
 elm_radio_label_get(const Evas_Object *obj)
 {
    return _elm_radio_label_get(obj, NULL);
 }
 
-/**
- * Set the icon object of the radio object
- *
- * Once the icon object is set, a previously set one will be deleted.
- * If you want to keep that old content object, use the
- * elm_radio_icon_unset() function.
- *
- * @param obj The radio object
- * @param icon The icon object
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon)
 {
@@ -421,14 +348,6 @@ elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon)
    _sizing_eval(obj);
 }
 
-/**
- * Get the icon object of the radio object
- *
- * @param obj The radio object
- * @return The icon object
- *
- * @ingroup Radio
- */
 EAPI Evas_Object *
 elm_radio_icon_get(const Evas_Object *obj)
 {
@@ -438,16 +357,6 @@ elm_radio_icon_get(const Evas_Object *obj)
    return wd->icon;
 }
 
-/**
- * Unset the icon used for the radio object
- *
- * Unparent and return the icon object which was set for this widget.
- *
- * @param obj The radio object
- * @return The icon object that was being used
- *
- * @ingroup Radio
- */
 EAPI Evas_Object *
 elm_radio_icon_unset(Evas_Object *obj)
 {
@@ -462,19 +371,6 @@ elm_radio_icon_unset(Evas_Object *obj)
    return icon;
 }
 
-/**
- * Add this radio to a group of other radio objects
- *
- * Radio objects work in groups. Each member should have a different integer
- * value assigned. In order ro have them work as a group, they need to know
- * about eacthother. This adds the given radio object to the group of which
- * the group object indicated is a member.
- *
- * @param obj The radio object
- * @param group The object whose group the object is to join
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
 {
@@ -502,16 +398,6 @@ elm_radio_group_add(Evas_Object *obj, Evas_Object *group)
    else _state_set(obj, 0);
 }
 
-/**
- * Set the integer value that this radio object represents
- *
- * This sets the value of the radio.
- *
- * @param obj The radio object
- * @param value The value to use if this radio object is selected
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_state_value_set(Evas_Object *obj, int value)
 {
@@ -523,16 +409,6 @@ elm_radio_state_value_set(Evas_Object *obj, int value)
    else _state_set(obj, 0);
 }
 
-/**
- * Get the integer value that this radio object represents
- *
- * This gets the value of the radio.
- *
- * @param obj The radio object
- * @return The value used if this radio object is selected
- *
- * @ingroup Radio
- */
 EAPI int
 elm_radio_state_value_get(const Evas_Object *obj)
 {
@@ -542,17 +418,6 @@ elm_radio_state_value_get(const Evas_Object *obj)
    return wd->value;
 }
 
-/**
- * Set the value of the radio.
- *
- * This sets the value of the radio group and will also set the value if
- * pointed to, to the value supplied, but will not call any callbacks.
- *
- * @param obj The radio object
- * @param value The value to use for the group
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_value_set(Evas_Object *obj, int value)
 {
@@ -565,14 +430,6 @@ elm_radio_value_set(Evas_Object *obj, int value)
    _state_set_all(wd);
 }
 
-/**
- * Get the state of the radio object
- *
- * @param obj The radio object
- * @return The integer state
- *
- * @ingroup Radio
- */
 EAPI int
 elm_radio_value_get(const Evas_Object *obj)
 {
@@ -582,21 +439,6 @@ elm_radio_value_get(const Evas_Object *obj)
    return wd->group->value;
 }
 
-/**
- * Set a convenience pointer to a integer to change
- *
- * This sets a pointer to a integer, that, in addition to the radio objects
- * state will also be modified directly. To stop setting the object pointed
- * to simply use NULL as the valuep parameter. If valuep is not NULL, then
- * when this is called, the radio objects state will also be modified to
- * reflect the value of the integer valuep points to, just like calling
- * elm_radio_value_set().
- *
- * @param obj The radio object
- * @param valuep Pointer to the integer to modify
- *
- * @ingroup Radio
- */
 EAPI void
 elm_radio_value_pointer_set(Evas_Object *obj, int *valuep)
 {