summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJaroslav Kysela <perex@perex.cz>2001-07-19 16:11:50 +0000
committerJaroslav Kysela <perex@perex.cz>2001-07-19 16:11:50 +0000
commit1e658ea05a13feda69b5fcb487584ea20f15cdee (patch)
treec92bc1ca47e2101929939392bf5a6e2e7d6f6e82
parent255fc1d22d012c8ea8ce63b4af484adf3bc591d3 (diff)
Improved documentation for snd_config_update
-rw-r--r--src/conf.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/conf.c b/src/conf.c
index e2144c0f..4dbc7d88 100644
--- a/src/conf.c
+++ b/src/conf.c
@@ -2055,7 +2055,9 @@ int snd_config_hook_load_for_all_cards(snd_config_t *root, snd_config_t *config,
* \brief Update #snd_config rereading (if needed) files specified in
* environment variable ALSA_CONFIG_PATH. If it's not set the default value is
* "/usr/share/alsa/alsa.conf".
- * \return 0 if no action is needed, 1 if tree has been rebuilt otherwise a negative error code
+ * \return non-negative value on success, otherwise a negative error code
+ * \retval 0 no action is needed
+ * \retval 1 tree has been rebuild
*
* Warning: If config tree is reread all the string pointer and config
* node handle previously obtained from this tree become invalid