[PATCH] Add a define to prevent doxygen to scan things it should not see (fixed version)

Juergen Beisert jbe at pengutronix.de
Fri Dec 11 04:38:09 EST 2009


Next try, with only one hunk.

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 |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Index: u-boot-2.0.0-rc10/Doxyfile
===================================================================
--- u-boot-2.0.0-rc10.orig/Doxyfile
+++ u-boot-2.0.0-rc10/Doxyfile
@@ -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/  |




More information about the u-boot-v2 mailing list