Doxygen ignores @method

Question

i have some magic methodes but to have still auto complete functions in netbeans. I use above all classes a block like:

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

For netbeans this works pretty good. But doxygen seams to ignore it totaly.

Has someone an idea if it is possible to let doxygen accept the @method tag?

I know that phpDocumentator can handle this. But i prever the documentations of doxygen, caused by several reasons.

Answer 1

Doxygen has already implemented your problem solution and it is known as ALIASES. The definition of an alias should be specified in the configuration file using the ALIASES configuration tag.

Simple aliases

The simplest form of an alias is a simple substitution of the form

name=value

For example defining the following alias:

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

will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in a user-defined paragraph with heading Side Effects:.

Note that you can put \n's in the value part of an alias to insert newlines.

Also note that you can redefine existing special commands if you wish.

Some commands, such as \xrefitem are designed to be used in combination with aliases.

Hope this resolve your problem and for more info visit doxygen