doxygen-users

[Doxygen-users] How to add arbitrary methods which don't exist in code

[digitaldonkey <em...@do...>]

PHP has the concept of  Magic Methods
<http://php.net/manual/en/language.oop5.magic.php>   and I'm searching a way
how to document them. 

PhpDocumentator provides a @method property which generates the methods in
documentation, even thou they don't exist in code. 

I've seen many questions to this on the list and in StackOverflow, but none
seems to be answered.

* https://stackoverflow.com/questions/18126608/doxygen-ignores-method
*
http://doxygen.10944.n7.nabble.com/Generating-documentation-without-a-function-definition-tt2248.html#a2250
*
http://doxygen.10944.n7.nabble.com/PHP-and-arbitrary-class-properties-tt3885.html
* http://doxygen.10944.n7.nabble.com/Custom-Methods-tt2748.html

These methods becomming more and more popular as people creating API's from
Json definitions.

Is there any best practice solution? 
A simple workaround would be to just write the doc-block with @method, but
doxygen refuses to add the doc ("warning: documented symbol `public string
myFunction' was not declared or defined."). 
Is there any setting to add them if not in code? 
Wouldn't it be a feature?

Thank you





--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html

[Doxygen-users] How to add arbitrary methods which don't exist in code

[digitaldonkey <em...@do...>]

PHP has the concept of  Magic Methods
<http://php.net/manual/en/language.oop5.magic.php>   and I'm searching a way
how to document them. 

PhpDocumentator provides a @method property which generates the methods in
documentation, even thou they don't exist in code. 

I've seen many questions to this on the list and in StackOverflow, but none
seems to be answered.

* https://stackoverflow.com/questions/18126608/doxygen-ignores-method
*
http://doxygen.10944.n7.nabble.com/Generating-documentation-without-a-function-definition-tt2248.html#a2250
*
http://doxygen.10944.n7.nabble.com/PHP-and-arbitrary-class-properties-tt3885.html
* http://doxygen.10944.n7.nabble.com/Custom-Methods-tt2748.html

These methods becomming more and more popular as people creating API's from
Json definitions.

Is there any best practice solution? 
A simple workaround would be to just write the doc-block with @method, but
doxygen refuses to add the doc ("warning: documented symbol `public string
myFunction' was not declared or defined."). 
Is there any setting to add them if not in code? 
Wouldn't it be a feature?

Thank you





--
Sent from: http://doxygen.10944.n7.nabble.com/Doxygen-Users-f3.html