Commit cccc940e authored by Jim Harris's avatar Jim Harris
Browse files

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: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I6bbb8cf5b461999572077cc7381901ca3982d674

Reviewed-on: https://review.gerrithub.io/415856


Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
parent f2d4c777

include/spdk/string.h

+1 −1
Original line number Diff line number Diff line
@@ -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.