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

Robert Schwebel r.schwebel at pengutronix.de
Fri Dec 11 05:43:16 EST 2009


On Fri, Dec 11, 2009 at 10:38:09AM +0100, Juergen Beisert wrote:
> 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

Doesn't "should" mean that it *should* skip it (but maybe sometimes
doesn't)? Maybe better DOXYGEN_SKIP?

Any native speaker here?

rsc
-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |




More information about the u-boot-v2 mailing list