[vlc-devel] [PATCH 12/12] config: clarify

[Lyndon Brown]

From: Lyndon Brown <jnqnfe at gmail.com>
Date: Wed, 22 May 2019 02:49:15 +0100
Subject: config: clarify


diff --git a/include/vlc_configuration.h b/include/vlc_configuration.h
index 1c01152536..a0d03772a1 100644
--- a/include/vlc_configuration.h
+++ b/include/vlc_configuration.h
@@ -112,7 +112,7 @@ struct module_config_t
 VLC_API int config_GetType(const char *name) VLC_USED;
 
 /**
- * Gets an integer configuration item.
+ * Gets an integer configuration item's value.
  *
  * This function retrieves the current value of a configuration item of
  * integral type (\ref CONFIG_ITEM_INTEGER and \ref CONFIG_ITEM_BOOL).
@@ -127,7 +127,7 @@ VLC_API int config_GetType(const char *name) VLC_USED;
 VLC_API int64_t config_GetInt(const char *name) VLC_USED;
 
 /**
- * Sets an integer configuration item.
+ * Sets an integer configuration item's value.
  *
  * This function changes the current value of a configuration item of
  * integral type (\ref CONFIG_ITEM_INTEGER and \ref CONFIG_ITEM_BOOL).
@@ -144,7 +144,7 @@ VLC_API int64_t config_GetInt(const char *name) VLC_USED;
 VLC_API void config_PutInt(const char *name, int64_t val);
 
 /**
- * Gets an floating point configuration item.
+ * Gets a floating point configuration item's value.
  *
  * This function retrieves the current value of a configuration item of
  * floating point type (\ref CONFIG_ITEM_FLOAT).
@@ -160,7 +160,7 @@ VLC_API void config_PutInt(const char *name, int64_t val);
 VLC_API float config_GetFloat(const char *name) VLC_USED;
 
 /**
- * Sets an floating point configuration item.
+ * Sets a floating point configuration item's value.
  *
  * This function changes the current value of a configuration item of
  * floating point type (\ref CONFIG_ITEM_FLOAT).
@@ -177,7 +177,7 @@ VLC_API float config_GetFloat(const char *name) VLC_USED;
 VLC_API void config_PutFloat(const char *name, float val);
 
 /**
- * Gets an string configuration item.
+ * Gets a string configuration item's value.
  *
  * This function retrieves the current value of a configuration item of
  * string type (\ref CONFIG_ITEM_STRING).
@@ -199,7 +199,7 @@ VLC_API void config_PutFloat(const char *name, float val);
 VLC_API char *config_GetPsz(const char *name) VLC_USED VLC_MALLOC;
 
 /**
- * Sets an string configuration item.
+ * Sets a string configuration item's value.
  *
  * This function changes the current value of a configuration item of
  * string type (e.g. \ref CONFIG_ITEM_STRING).