簡體   English   中英

Doxygen忽略了@method

[英]Doxygen ignores @method

我有一些神奇的方法,但仍然在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的文件。

Doxygen已經實現了您的問題解決方案,它被稱為ALIASES。 應使用ALIASES配置標記在配置文件中指定別名的定義。

簡單的別名

別名的最簡單形式是對表單的簡單替換

name=value

例如,定義以下別名:

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

將允許您將命令\\ sideeffect(或@sideeffect)放在文檔中,這將導致用戶定義的段落標題為Side Effects:。

請注意 ,您可以將\\ n放在別名的值部分以插入換行符。

另請注意,如果您願意,可以重新定義現有的特殊命令。

某些命令(如\\ xrefitem)旨在與別名結合使用。

希望這可以解決您的問題,並獲取更多信息訪問doxygen

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM