efreet: Add doc

SVN revision: 62579

legacy/efreet/src/lib/efreet_desktop.h

@@ -122,6 +122,11 @@ struct _Efreet_Desktop
  *
  * By using efreet_desktop_get the Efreet_Desktop will be saved in an internal
  * cache for quicker loading.
+ *
+ * Users of this command should listen to EFREET_EVENT_DESKTOP_CACHE_UPDATE
+ * event, if the application is to keep the reference. When the event fires
+ * the Efreet_Desktop struct should be invalidated and reloaded from a new
+ * cache file.
  */
 EAPI Efreet_Desktop   *efreet_desktop_get(const char *file);
 
@@ -145,6 +150,11 @@ EAPI Efreet_Desktop   *efreet_desktop_empty_new(const char *file);
  * on failure
  * @brief Gets a reference to an Efreet_Desktop structure representing the
  * contents of @a file or NULL if @a file is not a valid .desktop file.
+ *
+ * Users of this command should listen to EFREET_EVENT_DESKTOP_CACHE_UPDATE
+ * event, if the application is to keep the reference. When the event fires
+ * the Efreet_Desktop struct should be invalidated and reloaded from a new
+ * cache file.
  */
 EAPI Efreet_Desktop   *efreet_desktop_new(const char *file);
 

legacy/efreet/src/lib/efreet_icon.h

@@ -213,6 +213,9 @@ EAPI Efreet_Icon       *efreet_icon_find(const char *theme_name,
  * the list.
  * @note This function will search the given theme for all icons before falling
  * back. This is useful when searching for mimetype icons.
+ *
+ * There is no guarantee for how long the pointer to the path will be valid.
+ * If the pointer is to be kept, the user must create a copy of the path.
  */
 EAPI const char        *efreet_icon_list_find(const char *theme_name,
                                                 Eina_List *icons,
@@ -224,6 +227,9 @@ EAPI const char        *efreet_icon_list_find(const char *theme_name,
  * @param size; The icon size to look for
  * @return Returns the path to the given icon or NULL if none found
  * @brief Retrives the path to the given icon.
+ *
+ * There is no guarantee for how long the pointer to the path will be valid.
+ * If the pointer is to be kept, the user must create a copy of the path.
  */
 EAPI const char        *efreet_icon_path_find(const char *theme_name,
                                                 const char *icon,