Revision: 75650
http://sourceforge.net/p/brlcad/code/75650
Author: brlcad
Date: 2020-04-30 06:41:30 +0000 (Thu, 30 Apr 2020)
Log Message:
-----------
quell documentation warning. let clang know these are code samples
Modified Paths:
--------------
brlcad/trunk/include/bu/str.h
Modified: brlcad/trunk/include/bu/str.h
===================================================================
--- brlcad/trunk/include/bu/str.h 2020-04-30 05:23:19 UTC (rev 75649)
+++ brlcad/trunk/include/bu/str.h 2020-04-30 06:41:30 UTC (rev 75650)
@@ -191,16 +191,18 @@
* string, bu_bomb() is called.
*
* Example:
- * char *result;
- * char buf[128];
- * result = bu_str_escape("my fair lady", " ", buf, 128);
- * :: result == buf == "my\ fair\ lady"
- * result = bu_str_escape(buf, "\", NULL, 0);
- * :: result == "my\\ fair\\ lady"
- * :: buf == "my\ fair\ lady"
- * bu_free(result, "bu_str_escape");
- * result = bu_str_escape(buf, "a-zA-Z", buf, 128);
- * :: result == buf == "\m\y\ \f\a\i\r\ \l\a\d\y"
+ @code
+ char *result;
+ char buf[128];
+ result = bu_str_escape("my fair lady", " ", buf, 128);
+ :: result == buf == "my\ fair\ lady"
+ result = bu_str_escape(buf, "\", NULL, 0);
+ :: result == "my\\ fair\\ lady"
+ :: buf == "my\ fair\ lady"
+ bu_free(result, "bu_str_escape");
+ result = bu_str_escape(buf, "a-zA-Z", buf, 128);
+ :: result == buf == "\m\y\ \f\a\i\r\ \l\a\d\y"
+ @endcode
*
* This function should be thread safe and re-entrant if the
* input/output buffers are not shared (and strlen() is threadsafe).
@@ -223,14 +225,16 @@
* string, bu_bomb() is called.
*
* Example:
- * char *result;
- * char buf[128];
- * result = bu_str_unescape("\m\y\\ \f\a\i\r\\ \l\a\d\y", buf, 128);
- * :: result == buf == "my\ fair\ lady"
- * result = bu_str_unescape(buf, NULL, 0);
- * :: result == "my fair lady"
- * :: buf == "my\ fair\ lady"
- * bu_free(result, "bu_str_unescape");
+ @code
+ char *result;
+ char buf[128];
+ result = bu_str_unescape("\m\y\\ \f\a\i\r\\ \l\a\d\y", buf, 128);
+ :: result == buf == "my\ fair\ lady"
+ result = bu_str_unescape(buf, NULL, 0);
+ :: result == "my fair lady"
+ :: buf == "my\ fair\ lady"
+ bu_free(result, "bu_str_unescape");
+ @endcode
*
* This function should be thread safe and re-entrant if the
* input/output buffers are not shared (and strlen() is threadsafe).
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
