From fcaa2f101083666f83fed71f28008edd2217a364 Mon Sep 17 00:00:00 2001 From: Chris Luke Date: Wed, 7 Sep 2016 15:01:31 -0400 Subject: VPP-223 Various documentation fixes. [Note: This is an amalgamation of two patches on master with only the parts relevant to stable included. See 16bcf7d8 and d4024f58] This is a cleanup of some obvious syntactic issues with Doxygen tags in the documentation. It is not an attempt to improve the documentation itself. Change-Id: I278ad91fe980243778f84560c5e4b84a9423dc09 Signed-off-by: Chris Luke --- vppinfra/vppinfra/bihash_8_8.h | 2 +- vppinfra/vppinfra/bihash_doc.h | 2 +- vppinfra/vppinfra/bihash_template.c | 4 ++-- vppinfra/vppinfra/bihash_template.h | 4 ++-- vppinfra/vppinfra/bitmap.h | 8 ++++---- 5 files changed, 10 insertions(+), 10 deletions(-) (limited to 'vppinfra') diff --git a/vppinfra/vppinfra/bihash_8_8.h b/vppinfra/vppinfra/bihash_8_8.h index b5f4e3bfdfa..9b5da5a2b89 100644 --- a/vppinfra/vppinfra/bihash_8_8.h +++ b/vppinfra/vppinfra/bihash_8_8.h @@ -54,7 +54,7 @@ clib_bihash_hash_8_8 (clib_bihash_kv_8_8_t * v) /** Format a clib_bihash_kv_8_8_t instance @param s - u8 * vector under construction - @param v (vararg) - the (key,value) pair to format + @param args (vararg) - the (key,value) pair to format @return s - the u8 * vector under construction */ static inline u8 * diff --git a/vppinfra/vppinfra/bihash_doc.h b/vppinfra/vppinfra/bihash_doc.h index da3d0a9b55b..e6ab9db6d30 100644 --- a/vppinfra/vppinfra/bihash_doc.h +++ b/vppinfra/vppinfra/bihash_doc.h @@ -108,7 +108,7 @@ void clib_bihash_free (clib_bihash * h); /** Add or delete a (key,value) pair from a bi-hash table @param h - the bi-hash table to search - @param add_kv - the (key,value) pair to add + @param add_v - the (key,value) pair to add @param is_add - add=1, delete=0 @returns 0 on success, < 0 on error @note This function will replace an existing (key,value) pair if the diff --git a/vppinfra/vppinfra/bihash_template.c b/vppinfra/vppinfra/bihash_template.c index a8d095c9758..2ad8293094c 100644 --- a/vppinfra/vppinfra/bihash_template.c +++ b/vppinfra/vppinfra/bihash_template.c @@ -13,7 +13,7 @@ * limitations under the License. */ -/** @if DOCUMENTATION_IS_IN_BIHASH_DOC_H */ +/** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */ void BV (clib_bihash_init) (BVT (clib_bihash) * h, char *name, u32 nbuckets, uword memory_size) @@ -444,7 +444,7 @@ void BV (clib_bihash_foreach_key_value_pair) } } -/** @endif */ +/** @endcond */ /* * fd.io coding-style-patch-verification: ON diff --git a/vppinfra/vppinfra/bihash_template.h b/vppinfra/vppinfra/bihash_template.h index 07c3e7daec7..a8bb27ffb0e 100644 --- a/vppinfra/vppinfra/bihash_template.h +++ b/vppinfra/vppinfra/bihash_template.h @@ -14,7 +14,7 @@ * limitations under the License. */ -/** @if DOCUMENTATION_IS_IN_BIHASH_DOC_H */ +/** @cond DOCUMENTATION_IS_IN_BIHASH_DOC_H */ /* * Note: to instantiate the template multiple times in a single file, @@ -203,7 +203,7 @@ static inline int BV (clib_bihash_search_inline_2) #endif /* __included_bihash_template_h__ */ -/** @endif */ +/** @endcond */ /* * fd.io coding-style-patch-verification: ON diff --git a/vppinfra/vppinfra/bitmap.h b/vppinfra/vppinfra/bitmap.h index 4c27820d334..9e1ae493285 100644 --- a/vppinfra/vppinfra/bitmap.h +++ b/vppinfra/vppinfra/bitmap.h @@ -81,7 +81,7 @@ clib_bitmap_is_equal (uword * a, uword * b) } /** Duplicate a bitmap - @param ai - pointer to a bitmap + @param v - pointer to a bitmap @returns a duplicate of the bitmap */ #define clib_bitmap_dup(v) vec_dup(v) @@ -158,9 +158,9 @@ clib_bitmap_set_no_check (uword * a, uword i, uword new_value) /** Sets the ith bit of a bitmap to new_value Removes trailing zeros from the bitmap - @param a - pointer to the bitmap + @param ai - pointer to the bitmap @param i - the bit position to interrogate - @param new_value - new value for the bit + @param value - new value for the bit @returns the old value of the bit */ always_inline uword * @@ -588,7 +588,7 @@ _(andnoti, a = a & ~b, 1) _(ori, a = a | b, 0) _(xori, a = a ^ b, 1) /** Return a random bitmap of the requested length @param ai - pointer to the destination bitmap @param n_bits - number of bits to allocate - @param [in/out] seed - pointer to the random number seed + @param [in,out] seed - pointer to the random number seed @returns a reasonably random bitmap based. See random.h. */ always_inline uword * -- cgit 1.2.3-korg