How to tell doxygen to use /** as class doc instead /*! \class

Question

I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the following style:

/**
 * DESCRIPTION
 *
 * @category  PHP
 * @package   UserManagement.Class
 * @author    Name <email@company.com>
 * @copyright 2011 Company
 * @link      http://www.company.com
 */

but doxygen does not recognize that as the class doc unless I change the first line to

/*! \class CLASSNAME

Is there a way to tell doxygen to use the "/**" style?

regards

Sort of off-topic; but if you're sick of PHPDocumentor - like I am - you might want to consider looking at [DocBlox](http://www.docblox-project.org) instead. — Berry Langerak, Jun 06 '11 at 14:07

score 2 · Answer 1 · edited Mar 25 '19 at 18:08

2

Doxygen should recognise JavaDoc (i.e. /**) comments. The problem maybe that your short description aren't being auto-detected.

To make Doxygen use these short descriptions you need to set JAVADOC_AUTOBRIEF to YES in your config file.

For more on how Doxygen documentation style have a look at this

edited Mar 25 '19 at 18:08

albert

8,285
3
19
32

answered Jun 06 '11 at 15:30

JoshB

742
1
8
12

JAVADOC_AUTOBRIEF is enabled and it does recognise them for functions but not for classes. So the "Detailed Description" of the documentation is empty. – Christoph Fink Jun 06 '11 at 15:55
@chrfin what does it display then for classes? – JoshB Jun 06 '11 at 16:28

score 2 · Accepted Answer · answered Jun 08 '11 at 17:36

2

I found the problem (but not the real solution): Doxygen does not like the @category & @package in the class doc block. If I remove them it works.

answered Jun 08 '11 at 17:36

Christoph Fink

22,727
9
68
113

if you are on PHP 5.3 you should be able to use namespacing to provide this functionality (a bit of a hack but will probably provide the functionality you need) of course depending on situation this may/may not be possible with what you have – JoshB Jun 27 '11 at 16:56
In fact if `@category` and/or `@package` are present the class detailed description can be found in the _Namespaces_ section in generated documentation. – Ikar Pohorský Jul 03 '14 at 06:54

score 1 · Answer 3 · answered Jul 26 '13 at 08:57

If for example your co-workers still use phpDoc you can use the INPUT_FILTER configuration to filter unwanted tags away:

$ grep INPUT_FILTER doc/doxygen.config
INPUT_FILTER      = /home/gorgo/someproj/doc/doxygen.inputfilter

The inputfilter script must be executable and its content can be something like this:

$ cat doc/doxygen.inputfilter
#!/bin/sh

grep -Fv '@package' $1 | grep -Fv '@category'

How to tell doxygen to use /** as class doc instead /*! \class

3 Answers3