summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAndrew Yourtchenko <ayourtch@gmail.com>2019-01-21 16:01:41 +0100
committerAndrew Yourtchenko <ayourtch@gmail.com>2019-01-21 17:06:15 +0000
commit5e0c5ff9c0d71bf495bb23e23e0ab4c5fffe00e8 (patch)
tree94cea9d897b1cbd45fe5e0a90f90dcc5adc6da9f /src
parent903cf399a508f66974cab4c46877d0d07711f355 (diff)
doxygen formatting fix: prevent stray examples appearing in the docs
The 'example' keyword triggers the creation of very out-of-context example in the "Examples" top level of documentation. Rename the keyword in the comment so the comment is still readable, but does not trigger the doxygen. Change-Id: Iecbdc236918f9178a034817aa6cea7ab6b2c1654 Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com> (cherry picked from commit 1705599efe5eec09c09d2214da776d92d0e4f1cf)
Diffstat (limited to 'src')
-rw-r--r--src/vppinfra/string.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/vppinfra/string.c b/src/vppinfra/string.c
index feae5b9165c..bf6b24894e2 100644
--- a/src/vppinfra/string.c
+++ b/src/vppinfra/string.c
@@ -385,7 +385,7 @@ strncat_s (char *__restrict__ dest, rsize_t dmax,
* s1max and ptr are modified to contain the state
* null runtime constraint error or token is not found
*
- * @example
+ * Example:
* char *str2 = " ";
* char str1[100];
* uword len;
@@ -457,7 +457,7 @@ strnlen_s (const char *s, size_t maxsize)
* EINVAL runtime constraint error
* ESRCH no match
*
- * @example
+ * Example:
* char *sub = 0;
* char *s1 = "success is not final, failure is not fatal.";
*