From: Andrew Yourtchenko <ayourtch@gmail.com>
Date: Mon, 21 Jan 2019 15:01:41 +0000 (+0100)
Subject: doxygen formatting fix: prevent stray examples appearing in the docs
X-Git-Tag: v19.04-rc1~634
X-Git-Url: https://gerrit.fd.io/r/gitweb?a=commitdiff_plain;h=5e0c5ff9c0d71bf495bb23e23e0ab4c5fffe00e8;p=vpp.git

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)
---

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.";
  *