Commit 69b5b5df authored by Rémi Denis-Courmont's avatar Rémi Denis-Courmont

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

parent d36863ea
......@@ -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
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment