[vlc-commits] url: move documentation to header

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Oct 15 13:00:08 2016 +0300| [9c0e6494aa2e140a2342dbf05a47931e53cb9897] | committer: Rémi Denis-Courmont

url: move documentation to header

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=9c0e6494aa2e140a2342dbf05a47931e53cb9897
---

 include/vlc_url.h | 21 +++++++++++++++++----
 src/text/url.c    | 11 -----------
 2 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/include/vlc_url.h b/include/vlc_url.h
index a827100..e50685d 100644
--- a/include/vlc_url.h
+++ b/include/vlc_url.h
@@ -142,8 +142,6 @@ VLC_API char *vlc_uri_resolve(const char *base, const char *ref) VLC_MALLOC;
  */
 VLC_API char *vlc_uri_fixup(const char *) VLC_MALLOC;
 
-/** @} */
-
 struct vlc_url_t
 {
     char *psz_protocol;
@@ -157,7 +155,22 @@ struct vlc_url_t
     char *psz_buffer; /* to be freed */
 };
 
-VLC_API void vlc_UrlParse (vlc_url_t *, const char *);
-VLC_API void vlc_UrlClean (vlc_url_t *);
+/**
+ * Splits an URL into parts.
+ *
+ * \param url structure of URL parts [OUT]
+ * \param str nul-terminated URL string to split
+ * \note Use vlc_UrlClean() to free associated resources
+ * \bug Errors cannot be detected.
+ * \return nothing
+ */
+VLC_API void vlc_UrlParse(vlc_url_t *url, const char *str);
+
+/**
+ * Releases resources allocated by vlc_UrlParse().
+ */
+VLC_API void vlc_UrlClean(vlc_url_t *);
+
+/** @} */
 
 #endif
diff --git a/src/text/url.c b/src/text/url.c
index 909d1a7..0c60970 100644
--- a/src/text/url.c
+++ b/src/text/url.c
@@ -356,14 +356,6 @@ static bool vlc_uri_path_validate(const char *str)
     return vlc_uri_component_validate(str, "/@:");
 }
 
-/**
- * Splits an URL into parts.
- * \param url structure of URL parts [OUT]
- * \param str nul-terminated URL string to split
- * \note Use vlc_UrlClean() to free associated resources
- * \bug Errors cannot be detected.
- * \return nothing
- */
 void vlc_UrlParse (vlc_url_t *restrict url, const char *str)
 {
     url->psz_protocol = NULL;
@@ -493,9 +485,6 @@ void vlc_UrlParse (vlc_url_t *restrict url, const char *str)
         url->psz_path = NULL;
 }
 
-/**
- * Releases resources allocated by vlc_UrlParse().
- */
 void vlc_UrlClean (vlc_url_t *restrict url)
 {
     free (url->psz_host);