q66 pushed a commit to branch master.

http://git.enlightenment.org/core/elementary.git/commit/?id=388f10a607fd59cd4081ff7dd01cdb0c5df9c6fa

commit 388f10a607fd59cd4081ff7dd01cdb0c5df9c6fa
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date:   Fri Jul 3 16:07:18 2015 +0100

    icon: convert docs
---
 src/lib/elm_icon.eo | 104 ++++++++++++++++++++++------------------------------
 1 file changed, 44 insertions(+), 60 deletions(-)

diff --git a/src/lib/elm_icon.eo b/src/lib/elm_icon.eo
index 018fd4b..281fdd4 100644
--- a/src/lib/elm_icon.eo
+++ b/src/lib/elm_icon.eo
@@ -4,94 +4,78 @@ class Elm.Icon (Elm.Image)
    methods {
       @property order_lookup {
          set {
-            /*@
-            Sets the icon lookup order used by elm_icon_standard_set().
+            [[Sets the icon lookup order used by elm_icon_standard_set().
 
-            @see elm_icon_order_lookup_get()
-            @see Elm_Icon_Lookup_Order
-
-            @ingroup Icon */
+              See also @elm_icon_order_lookup_get, @Elm_Icon_Lookup_Order.
+            ]]
          }
          get {
-            /*@
-            Get the icon lookup order.
-
-            @return The icon lookup order
-            (If getting the icon order loopup is failed, it returns 
#ELM_ICON_LOOKUP_THEME_FDO)
-
-            @see elm_icon_order_lookup_set()
-            @see Elm_Icon_Lookup_Order
+            [[Get the icon lookup order.
 
-            @ingroup Icon */
+              See also @elm_icon_order_lookup_set, @Elm_Icon_Lookup_Order.
+            ]]
          }
          values {
-            order: Elm_Icon_Lookup_Order(1); /*@ The icon lookup order (can be 
one of
-            #ELM_ICON_LOOKUP_FDO_THEME, #ELM_ICON_LOOKUP_THEME_FDO, 
#ELM_ICON_LOOKUP_FDO
-            or #ELM_ICON_LOOKUP_THEME) */
+            order: Elm_Icon_Lookup_Order(1); [[The icon lookup order (can be
+                                               one of 
ELM_ICON_LOOKUP_FDO_THEME,
+                                               ELM_ICON_LOOKUP_THEME_FDO,
+                                               ELM_ICON_LOOKUP_FDO or
+                                               ELM_ICON_LOOKUP_THEME)
+                                             ]]
          }
       }
       @property standard {
          set {
-            /*@
-            Set the icon by icon standards names.
-
-            @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
-
-            For example, freedesktop.org defines standard icon names such as 
"home",
-            "network", etc. There can be different icon sets to match those 
icon
-            keys. The @p name given as parameter is one of these "keys", and 
will be
-            used to look in the freedesktop.org paths and elementary theme. 
One can
-            change the lookup order with elm_icon_order_lookup_set().
+            [[Set the icon by icon standards names.
 
-            If name is not found in any of the expected locations and it is the
-            absolute path of an image file, this image will be used.
+              For example, freedesktop.org defines standard icon names such
+              as "home", "network", etc. There can be different icon sets to
+              match those icon keys. The "name" given as parameter is one of
+              these "keys", and will be used to look in the freedesktop.org
+              paths and elementary theme. One can change the lookup order
+              with @elm_icon_order_lookup_set.
 
-            @note The icon image set by this function can be changed by
-            elm_image_file_set().
+              If name is not found in any of the expected locations and it is
+              the absolute path of an image file, this image will be used.
 
-            @note This function does not accept relative icon path.
+              Note: The icon image set by this function can be changed by
+              @elm_image_file_set.
 
-            @see elm_icon_standard_get()
-            @see elm_image_file_set()
+              Note: This function does not accept relative icon path.
 
-            @ingroup Icon */
-            return: bool;
+              See also @elm_icon_standard_get.
+            ]]
+            return: bool; [[true on success, false on error]]
          }
          get {
-            /*@
-            Get the icon name set by icon standard names.
+            [[Get the icon name set by icon standard names.
 
-            @return The icon name
-
-            If the icon image was set using elm_image_file_set() instead of
-            elm_icon_standard_set(), then this function will return @c NULL.
-
-            @see elm_icon_standard_set()
-
-            @ingroup Icon */
+              If the icon image was set using elm_image_file_set() instead of
+              @elm_icon_standard_set, then this function will return null.
+            ]]
          }
          values {
-            name: const(char)*; /*@ The icon name */
+            name: const(char)*; [[The icon name]]
          }
       }
       @property thumb {
          set {
-            /*@
-            Set the file that will be used, but use a generated thumbnail.
-
-            This functions like elm_image_file_set() but requires the Ethumb 
library
-            support to be enabled successfully with elm_need_ethumb(). When set
-            the file indicated has a thumbnail generated and cached on disk for
-            future use or will directly use an existing cached thumbnail if it
-            is valid.
+            [[Set the file that will be used, but use a generated thumbnail.
 
-            @see elm_image_file_set()
+              This functions like elm_image_file_set() but requires the Ethumb
+              library support to be enabled successfully with @elm_need_ethumb.
+              When set the file indicated has a thumbnail generated and cached
+              on disk for future use or will directly use an existing cached
+              thumbnail if it is valid.
 
-            @ingroup Icon */
+              See also @elm_image_file_set.
+            ]]
          }
          values {
-            file: const(char)* @nullable; /*@ The path to file that will be 
used as icon image */
-            group: const(char)* @optional; /*@ The group that the icon belongs 
to an edje file */
+            file: const(char)* @nullable; [[The path to file that will be used
+                                            as icon image]]
+            group: const(char)* @optional; [[The group that the icon belongs
+                                             to an edje file]]
          }
       }
    }

-- 


Reply via email to