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.
This commit is contained in:
Miroslav Zagorac 2022-03-01 19:18:34 +01:00 committed by Willy Tarreau
parent 9154e00f70
commit b51e94b0b3
2 changed files with 10 additions and 5 deletions

View File

@ -147,7 +147,7 @@ void flt_ot_pool_free(struct pool_head *pool, void **ptr)
* - * -
* *
* RETURN VALUE * RETURN VALUE
* This function does not return a value. * -
*/ */
struct buffer *flt_ot_trash_alloc(bool flag_clear, char **err) struct buffer *flt_ot_trash_alloc(bool flag_clear, char **err)
{ {

View File

@ -31,7 +31,8 @@
* scope - * scope -
* *
* DESCRIPTION * DESCRIPTION
* - * Function prints the contents of all variables defined for a particular
* scope.
* *
* RETURN VALUE * RETURN VALUE
* This function does not return a 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 - * s -
* *
* DESCRIPTION * DESCRIPTION
* - * Function prints the contents of all variables grouped by individual
* scope.
* *
* RETURN VALUE * RETURN VALUE
* This function does not return a value. * This function does not return a value.
@ -95,7 +97,8 @@ void flt_ot_vars_dump(struct stream *s)
* - * -
* *
* RETURN VALUE * 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) 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 - * err -
* *
* DESCRIPTION * 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 * RETURN VALUE
* - * -