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...
The PEAR docs might be interesting in this aspect. As far as I have seen, they use the :: notation for all kinds of methods, and add a note to method documentations if a method should not be called statically. Generally it is best to have some conformance, so our users will have easier time understanding what means what. If all the manual and sections use different methods, then it will be a big problem. Since there are already some methodologies, it is probably better to stick to them. IMHO the method used by Georg to document methods and functions in the same file is quite correct, since it shows the relation properly, and there is no need to add lots of dummy files, which would lead to a less useable manual. Speaking from the variables, I would suggest you look into how PEAR guys do (or how existing OO extensions do it in the docs).
Goba
