[PATCH] Add a define to prevent doxygen to scan things it should not see

[Juergen Beisert]

This macro helps to prevent doxygen from scanning content it shouldn't or
cannot parse (assembler files for example). For all parts of source code it
should not scan, use:

---------------------------------------
<things to scan>

#ifndef DOXYGEN_SHOULD_SKIP_THIS

<things not to scan>

#endif

<things to scan>
---------------------------------------

This should not confuse the regular C compiler.

Signed-off-by: Juergen Beisert <jbe at pengutronix.de>

---
 Doxyfile |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Index: u-boot-2.0.0-rc10/Doxyfile
===================================================================
--- u-boot-2.0.0-rc10.orig/Doxyfile
+++ u-boot-2.0.0-rc10/Doxyfile
@@ -1034,7 +1034,7 @@ MACRO_EXPANSION        = NO
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
 # then the macro expansion is limited to the macros specified with the
-# PREDEFINED and EXPAND_AS_DEFINED tags.
+#  and EXPAND_AS_DEFINED tags.
 
 EXPAND_ONLY_PREDEF     = NO
 
@@ -1064,7 +1064,7 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator
 # instead of the = operator.
 
-PREDEFINED             =
+PREDEFINED             = DOXYGEN_SHOULD_SKIP_THIS
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.

-- 
Pengutronix e.K.                              | Juergen Beisert             |
Linux Solutions for Science and Industry      | Phone: +49-8766-939 228     |
Vertretung Sued/Muenchen, Germany             | Fax:   +49-5121-206917-5555 |
Amtsgericht Hildesheim, HRA 2686              | http://www.pengutronix.de/  |