php - Doxygen 忽略@method

Question

我有一些神奇的方法，但在 netbeans 中仍然具有自动完成功能。我在所有类上面都使用了一个 block ，例如:

/**
 * @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