eina vpath - document that resolved strings need to be freed

2019-03-05 12:12:32 +00:00 · 2019-03-05 12:12:32 +00:00 · 272d1b5fc2
parent e9f07bf60b
commit 272d1b5fc2
1 changed files with 3 additions and 0 deletions
--- a/src/lib/eina/eina_vpath.h
+++ b/src/lib/eina/eina_vpath.h
@ -86,6 +86,9 @@ typedef const char * Eina_Vpath;

 /**
 * Translate a virtual path into a normal path.
+ * 
+ * The return string is a string allocated by malloc and should be freed with
+ * free() when no longer needed.
 *
 * @param[in] path The path.
 * @return NULL if failed, or a full normal string file path that is resolved