Commit 9c0e6494 authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

url: move documentation to header

parent 0ba278ca
......@@ -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
......@@ -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);
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment