summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--legacy/efreet/src/lib/Efreet.h6
-rw-r--r--legacy/efreet/src/lib/Efreet_Mime.h28
-rw-r--r--legacy/efreet/src/lib/Efreet_Trash.h26
-rw-r--r--legacy/efreet/src/lib/efreet_base.c6
4 files changed, 33 insertions, 33 deletions
diff --git a/legacy/efreet/src/lib/Efreet.h b/legacy/efreet/src/lib/Efreet.h
index bf5fa11..9013d0b 100644
--- a/legacy/efreet/src/lib/Efreet.h
+++ b/legacy/efreet/src/lib/Efreet.h
@@ -80,14 +80,14 @@ extern "C" {
80#include "efreet_uri.h" 80#include "efreet_uri.h"
81 81
82/** 82/**
83 * @return Returns > 0 if the initialization was successful, 0 otherwise 83 * @return Value > @c 0 if the initialization was successful, @c 0 otherwise.
84 * @brief Initializes the Efreet system 84 * @brief Initializes the Efreet system
85 */ 85 */
86EAPI int efreet_init(void); 86EAPI int efreet_init(void);
87 87
88/** 88/**
89 * @return Returns the number of times the init function as been called 89 * @return The number of times the init function has been called minus the
90 * minus the corresponding init call. 90 * corresponding init call.
91 * @brief Shuts down Efreet if a balanced number of init/shutdown calls have 91 * @brief Shuts down Efreet if a balanced number of init/shutdown calls have
92 * been made 92 * been made
93 */ 93 */
diff --git a/legacy/efreet/src/lib/Efreet_Mime.h b/legacy/efreet/src/lib/Efreet_Mime.h
index 254c3e5..d6873fc 100644
--- a/legacy/efreet/src/lib/Efreet_Mime.h
+++ b/legacy/efreet/src/lib/Efreet_Mime.h
@@ -44,49 +44,49 @@ extern "C" {
44 44
45 45
46/** 46/**
47 * @return Returns 1 on success or 0 on failure 47 * @return @c 1 on success or @c 0 on failure.
48 * @brief Initializes the efreet mime settings 48 * @brief Initializes the efreet mime settings
49 */ 49 */
50EAPI int efreet_mime_init(void); 50EAPI int efreet_mime_init(void);
51 51
52/** 52/**
53 * @return Returns no value 53 * @return No value.
54 * @brief Cleans up the efreet mime settings system 54 * @brief Cleans up the efreet mime settings system
55 */ 55 */
56EAPI int efreet_mime_shutdown(void); 56EAPI int efreet_mime_shutdown(void);
57 57
58/** 58/**
59 * @param file The file to find the mime type 59 * @param file The file to find the mime type
60 * @return Returns mime type as a string 60 * @return Mime type as a string.
61 * @brief Retreive the mime type of a file 61 * @brief Retrieve the mime type of a file
62 */ 62 */
63EAPI const char *efreet_mime_type_get(const char *file); 63EAPI const char *efreet_mime_type_get(const char *file);
64 64
65/** 65/**
66 * @param file The file to check the mime type 66 * @param file The file to check the mime type
67 * @return Returns mime type as a string 67 * @return Mime type as a string.
68 * @brief Retreive the mime type of a file using magic 68 * @brief Retrieve the mime type of a file using magic
69 */ 69 */
70EAPI const char *efreet_mime_magic_type_get(const char *file); 70EAPI const char *efreet_mime_magic_type_get(const char *file);
71 71
72/** 72/**
73 * @param file The file to check the mime type 73 * @param file The file to check the mime type
74 * @return Returns mime type as a string 74 * @return Mime type as a string.
75 * @brief Retreive the mime type of a file using globs 75 * @brief Retrieve the mime type of a file using globs
76 */ 76 */
77EAPI const char *efreet_mime_globs_type_get(const char *file); 77EAPI const char *efreet_mime_globs_type_get(const char *file);
78 78
79/** 79/**
80 * @param file The file to check the mime type 80 * @param file The file to check the mime type
81 * @return Returns mime type as a string 81 * @return Mime type as a string.
82 * @brief Retreive the special mime type of a file 82 * @brief Retrieve the special mime type of a file
83 */ 83 */
84EAPI const char *efreet_mime_special_type_get(const char *file); 84EAPI const char *efreet_mime_special_type_get(const char *file);
85 85
86/** 86/**
87 * @param file The file to check the mime type 87 * @param file The file to check the mime type
88 * @return Returns mime type as a string 88 * @return Mime type as a string.
89 * @brief Retreive the fallback mime type of a file 89 * @brief Retrieve the fallback mime type of a file.
90 */ 90 */
91EAPI const char *efreet_mime_fallback_type_get(const char *file); 91EAPI const char *efreet_mime_fallback_type_get(const char *file);
92 92
@@ -95,8 +95,8 @@ EAPI const char *efreet_mime_fallback_type_get(const char *file);
95 * @param mime The name of the mime type 95 * @param mime The name of the mime type
96 * @param theme The name of the theme to search icons in 96 * @param theme The name of the theme to search icons in
97 * @param size The wanted size of the icon 97 * @param size The wanted size of the icon
98 * @return Returns mime type icon path as a string 98 * @return Mime type icon path as a string.
99 * @brief Retreive the mime type icon for a file 99 * @brief Retrieve the mime type icon for a file.
100 */ 100 */
101EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme, 101EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme,
102 unsigned int size); 102 unsigned int size);
diff --git a/legacy/efreet/src/lib/Efreet_Trash.h b/legacy/efreet/src/lib/Efreet_Trash.h
index d6ff401..3f86aa2 100644
--- a/legacy/efreet/src/lib/Efreet_Trash.h
+++ b/legacy/efreet/src/lib/Efreet_Trash.h
@@ -41,52 +41,52 @@ extern "C" {
41 */ 41 */
42 42
43/** 43/**
44 * @return Returns 1 on success or 0 on failure 44 * @return @c 1 on success or @c 0 on failure.
45 * @brief Initializes the efreet trash system 45 * @brief Initializes the efreet trash system
46 */ 46 */
47EAPI int efreet_trash_init(void); 47EAPI int efreet_trash_init(void);
48 48
49/** 49/**
50 * @return Returns no value 50 * @return No value.
51 * @brief Cleans up the efreet trash system 51 * @brief Cleans up the efreet trash system
52 */ 52 */
53EAPI int efreet_trash_shutdown(void); 53EAPI int efreet_trash_shutdown(void);
54 54
55/** 55/**
56 * @return Returns the XDG Trash local directory or NULL on errors 56 * @return The XDG Trash local directory or @c NULL on errors.
57 * return value must be freed with eina_stringshare_del. 57 * Return value must be freed with eina_stringshare_del.
58 * @brief Retrieves the XDG Trash local directory 58 * @brief Retrieves the XDG Trash local directory
59 */ 59 */
60EAPI const char *efreet_trash_dir_get(const char *for_file); 60EAPI const char *efreet_trash_dir_get(const char *for_file);
61 61
62/** 62/**
63 * @param uri The local uri to move in the trash 63 * @param uri The local uri to move in the trash
64 * @param force_delete If you set this to 1 than files on different filesystems 64 * @param force_delete If you set this to @c 1 than files on different filesystems
65 * will be deleted permanently 65 * will be deleted permanently
66 * @return Return 1 on success, 0 on failure or -1 in case the uri is not on the 66 * @return @c 1 on success, @c 0 on failure or @c -1 in case the uri is not on
67 * same filesystem and force_delete is not set. 67 * the same filesystem and force_delete is not set.
68 * @brief This function try to move the given uri to the trash. Files on 68 * @brief This function try to move the given uri to the trash. Files on
69 * different filesystem can't be moved to trash. If force_delete 69 * different filesystem can't be moved to trash. If force_delete
70 * is 0 than non-local files will be ignored and -1 is returned, if you set 70 * is @c 0 than non-local files will be ignored and @c -1 is returned, if you set
71 * force_delete to 1 non-local files will be deleted without asking. 71 * force_delete to @c 1 non-local files will be deleted without asking.
72 */ 72 */
73EAPI int efreet_trash_delete_uri(Efreet_Uri *uri, int force_delete); 73EAPI int efreet_trash_delete_uri(Efreet_Uri *uri, int force_delete);
74 74
75/** 75/**
76 * @return Return a list of strings with filename (remember to free the list 76 * @return A list of strings with filename (remember to free the list
77 * when you don't need anymore) 77 * when you don't need anymore).
78 * @brief List all the files and directory currently inside the trash. 78 * @brief List all the files and directory currently inside the trash.
79 */ 79 */
80EAPI Eina_List *efreet_trash_ls(void); 80EAPI Eina_List *efreet_trash_ls(void);
81 81
82/** 82/**
83 * @return Return 1 if the trash is empty or 0 if some file are in. 83 * @return @c 1 if the trash is empty or @c 0 if some file are in.
84 * @brief Check if the trash is currently empty 84 * @brief Check if the trash is currently empty
85 */ 85 */
86EAPI int efreet_trash_is_empty(void); 86EAPI int efreet_trash_is_empty(void);
87 87
88/** 88/**
89 * @return Return 1 on success or 0 on failure 89 * @return @c 1 on success or @c 0 on failure.
90 * @brief Delete all the files inside the trash. 90 * @brief Delete all the files inside the trash.
91 */ 91 */
92EAPI int efreet_trash_empty_trash(void); 92EAPI int efreet_trash_empty_trash(void);
diff --git a/legacy/efreet/src/lib/efreet_base.c b/legacy/efreet/src/lib/efreet_base.c
index 89b6ade..0ba04d1 100644
--- a/legacy/efreet/src/lib/efreet_base.c
+++ b/legacy/efreet/src/lib/efreet_base.c
@@ -53,7 +53,7 @@ static Eina_List *efreet_dirs_get(const char *key,
53 53
54/** 54/**
55 * @internal 55 * @internal
56 * @return Returns 1 on success or 0 on failure 56 * @return Returns @c 1 on success or @c 0 on failure
57 * @brief Initializes the efreet base settings 57 * @brief Initializes the efreet base settings
58 */ 58 */
59int 59int
@@ -205,10 +205,10 @@ efreet_dirs_reset(void)
205 205
206/** 206/**
207 * @internal 207 * @internal
208 * @param key The environemnt key to lookup 208 * @param key The environment key to lookup
209 * @param fallback The fallback value to use 209 * @param fallback The fallback value to use
210 * @return Returns the directory related to the given key or the fallback 210 * @return Returns the directory related to the given key or the fallback
211 * @brief This trys to determine the correct directory name given the 211 * @brief This tries to determine the correct directory name given the
212 * environment key @a key and fallbacks @a fallback. 212 * environment key @a key and fallbacks @a fallback.
213 */ 213 */
214static const char * 214static const char *