[vlc-commits] include: document config_Get(Data|Lib)Dir()

[Rémi Denis-Courmont]

vlc | branch: master | Rémi Denis-Courmont <remi at remlab.net> | Sun Jan 14 20:12:59 2018 +0200| [69b5b5dfdd1433526e080e05ecb9d43e56591683] | committer: Rémi Denis-Courmont

include: document config_Get(Data|Lib)Dir()

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

 include/vlc_configuration.h | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/include/vlc_configuration.h b/include/vlc_configuration.h
index 209168615b..2779e99d17 100644
--- a/include/vlc_configuration.h
+++ b/include/vlc_configuration.h
@@ -114,8 +114,34 @@ VLC_API void config_ResetAll( vlc_object_t * );
 #define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
 
 VLC_API module_config_t * config_FindConfig(const char *) VLC_USED;
-VLC_API char * config_GetDataDir(void) VLC_USED VLC_MALLOC;
-VLC_API char *config_GetLibDir(void) VLC_USED;
+
+/**
+ * Gets the arch-independent installation directory.
+ *
+ * This function determines the directory containing the
+ * architecture-independent installed asset files (such as image, text and
+ * message translation tables).
+ *
+ * See also config_GetLibDir().
+ *
+ * @return a heap-allocated string (use free() to release it), or NULL on error
+ */
+VLC_API char *config_GetDataDir(void) VLC_USED VLC_MALLOC;
+
+/**
+ * Gets the arch-specific installation directory.
+ *
+ * This function determines the directory containing the architecture-specific
+ * installed asset files (such as executable plugins and compiled byte code).
+ *
+ * See also config_GetDataDir().
+ *
+ * \note config_GetDataDir() and config_GetLibDir() may or may not return the
+ * same path, depending on conventions of the operating system.
+ *
+ * @return a heap-allocated string (use free() to release it), or NULL on error
+ */
+VLC_API char *config_GetLibDir(void) VLC_USED VLC_MALLOC;
 
 typedef enum vlc_userdir
 {