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

[Sascha Hauer]

On Fri, Dec 11, 2009 at 11:43:16AM +0100, Robert Schwebel wrote:
> 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?

My suggestion would be just DOXYGEN which is quite clear IMO, but a
quick grep through /usr/include shows that DOXYGEN_SHOULD_SKIP_THIS is
widely used, so it's fine.

Sascha


-- 
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 |