On Thu, 29 Apr 2004, Gabor Hojtsy wrote: > Hi! > > > 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()
Yes, that's the nicest way. > > > > How do I document variables of an object? In the __contructor page? or in > > the reference.xml? ...? > > For example: $tidy->ErrorBuffer reference.xml (as it has nothing to do with the constructor per-se. > > 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. I think we should always use -> UNLESS the method is a "static" method, in that case use ::. IMO that's the most logic thing to do. Derick
