docs: elm_icon: fully document elm_icon eo file
authorStefan Schmidt <stefan@osg.samsung.com>
Mon, 24 Oct 2016 18:51:04 +0000 (20:51 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Tue, 25 Oct 2016 14:08:25 +0000 (16:08 +0200)
src/lib/elementary/elm_icon.eo

index da79c23..6d56165 100644 (file)
@@ -1,13 +1,15 @@
 enum Elm.Icon.Type
 {
+   [[Elementary icon types]]
    legacy: elm_icon;
-   none,
-   file,
-   standard
+   none, [[Icon has no type set]]
+   file, [[Icon is of type file]]
+   standard [[Icon is of type standard]]
 }
 
 class Elm.Icon (Efl.Ui.Image)
 {
+   [[Elementary Icon Class]]
    legacy_prefix: elm_icon;
    eo_prefix: elm_obj_icon;
    event_prefix: elm_icon;
@@ -22,8 +24,8 @@ class Elm.Icon (Efl.Ui.Image)
       Efl.File.file.set;
    }
    events {
-      thumb,done;
-      thumb,error;
+      thumb,done; [[Called when thumb nailing is successfully done]]
+      thumb,error; [[Called when thumb nailing failed]]
    }
 
 }