OO documentation
| From: | Nuno Lopes | Date: | Thu, 29 Apr 2004 15:43:51 +0000 |
| Subject: | OO documentation | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969360338@lists.php.net to get a copy of this message | ||
Hello,
I have some questions about how I should document OO functions.
May I follow George's style and include both OO and non-OO function in the
same file?
For example: tidy_parse_string and $tidy->ParseString()
How do I document variables of an object? In the __contructor page? or in
the reference.xml? ...?
For example: $tidy->ErrorBuffer
I've noted that tidy has the functions documented as $tidy_node->xxx, and
SPL and SOAP have SOAPClient::xxx
Which is the correct one? I think :: means static method? Maybe I'm wrong...
Thanks,
Nuno