I normally document certain C macros in a .h file with the following syntax:

   #ifndef SOMETHING_IN_H
   /** Document something */
   #define SOMETHING_IN_H
   #endif /* SOMETHING_IN_H */

I need to document some macros that are in a file with extension .inc which
is included into certain C implementation files.  I enable this by adding to
doxygen.cfg:

   EXTENSION_MAPPING = inc=C

However using my normal pattern in a .inc file with several versions
including svn head I get:

   /tmp/test/test.inc:4: warning: documentation for unknown define 
SOMETHING_IN_INC found.

It turns out that, though I've asked Doxygen to treat .inc files as C files,
scanner.l's implementation of CLanguageScanner::needsPreprocessing
explicitly rejects preprocessing .inc files (as it does .java, .as, 
.php, and
several other extensions).

I can see the exclusion of files with extensions exclusively associated with
other languages, but "inc" is pretty generic and (IMO) should not be assumed
by Doxygen to be a PHP source file (which appears to be the default).

Any chance of getting this fixed?  I can work around it by building a local
patched version of Doxygen and packaging its output, but that wouldn't help
anybody who downloads my code and wants to build the documentation
themselves.

Peter


------------------------------------------------------------------------------
AlienVault Unified Security Management (USM) platform delivers complete
security visibility with the essential security capabilities. Easily and
efficiently configure, manage, and operate all of your security controls
from a single console and one unified framework. Download a free trial.
http://p.sf.net/sfu/alienvault_d2d
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to