[Doxygen-users] Re: Dox with nonstandard comments

[Scot W. <sc...@wi...>]

> I'm trying to document all the files in my test project.
> Documenting the shell scripts and awk files is awkward.  Those files
> require a comment be marked with "#".

It has been pointed out to me that the INPUT_FILTER Configuration option can be 
used to alter the comment indicators of input files.  So if a file is 
recognized as a shell script a leading "#**" can be replaced with "/**".

The only mention of INPUT_FILTER is in the Configuration section, and the 
description of the following FILTER_SOURCE_FILES can be interpreted as meaning 
that FILTER_SOURCE_FILES=NO willdisable INPUT_FILTER.

Apparently if INPUT_FILTER is defined then all files are run through the 
filter, except FILTER_SOURCE_FILES controls the INPUT_FILTER use when source 
file pages are being created.

Suggested change in "Configuration" page:

INPUT_FILTER 
The INPUT_FILTER tag can be used to specify a program that doxygen should 
invoke to filter for each input file. Doxygen will invoke the filter program by 
executing (via popen()) the command:  
<filter> <input-file>
where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the 
name of an input file. Doxygen will then use the output that the filter program 
writes to standard output. 
+ The FILTER_SOURCE_FILES tag controls whether INPUT_FILTER is also used 
+ when producing source files.

Suggested change to "Documenting the code" page:

+ If using files with different comment markers, the INPUT_FILTER
+ configuration tag can be used to preprocess input files to alter them 
+ for Doxygen use.  Filter programs are not included in the Doxygen 
+ distribution.

Doxygen only allows one brief and one detailed description...