[wp-hackers] Inline documentation

[Abhay Kumar]

> [snip]
> that's the phpDoc syntax. A list of valid tags is available at
> http://www.phpdoc.de/kongress/tags.html (Sorry, in German only).
It is both the syntax for phpdocumentor and phpdoc. An english list is
linked on the codex page
(http://codex.wordpress.org/Inline_Documentation).

I discussed the possible tags we could use, earlier:
http://comox.textdrive.com/pipermail/wp-hackers/2006-February/005002.html
(happier now, skippy? next time if you have a comment, tell me
directly instead of just spewing to IRC)

> A full phpDoc comment for a method or function can look like
> this:

Another great reference is the PEAR manual which contains a litlte
more than is needed here but you can see the synatax in action.

http://pear.php.net/manual/en/standards.sample.php

- Abhay
--
Abhay Kumar
http://abhaykumar.net/