[vlc-devel] commit: Fix make_URI documentation ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sat Jan 30 17:36:14 2010 +0200| [34a55d15d18b27d7de518cbf638875dd19f9be31] | committer: Rémi Denis-Courmont 

Fix make_URI documentation

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

 src/text/strings.c |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/src/text/strings.c b/src/text/strings.c
index 153ff84..f136a59 100644
--- a/src/text/strings.c
+++ b/src/text/strings.c
@@ -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)
 {