DOC: opentracing: corrected comments in function descriptions
Several comments in the function descriptions have been corrected.
This patch must be backported as far as 2.4.
(cherry picked from commit b51e94b0b3c90322f24ed99710c769230d08c9e9)
Signed-off-by: Christopher Faulet <cfaulet@haproxy.com>
(cherry picked from commit 035b9998b19bb2bebf2fdd4373ab38915af25d41)
Signed-off-by: Christopher Faulet <cfaulet@haproxy.com>
diff --git a/addons/ot/src/vars.c b/addons/ot/src/vars.c
index 06696b7..81cb9df 100644
--- a/addons/ot/src/vars.c
+++ b/addons/ot/src/vars.c
@@ -31,7 +31,8 @@
* scope -
*
* DESCRIPTION
- * -
+ * Function prints the contents of all variables defined for a particular
+ * scope.
*
* RETURN VALUE
* This function does not return a value.
@@ -58,7 +59,8 @@
* s -
*
* DESCRIPTION
- * -
+ * Function prints the contents of all variables grouped by individual
+ * scope.
*
* RETURN VALUE
* This function does not return a value.
@@ -95,7 +97,8 @@
* -
*
* RETURN VALUE
- * -
+ * Returns the struct vars pointer for a stream and scope, or NULL if it does
+ * not exist.
*/
static inline struct vars *flt_ot_get_vars(struct stream *s, const char *scope)
{
@@ -201,7 +204,9 @@
* err -
*
* DESCRIPTION
- * -
+ * The function initializes the value of the 'smp' structure. If the 'data'
+ * argument is set, then the 'sample_data' member of the 'smp' structure is
+ * also initialized.
*
* RETURN VALUE
* -