From: Miroslav Zagorac <mzagorac@haproxy.com>
Date: Tue, 1 Mar 2022 18:18:34 +0000 (+0100)
Subject: DOC: opentracing: corrected comments in function descriptions
X-Git-Tag: v2.6-dev5~14
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b51e94b0b3c90322f24ed99710c769230d08c9e9;p=thirdparty%2Fhaproxy.git

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.
---

diff --git a/addons/ot/src/pool.c b/addons/ot/src/pool.c
index ead53e1b8b..0ee5426548 100644
--- a/addons/ot/src/pool.c
+++ b/addons/ot/src/pool.c
@@ -147,7 +147,7 @@ void flt_ot_pool_free(struct pool_head *pool, void **ptr)
  *   -
  *
  * RETURN VALUE
- *   This function does not return a value.
+ *   -
  */
 struct buffer *flt_ot_trash_alloc(bool flag_clear, char **err)
 {
diff --git a/addons/ot/src/vars.c b/addons/ot/src/vars.c
index 33923938a4..d67879a540 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 @@ static void flt_ot_vars_scope_dump(struct vars *vars, const char *scope)
  *   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 @@ void flt_ot_vars_dump(struct stream *s)
  *   -
  *
  * 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 @@ static int flt_ot_normalize_name(char *var_name, size_t size, int *len, const ch
  *   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
  *   -