Re: Doc proto question
| From: | Jesus M. Castagnetto | Date: | Mon, 30 Dec 2002 08:33:40 +0000 |
| Subject: | Re: Doc proto question | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-11940@lists.php.net to get a copy of this message | ||
Not really. Most of the PHP code documentation tools are based on the
Javadoc-style (see http://java.sun.com/j2se/javadoc/writingdoccomments/
for
details).
The one I am using lately (PHPDocumentor) has its documented tags here:
http://phpdocu.sourceforge.net/spec/tags/tags.html
Usually you mention that the method is static in the description:
/**
* Static method that solves NP-complete equations
* ...
*/
function solveNP($equation) {
return "yeah, right!";
}
Now, as for the C code I am not sure, but I gather that as it is C and not C++,
you will also need to put it in the documentation as a comment.
--- l0t3k <cshmoove@hotmail.com> wrote:
> is there a way with the current doc tools to markup a method to indicate
> that it's static ?
> im thinking primarily about the proto headers in extension source, but id
> appreciate answers r.e. PHPDoc also
>
> l0t3k
=====
--- Jesus M. Castagnetto (jcastagnetto@yahoo.com)
Research:
http://metallo.scripps.edu/
Personal: http://www.castagnetto.org/
__________________________________________________
Do you Yahoo!?
Yahoo! Mail Plus - Powerful. Affordable. Sign up now.
http://mailplus.yahoo.com