Re: Documenting Code Question

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxxxx

-- 
PHP General Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[Index of Archives]     [PHP Home]     [Apache Users]     [PHP on Windows]     [Kernel Newbies]     [PHP Install]     [PHP Classes]     [Pear]     [Postgresql]     [Postgresql PHP]     [PHP on Windows]     [PHP Database Programming]     [PHP SOAP]

  Powered by Linux