Browse Source

vlc_http: fix doxygen warnings

include/vlc_http.h:90: error: argument 'p_jar' of command @param is not found in the argument list of vlc_http_cookies_fetch(vlc_http_cookie_jar_t *jar, bool secure, const char *host, const char *path) (warning treated as error, aborting now)

    include/vlc_http.h:80: error: The following parameters of vlc_http_cookies_store(vlc_http_cookie_jar_t *jar, const char *cookie, const char *host, const char *path) are not documented:
      parameter 'host'
      parameter 'path' (warning treated as error, aborting now)
pull/162/head
Alexandre Janniaux 3 years ago
committed by Steve Lhomme
parent
commit
a496775c7b
  1. 8
      include/vlc_http.h

8
include/vlc_http.h

@ -78,6 +78,8 @@ VLC_API void vlc_http_cookies_destroy( vlc_http_cookie_jar_t * p_jar );
*
* @param jar cookie jar object
* @param cookie header field value of Set-Cookie
* @param host the hostname to store the cookie for
* @param path the name of the cookie to store
* @return true, if the cookie was added, false otherwise
*/
VLC_API bool vlc_http_cookies_store( vlc_http_cookie_jar_t *jar,
@ -86,8 +88,10 @@ VLC_API bool vlc_http_cookies_store( vlc_http_cookie_jar_t *jar,
/**
* Returns a cookie value that match the given URL.
*
* @param p_jar a cookie jar
* @param p_url the URL for which the cookies are returned
* @param jar a cookie jar
* @param secure whether a secure connexion will be used or not
* @param host the hostname for which the cookie was stored
* @param path the cookie name to fetch
* @return A string consisting of semicolon-separated cookie NAME=VALUE pairs.
*/
VLC_API char *vlc_http_cookies_fetch( vlc_http_cookie_jar_t *jar, bool secure,

Loading…
Cancel
Save