efreet: doxygen

Fix a few typos and missing @c.


SVN revision: 72379

legacy/efreet/src/lib/Efreet.h

@@ -80,14 +80,14 @@ extern "C" {
 #include "efreet_uri.h"
 
 /**
- * @return Returns > 0 if the initialization was successful, 0 otherwise
+ * @return Value > @c 0 if the initialization was successful, @c 0 otherwise.
  * @brief Initializes the Efreet system
  */
 EAPI int efreet_init(void);
 
 /**
- * @return Returns the number of times the init function as been called
- * minus the corresponding init call.
+ * @return The number of times the init function has been called minus the
+ * corresponding init call.
  * @brief Shuts down Efreet if a balanced number of init/shutdown calls have
  * been made
  */

legacy/efreet/src/lib/Efreet_Mime.h

@@ -44,49 +44,49 @@ extern "C" {
 
 
 /**
- * @return Returns 1 on success or 0 on failure
+ * @return @c 1 on success or @c 0 on failure.
  * @brief Initializes the efreet mime settings
  */
 EAPI int         efreet_mime_init(void);
 
 /**
- * @return Returns no value
+ * @return No value.
  * @brief Cleans up the efreet mime settings system
  */
 EAPI int         efreet_mime_shutdown(void);
 
 /**
  * @param file The file to find the mime type
- * @return Returns mime type as a string
- * @brief Retreive the mime type of a file
+ * @return Mime type as a string.
+ * @brief Retrieve the mime type of a file
  */
 EAPI const char *efreet_mime_type_get(const char *file);
 
 /**
  * @param file The file to check the mime type
- * @return Returns mime type as a string
- * @brief Retreive the mime type of a file using magic
+ * @return Mime type as a string.
+ * @brief Retrieve the mime type of a file using magic
  */
 EAPI const char *efreet_mime_magic_type_get(const char *file);
 
 /**
  * @param file The file to check the mime type
- * @return Returns mime type as a string
- * @brief Retreive the mime type of a file using globs
+ * @return Mime type as a string.
+ * @brief Retrieve the mime type of a file using globs
  */
 EAPI const char *efreet_mime_globs_type_get(const char *file);
 
 /**
  * @param file The file to check the mime type
- * @return Returns mime type as a string
- * @brief Retreive the special mime type of a file
+ * @return Mime type as a string.
+ * @brief Retrieve the special mime type of a file
  */
 EAPI const char *efreet_mime_special_type_get(const char *file);
 
 /**
  * @param file The file to check the mime type
- * @return Returns mime type as a string
- * @brief Retreive the fallback mime type of a file
+ * @return Mime type as a string.
+ * @brief Retrieve the fallback mime type of a file.
  */
 EAPI const char *efreet_mime_fallback_type_get(const char *file);
 
@@ -95,8 +95,8 @@ EAPI const char *efreet_mime_fallback_type_get(const char *file);
  * @param mime The name of the mime type
  * @param theme The name of the theme to search icons in
  * @param size The wanted size of the icon
- * @return Returns mime type icon path as a string
- * @brief Retreive the mime type icon for a file
+ * @return Mime type icon path as a string.
+ * @brief Retrieve the mime type icon for a file.
  */
 EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme,
                                            unsigned int size);

legacy/efreet/src/lib/Efreet_Trash.h

@@ -41,52 +41,52 @@ extern "C" {
  */
 
 /**
- * @return Returns 1 on success or 0 on failure
+ * @return @c 1 on success or @c 0 on failure.
  * @brief Initializes the efreet trash system
  */
 EAPI int         efreet_trash_init(void);
 
 /**
- * @return Returns no value
+ * @return No value.
  * @brief Cleans up the efreet trash system
  */
 EAPI int         efreet_trash_shutdown(void);
 
 /**
- * @return Returns the XDG Trash local directory or NULL on errors
- * return value must be freed with eina_stringshare_del.
+ * @return The XDG Trash local directory or @c NULL on errors.
+ * Return value must be freed with eina_stringshare_del.
  * @brief Retrieves the XDG Trash local directory
  */
 EAPI const char *efreet_trash_dir_get(const char *for_file);
 
 /**
  * @param uri The local uri to move in the trash
- * @param force_delete If you set this to 1 than files on different filesystems
+ * @param force_delete If you set this to @c 1 than files on different filesystems
  * will be deleted permanently
- * @return Return 1 on success, 0 on failure or -1 in case the uri is not on the
- * same filesystem and force_delete is not set.
+ * @return @c 1 on success, @c 0 on failure or @c -1 in case the uri is not on
+ * the same filesystem and force_delete is not set.
  * @brief This function try to move the given uri to the trash. Files on 
  * different filesystem can't be moved to trash. If force_delete
- * is 0 than non-local files will be ignored and -1 is returned, if you set
- * force_delete to 1 non-local files will be deleted without asking.
+ * is @c 0 than non-local files will be ignored and @c -1 is returned, if you set
+ * force_delete to @c 1 non-local files will be deleted without asking.
  */
 EAPI int         efreet_trash_delete_uri(Efreet_Uri *uri, int force_delete);
 
 /**
- * @return Return a list of strings with filename (remember to free the list
- * when you don't need anymore)
+ * @return A list of strings with filename (remember to free the list
+ * when you don't need anymore).
  * @brief List all the files and directory currently inside the trash.
  */
 EAPI Eina_List  *efreet_trash_ls(void);
 
 /**
- * @return Return 1 if the trash is empty or 0 if some file are in.
+ * @return @c 1 if the trash is empty or @c 0 if some file are in.
  * @brief Check if the trash is currently empty
  */
 EAPI int         efreet_trash_is_empty(void);
 
 /**
- * @return Return 1 on success or 0 on failure
+ * @return @c 1 on success or @c 0 on failure.
  * @brief Delete all the files inside the trash.
  */
 EAPI int         efreet_trash_empty_trash(void);

legacy/efreet/src/lib/efreet_base.c

@@ -53,7 +53,7 @@ static Eina_List  *efreet_dirs_get(const char *key,
 
 /**
  * @internal
- * @return Returns 1 on success or 0 on failure
+ * @return Returns @c 1 on success or @c 0 on failure
  * @brief Initializes the efreet base settings
  */
 int
@@ -205,10 +205,10 @@ efreet_dirs_reset(void)
 
 /**
  * @internal
- * @param key The environemnt key to lookup
+ * @param key The environment key to lookup
  * @param fallback The fallback value to use
  * @return Returns the directory related to the given key or the fallback
- * @brief This trys to determine the correct directory name given the
+ * @brief This tries to determine the correct directory name given the
  * environment key @a key and fallbacks @a fallback.
  */
 static const char *