]> git.sesse.net Git - vlc/commitdiff
Fix make_URI documentation
authorRémi Denis-Courmont <remi@remlab.net>
Sat, 30 Jan 2010 15:36:14 +0000 (17:36 +0200)
committerRémi Denis-Courmont <remi@remlab.net>
Sat, 30 Jan 2010 15:36:14 +0000 (17:36 +0200)
src/text/strings.c

index 153ff841c5d6c4102f3c2077e97c38fe6ffc2561..f136a595c63233dddc26d774ee39161ea0127203 100644 (file)
@@ -1047,7 +1047,11 @@ void path_sanitize( char *str )
 #include <vlc_url.h>
 
 /**
- * Convert a file path to an URI. If already an URI, do nothing.
+ * Convert a file path to an URI.
+ * If already an URI, return a copy of the string.
+ * @path path path to convert (or URI to copy)
+ * @return a nul-terminated URI string (use free() to release it),
+ * or NULL in case of error
  */
 char *make_URI (const char *path)
 {