Documenting Code Question
| From: | Chris Drozdowski | Date: | Sun, 12 Jun 2005 12:32:54 +0000 |
| Subject: | Documenting Code Question | ||
| Groups: | php.general | ||
| Request: | Send a blank email to php-general+get-216862@lists.php.net to get a copy of this message | ||
I need some help regarding documenting code. Say you have a function/method that takes an object as a parameter and/or returns an object.
When documenting, do you specify the specific class of the object when listing the datatype in the docblock @param and @return specs or do you simply specify "object"?
Thanks,
Chris Drozdowski
c.d@earthlink.net