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>
This commit is contained in:
Andrew Yourtchenko
2019-01-21 16:01:41 +01:00
parent 6e5f93e70d
commit 1705599efe

View File

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