Doxygen ignores @ method

Question

Mam pewne magiczne metody, ale wciąż mam funkcje automatycznego uzupełniania w netbeans. używam przede wszystkim klas blok jak:

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

dla NetBeans to działa całkiem dobrze. Ale szwy doxygen ignorują to totalnie.

Czy ktoś ma pomysł, aby umożliwić doxygenowi przyjęcie tagu @method?

Wiem, że phpDocumentator może sobie z tym poradzić. Ale przechowuję dokumentacje doxygen, spowodowane kilkoma przyczynami.

Answer 1

Doxygen już wdrożył Twoje rozwiązanie problemu i jest znane jako ALIASES. Definicja aliasu powinna zostać określona w pliku konfiguracyjnym za pomocą znacznika konfiguracji ALIASES.

Proste aliasy

Najprostszą formą aliasu jest proste podstawienie postaci

name=value 

Na przykład definiując następujące Alias:

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

pozwoli Ci umieścić command \ sideeffect (lub @sideeffect) w dokumentacji, co spowoduje, że zdefiniowany przez użytkownika akapit z nagłówkiem Skutki uboczne :.

Uwaga, w której można wstawić \ n w części wartości aliasu, aby wstawić znaki nowej linii.

Należy również pamiętać o tym, że można ponownie zdefiniować istniejące polecenia specjalne, jeśli chcesz.

Niektóre polecenia, takie jak \ xrefitem, są przeznaczone do użycia w połączeniu z aliasami.

Nadzieja to rozwiązać problem i uzyskać więcej informacji odwiedź DOXYGEN