image, gesture_layer, glview: remove doxygen warnings

[platform/upstream/elementary.git] / src / lib / elm_icon.h

diff --git a/src/lib/elm_icon.h b/src/lib/elm_icon.h
index acd3eed..6bf42ee 100644 (file)
--- a/src/lib/elm_icon.h
+++ b/src/lib/elm_icon.h
@@ -1,13 +1,10 @@
 /**
- * @defgroup Icon Icon
- * @ingroup Elementary
+ * @defgroup Elm_Icon Icon
+ * @ingroup elm_widget_group
  *
  * @image html icon_inheritance_tree.png
  * @image latex icon_inheritance_tree.eps
  *
- * @image html img/widget/icon/preview-00.png
- * @image latex img/widget/icon/preview-00.eps
- *
  * An icon object is used to display standard icon images ("delete",
  * "edit", "arrows", etc.) or images coming from a custom file (PNG,
  * JPG, EDJE, etc.), on icon contexts.
@@ -16,7 +13,7 @@
  * in the @c freedesktop.org theme paths. It's possible to set the
  * order of preference from where an image will be fetched.
  *
- * This widget inherits from the @ref Image one, so that all the
+ * This widget inherits from the @ref Elm_Image one, so that all the
  * functions acting on it also work for icon objects.
  *
  * You should be using an icon, instead of an image, whenever one of
@@ -34,6 +31,52 @@
  * Default images provided by Elementary's default theme are described
  * below.
  *
+ * These are names that follow (more or less) the @b Freedesktop icon naming
+ * specification. Use of these names are @b preferred, at least if you want to
+ * give your user the ability to use other themes. All these icons can be
+ * seen in the elementary_test application, the test is called "Icon Standard".
+ * 
+ * @li @c "folder" (since 1.13)
+ * @li @c "user-home" (since 1.13)
+ * @li @c "user-trash" (since 1.13)
+ *
+ * @li @c "view-close" (since 1.13)
+ * @li @c "view-refresh" (since 1.13)
+ *
+ * @li @c "window-close" (since 1.13)
+ *
+ * @li @c "document-close" (since 1.13)
+ * @li @c "document-edit" (since 1.13)
+ *
+ * @li @c "dialog-info" (since 1.13)
+ * @li @c "dialog-close" (since 1.13)
+ *
+ * @li @c "arrow-up" (since 1.13)
+ * @li @c "arrow-down" (since 1.13)
+ * @li @c "arrow-left" (since 1.13)
+ * @li @c "arrow-right" (since 1.13)
+ * @li @c "arrow-up-left" (since 1.13)
+ * @li @c "arrow-up-right" (since 1.13)
+ * @li @c "arrow-down-left" (since 1.13)
+ * @li @c "arrow-down-right" (since 1.13)
+ *
+ * @li @c "edit-delete" (since 1.13)
+ *
+ * @li @c "application-chat" (since 1.13)
+ * @li @c "application-clock" (since 1.13)
+ *
+ * @li @c "media-seek-forward" (since 1.13)
+ * @li @c "media-seek-backward" (since 1.13)
+ * @li @c "media-skip-forward" (since 1.13)
+ * @li @c "media-skip-backward" (since 1.13)
+ * @li @c "media-playback-pause" (since 1.13)
+ * @li @c "media-playback-start" (since 1.13)
+ * @li @c "media-playback-stop" (since 1.13)
+ * @li @c "media-eject" (since 1.13)
+ *
+ * @li @c "audio-volume" (since 1.13)
+ * @li @c "audio-volume-muted" (since 1.13)
+ * 
  * These are names for icons that were first intended to be used in
  * toolbars, but can be used in many other places too:
  * @li @c "home"
@@ -79,7 +122,7 @@
  * @li @c "media_player/stop"
  *
  * This widget emits the following signals, besides the ones sent from
- * @ref Image:
+ * @ref Elm_Image :
  * - @c "thumb,done" - elm_icon_thumb_set() has completed with success
  *                     (since 1.7)
  * - @c "thumb,error" - elm_icon_thumb_set() has failed (since 1.7)
@@ -88,7 +131,7 @@
  * @li elm_object_signal_emit()
  * @li elm_object_signal_callback_add()
  * @li elm_object_signal_callback_del()
- * for emmiting and listening to signals on the object, when the
+ * for emitting and listening to signals on the object, when the
  * internal image comes from an Edje object. This behavior was added
  * unintentionally, though, and is @b deprecated. Expect it to be
  * dropped on future releases.
@@ -97,7 +140,6 @@
  * @li @ref tutorial_icon
  */
 
-#include "elm_icon_common.h"
 #ifdef EFL_EO_API_SUPPORT
 #include "elm_icon_eo.h"
 #endif