Documenting object methods

From: Date: Wed, 10 Nov 2004 10:20:10 +0000
Subject: Documenting object methods
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969364976@lists.php.net to get a copy of this message
Hello, phpdoc@lists.php.net While working with index I noticed that we have two different rules for describing objects and their methods - one with the "->" construction and one with "::". For example look at ArrayObject and DOMDocument. For me ArrayObject with :: is more appropriate. What do you think? Another issue, that ArrayObject has mixed-case id's. While it is clear that all id's for functions are lowercase should be lowercase as it stated in HOWTO that is not true for class methods and it should be mentioned too. Wo, the whole fun is that there are pairs of similar methods in DOM and DOM XML which are differ only by case. For example int DOMDocument->xinclude ( ) with id function.dom-domdocument-xinclude.html int DomDocument->xinclude ( ) with id function.domdocument-xinclude.html (probably a well-known issue, but anyways) Which id should be generated from a <function>domdocument->xinclude</function> block? I think possible solution can be to detect all methods and process them separately from regular functions regarding case, since they must referenced so in sources and therefore in PHP Manual. But for DOM and DOM XML there is trouble with case-insensitive windoze filesystem, because we still can't have two similar html chunks. Since ArrayObject id's are case-sensitive you will have to reference them in a proper case from <function> block to correctly transform <function> text to id. So perhaps all id's for methods should be in mixed case and DOM reference need to be updated? As for similar functions - I think there should be warning for users about differences for each function with a reference to another one. Also there is no way to reference just a class. t -- --[ http://wiki.phpdoc.info/DocLinks ]--

« previous php.doc (#969364976) next »