bitch--
[framework/uifw/elementary.git] / src / lib / elm_thumb.h
index d166867..8aa0593 100644 (file)
@@ -1,5 +1,6 @@
 /**
  * @defgroup Thumb Thumb
+ * @ingroup Elementary
  *
  * @image html img/widget/thumb/preview-00.png
  * @image latex img/widget/thumb/preview-00.eps
@@ -7,7 +8,7 @@
  * A thumb object is used for displaying the thumbnail of an image or video.
  * You must have compiled Elementary with Ethumb_Client support and the DBus
  * service must be present and auto-activated in order to have thumbnails to
- * be generated.
+ * be generated. You must also have a Session bus, not System bus.
  *
  * Once the thumbnail object becomes visible, it will check if there is a
  * previously generated thumbnail image for the file set on it. If not, it
@@ -126,9 +127,9 @@ EAPI void                        elm_thumb_file_set(Evas_Object *obj, const char
 EAPI void                        elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key);
 
 /**
- * Get the path and key to the image or video generated by ethumb.
+ * Get the path and key to the image or video thumbnail generated by ethumb.
  *
- * One just need to make sure that the thumbnail was generated before getting
+ * One just needs to make sure that the thumbnail was generated before getting
  * its path; otherwise, the path will be NULL. One way to do that is by asking
  * for the path when/after the "generate,stop" smart callback is called.
  *
@@ -148,7 +149,7 @@ EAPI void                        elm_thumb_path_get(const Evas_Object *obj, cons
  * looping.
  *
  * @param obj The thumb object.
- * @param setting The animation setting.
+ * @param s The animation setting.
  *
  * @see elm_thumb_file_set()
  *
@@ -225,13 +226,13 @@ EAPI void                       *elm_thumb_ethumb_client_get(void);
  * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
  * otherwise.
  */
-EAPI Eina_Bool                   elm_thumb_ethumb_client_connected(void);
+EAPI Eina_Bool                   elm_thumb_ethumb_client_connected_get(void);
 
 /**
  * Make the thumbnail 'editable'.
  *
  * @param obj Thumb object.
- * @param set Turn on or off editability. Default is @c EINA_FALSE.
+ * @param edit Turn on or off editability. Default is @c EINA_FALSE.
  *
  * This means the thumbnail is a valid drag target for drag and drop, and can be
  * cut or pasted too.