简单别名

Question

我有一些神奇的方法，但仍然在netbeans中自动完成功能。我在上面的所有类中使用了一个块：

/**
 * @method int getEavConfigId() get object id
 * @method Model_DbTable_EavConfig setEntityType(string $entity_type) set entity_type possible values site, user, pc, ticket, alarm ; eav field is realted to this table
 * @method string getEntityType() get entity_type possible values site, user, pc, ticket, alarm ; eav field is realted to this table
 * @method Model_DbTable_EavConfig setCompanyId(integer $company_id) set company_id
 * @method integer getCompanyId() get company_id
 * @method Model_DbTable_EavConfig setType(string $type) set type possible values textfield, textarea, radio, checkbox, select ; eav field type
 * @method string getType() get type possible values textfield, textarea, radio, checkbox, select ; eav field type
 */

对于netbeans，这非常好用。但是doxygen接缝完全无视它。

有人知道是否可以让doxygen接受@method标签？

我知道phpDocumentator可以处理这个问题。但是，由于几个原因，我首先提出了doxygen的文件。

Answer 1

Doxygen已经实现了您的问题解决方案，它被称为ALIASES。应使用ALIASES配置标记在配置文件中指定别名的定义。

简单别名

别名的最简单形式是简单替换形式

name=value

例如，定义以下别名：

ALIASES += sideeffect="\par Side Effects:\n"

将允许您将命令\ sideeffect（或@sideeffect）放在文档中，这将导致用户定义的段落标题为Side Effects：。

注意您可以将\ n放在别名的值部分以插入换行符。

另请注意，如果您愿意，可以重新定义现有的特殊命令。

某些命令（例如\ xrefitem）旨在与别名结合使用。

希望这可以解决您的问题，有关详细信息，请访问doxygen

Doxygen忽略了@method

1 个答案:

简单别名