diff options
| author | Phil Mesnier <mesnier_p@ociweb.com> | 2007-01-10 20:35:03 +0000 |
|---|---|---|
| committer | Phil Mesnier <mesnier_p@ociweb.com> | 2007-01-10 20:35:03 +0000 |
| commit | 19ceb3feaa4e53fca087e75dc3b4ddb6d0d32b2c (patch) | |
| tree | 75247490a06d0bdc229b7d57a6ce4fe10ccb8477 | |
| parent | a4fbe27fff4e23cdbb30abc1011c999c20fb0f66 (diff) | |
| download | ATCD-19ceb3feaa4e53fca087e75dc3b4ddb6d0d32b2c.tar.gz | |
Wed Jan 10 20:31:52 UTC 2007 Phil Mesnier <mesnier_p@ociweb.com>
| -rw-r--r-- | ACE/ChangeLog | 6 | ||||
| -rw-r--r-- | ACE/docs/ACE-guidelines.html | 11 |
2 files changed, 15 insertions, 2 deletions
diff --git a/ACE/ChangeLog b/ACE/ChangeLog index fde9cdd72c1..cdde84c6069 100644 --- a/ACE/ChangeLog +++ b/ACE/ChangeLog @@ -1,3 +1,9 @@ +Wed Jan 10 20:31:52 UTC 2007 Phil Mesnier <mesnier_p@ociweb.com> + + * docs/ACE-guidelines.html: + Added some text making explicit the use of "#if defined (FOO)" + rather than "#if FOO" so as to avoid trouble with Doxygen. + Wed Jan 10 16:08:32 UTC 2007 Chad Elliott <elliott_c@ociweb.com> * tests/CDR_Array_Test.cpp: diff --git a/ACE/docs/ACE-guidelines.html b/ACE/docs/ACE-guidelines.html index e558e8a06a6..ee72eb9c2d2 100644 --- a/ACE/docs/ACE-guidelines.html +++ b/ACE/docs/ACE-guidelines.html @@ -192,9 +192,16 @@ bgcolor="#ffffff"> those files #include the correct headers. If you do not do this, your code will not compile with the Standard C++ Library.<p> + <li>Always use <strong><code>#if defined (MACRONAME)</code></strong> + to test if a macro is defined, rather than the simpler + <strong><code>#if MACRONAME</code></strong>. Doxygen requires this. + The one exception to this the macros used to prevent multiple + inclusion of header files, as shown below. + <li>Always follow a preprocessor <strong><code>#endif</code></strong> - with a <strong><code>/* */</code></strong> C-style comment. It - should correspond to the condition in the matching + with a <strong><code>/* */</code></strong> C-style comment. Using + C-style comments with preprocessor code is required for some old + compilers. It should correspond to the condition in the matching <strong><code>#if</code></strong> directive. For example, <pre> #if defined (ACE_HAS_THREADS) |