Several comments in the function descriptions have been corrected.
-- Miroslav Zagorac Senior Developer
>From 0b7cd96bbda98e10108316d087fc1828b9f1f564 Mon Sep 17 00:00:00 2001 From: Miroslav Zagorac <[email protected]> Date: Tue, 1 Mar 2022 19:18:34 +0100 Subject: [PATCH 08/16] DOC: opentracing: corrected comments in function descriptions Several comments in the function descriptions have been corrected. --- addons/ot/src/pool.c | 2 +- addons/ot/src/vars.c | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/addons/ot/src/pool.c b/addons/ot/src/pool.c index ead53e1b8..0ee542654 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 32fd19fac..daaa14927 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,9 @@ void flt_ot_vars_dump(struct stream *s) * data - * * 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 * This function does not return a value. @@ -125,7 +129,8 @@ static inline void flt_ot_smp_init(struct stream *s, struct sample *smp, uint op * - * * 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) { @@ -231,7 +236,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 * - -- 2.30.2
