string: escape references to \r and \n

Without these escapes, \r and \n don't show up in the
HTML output, and Doxygen throws a warning.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I6bbb8cf5b461999572077cc7381901ca3982d674

Reviewed-on: https://review.gerrithub.io/415856
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
This commit is contained in:
Jim Harris 2018-06-18 07:26:07 -07:00
parent f2d4c77797
commit cccc940efa

View File

@ -124,7 +124,7 @@ const char *spdk_strerror(int errnum);
/**
* Remove trailing newlines from the end of a string in place.
*
* Any sequence of trailing \r and \n characters is removed from the end of the
* Any sequence of trailing \\r and \\n characters is removed from the end of the
* string.
*
* \param s String to remove newline from.