开发者

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

I'm trying to switch from phpDocumentor to doxygen, but all my classes are documented in the fo开发者_Go百科llowing 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


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.


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


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'
0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜