aboutsummaryrefslogtreecommitdiffstats
path: root/src/lib/efreet/efreet_uri.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/efreet/efreet_uri.h')
-rw-r--r--src/lib/efreet/efreet_uri.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/src/lib/efreet/efreet_uri.h b/src/lib/efreet/efreet_uri.h
index 32b1f51ad2..4b59c37ea7 100644
--- a/src/lib/efreet/efreet_uri.h
+++ b/src/lib/efreet/efreet_uri.h
@@ -4,8 +4,11 @@
/**
* @file efreet_uri.h
* @brief Contains the methods used to support the FDO URI specification.
- * @addtogroup Efreet_Uri Efreet_Uri: The FDO URI Specification functions
- * @ingroup Efreet
+ *
+ * @internal
+ * @defgroup Efreet_Uri_Group Efreet_Uri: The FDO URI Specification functions
+ * @ingroup Efreet_Group
+ *
* @{
*/
@@ -30,28 +33,31 @@ struct Efreet_Uri
/**
- * @param uri Create an URI string from an Efreet_Uri struct
- * @return The string rapresentation of uri (ex: 'file:///home/my%20name')
* @brief Get the string rapresentation of the given uri struct escaping
* illegal caracters. Remember to free the string with eina_stringshare_del()
* when you don't need it anymore.
+ *
+ * @param[in] uri Create an URI string from an Efreet_Uri struct
+ * @return The string rapresentation of uri (ex: 'file:///home/my%20name')
* @note The resulting string will contain the protocol and the path but not
* the hostname, as many apps doesn't handle it.
*/
EAPI const char *efreet_uri_encode(Efreet_Uri *uri);
/**
- * @param val a valid uri string to parse
- * @return Return The corresponding Efreet_Uri structure. Or NULL on errors.
* @brief Read a single uri and return an Efreet_Uri struct. If there's no
* hostname in the uri then the hostname parameter will be NULL. All the uri
* escaped chars will be converted to normal.
+ *
+ * @param[in] val a valid uri string to parse
+ * @return Return The corresponding Efreet_Uri structure. Or NULL on errors.
*/
EAPI Efreet_Uri *efreet_uri_decode(const char *val);
/**
- * @param uri The uri to free
* @brief Free the given uri structure.
+ *
+ * @param[in] uri The uri to free
*/
EAPI void efreet_uri_free(Efreet_Uri *uri);