[Doxygen-users] Re: Limited Support for VB

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

> '
> '/*!
> '// \fn MyPatheticVBfunction(one AS integer)
> '//     yadda yadda description..
> '*/
> 
> Now this does not work because of the ' (single quote) 

A similar problem exists for shell scripts and other languages which use other 
comment markers.  A Doxygen command can be in a shell script after the 
script's '#' comment marker, but if the Doxygen command goes to a second line 
then the '#' is inserted in the Doxygen string.

I'm aware of six solutions:

1. Preprocess your files with programs which reformat for Doxygen.
2. Change Doxygen to configure the comment markers for each file or file suffix.
3. Change Doxygen to magically recognize umpteen file formats.
4. Change Doxygen so when it finds a Doxygen command it assumes the group of 
characters just ahead of the Doxygen command is the start-comment marker, and a 
group of symbol characters at the end of the line is the end-comment marker.  
Then ignore those strings until the end of the Doxygen command. (variation: 
limit this examination to the "@file" line then apply that rule to the file.)
5. Change Doxygen so when it recognizes a Doxygen command it remembers the C-
type comment marker ahead of the command, then ignores the start of following 
lines up to that same marker.
6. Change Doxygen to have a comment-definition command which is unique enough 
to be recognized in many file formats.  But this requires this command be in 
each file.  However, this command can work with the other techniques also.