diff options
| author |   Chris Luke <chrisy@flirble.org> | 2016-09-01 14:31:46 -0400 |
|---|---|---|
| committer | Chris Luke <chrisy@flirble.org> | 2016-09-01 14:31:46 -0400 |
| commit | 16bcf7d8dcd411e6a6b8d217cce5e450f7357bb3 (patch) | |
| tree | 4c59b98b9b357150af939c035ec4e8776bac2b2e /vppinfra | |
| parent | f074eef0409a64475e840f59581306273313b218 (diff) | |
VPP-346 A swathe of doc fixes
Fixes various Doxygen warnings and other structural defects.
Note: This does not attempt to improve the content of the
documentation; only to improve the syntax and structure of it
and in some cases the consistency.
Change-Id: Ib1915f33edbdbc4558c85565de80dce323193906
Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'vppinfra')
| -rw-r--r-- | vppinfra/vppinfra/bihash_template.c | 4 | ||||
| -rw-r--r-- | vppinfra/vppinfra/bihash_template.h | 4 |
2 files changed, 4 insertions, 4 deletions
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 |