Posted by Bogomil Shopov on 06/13/05 18:34
Hi Cris,
I think object is necessary for PHPDoc standart (or similar);) But a
detailed description of what object contains will be very helpfull.
Unfortunatly you should make it in a separate file.
--
Bogomil B. Shopov
http://purplerain.org
Reply --------------->
Chris Drozdowski wrote:
> 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
Navigation:
[Reply to this message]
|