Revision: 77055
http://sourceforge.net/p/brlcad/code/77055
Author: brlcad
Date: 2020-09-04 04:34:13 +0000 (Fri, 04 Sep 2020)
Log Message:
-----------
go ahead and put the snippets into code/endcode blocks to make their callout
more explicit and obvious.
Modified Paths:
--------------
brlcad/trunk/include/common.h
Modified: brlcad/trunk/include/common.h
===================================================================
--- brlcad/trunk/include/common.h 2020-09-04 04:14:46 UTC (rev 77054)
+++ brlcad/trunk/include/common.h 2020-09-04 04:34:13 UTC (rev 77055)
@@ -466,8 +466,10 @@
/**
* Provide canonical preprocessor stringification.
*
+ @code
* #define abc 123
* CPP_STR(abc) => "abc"
+ @endcode
*/
#ifndef CPP_STR
# define CPP_STR(x) # x
@@ -476,8 +478,10 @@
/**
* Provide canonical preprocessor expanded stringification.
*
+ @code
* #define abc 123
* CPP_XSTR(abc) => "123"
+ @endcode
*/
#ifndef CPP_XSTR
# define CPP_XSTR(x) CPP_STR(x)
@@ -486,6 +490,7 @@
/**
* Provide canonical preprocessor concatenation.
*
+ @code
* #define abc 123
* CPP_GLUE(abc, 123) => abc123
* CPP_STR(CPP_GLUE(abc, 123)) => "CPP_GLUE(abc, 123)"
@@ -492,6 +497,7 @@
* CPP_XSTR(CPP_GLUE(abc, 123)) => "abc123"
* #define abc123 "xyz"
* CPP_GLUE(abc, 123) => abc123 => "xyz"
+ @endcode
*/
#ifndef CPP_GLUE
# define CPP_GLUE(a, b) a ## b
@@ -500,10 +506,12 @@
/**
* Provide canonical preprocessor expanded concatenation.
*
+ @code
* #define abc 123
* CPP_XGLUE(abc, 123) => 123123
* CPP_STR(CPP_XGLUE(abc, 123)) => "CPP_XGLUE(abc, 123)"
* CPP_XSTR(CPP_XGLUE(abc, 123)) => "123123"
+ @endcode
*/
#ifndef CPP_XGLUE
# define CPP_XGLUE(a, b) CPP_GLUE(a, b)
@@ -512,9 +520,11 @@
/**
* Provide format specifier string tied to a size (e.g., "%123s")
*
+ @code
* #define STR_LEN 10+1
* char str[STR_LEN] = {0};
* scanf(CPP_SCANSIZE(STR_LEN) "\n", str);
+ @endcode
*/
#ifndef CPP_SCAN
# define CPP_SCAN(sz) "%" CPP_XSTR(sz) "s"
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
