Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Force doxygen modules to begin with lower case letter

Tags:

c

doxygen

I'm documenting a C project using doxygen, and am grouping collection of files into modules (where each module contains all documentation for a c style class). Everything I have works fine, except that all Module names begin with a capital letter, even when I create the module group with an all lower case name.

For example, the following doxygen comments will generate a module "Foobar" in my documentation, even though I add to group "foobar" and want the module to be called "foobar":

    /**
     *@addtogroup foobar
     *@{
     * (some documentation elements...)
     *@}
     */

While the capitalization does not affect the documentation in any serious way I would like to fix it for consistency (and because I can't make myself let it go). Google has come up dry, any suggestions?

like image 255
theck01 Avatar asked Oct 04 '22 19:10

theck01


1 Answers

I nearly missed this in the doxygen manual:

To define a group, you should put the \defgroup command in a special comment block. The first argument of the command is a label that should uniquely identify the group. The second argument is the name or title of the group as it should appear in the documentation.

So you should be able to do

@addtogroup foobar foobar
like image 86
E-rich Avatar answered Oct 12 '22 12:10

E-rich