Question

我正在尝试从phpDocumentor切换到doxygen，但我的所有类都记录在以下样式中：

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

但是除非我将第一行更改为

，否则doxygen不会将其识别为类doc

/*! \class CLASSNAME

有没有办法告诉doxygen使用“/ **”风格？

问候

Answer 1

Doxygen应该识别JavaDoc（即/ **）注释。问题可能是您的简短描述没有被自动检测到。

要使Doxygen使用这些简短描述，您需要在配置文件中将JAVADOC_AUTOBRIEF设置为YES。

有关Doxygen文档样式如何查看的更多信息at this

Answer 2

我发现了问题（但不是真正的解决方案）：Doxygen不喜欢@category＆amp; @package在类doc块中。如果我删除它们就可以了。

Answer 3

例如，如果您的同事仍然使用phpDoc，您可以使用INPUT_FILTER配置过滤掉不需要的标签：

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

inputfilter脚本必须是可执行的，其内容可以是这样的：

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

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

如何告诉doxygen使用/ **作为类doc而不是/ *！ \类

3 个答案: