[prev in list] [next in list] [prev in thread] [next in thread] 

List:       phpdoc
Subject:    [PHP-DOC] Documentation is missing links in class synopsis
From:       Joris van de Sande <joris.devplace () gmail ! com>
Date:       2010-08-19 20:44:46
Message-ID: AANLkTi=3phbNySCawm_+rBfhUNMdudP5opnHBpNcWuE9 () mail ! gmail ! com
[Download RAW message or body]

The documentation for the SimpleXMLElement class only has a link to
the count method in the class synopsis. I have discoverd that this is
caused by the methodname value in the xml files for the class methods.
Other classes (such as ArrayObject) use the format
"<classname>::<methodName>" as the methodname value. The methodname
format that is used for the SimpleXMLElement methods is
"<methodName>".

What's the right format to use for the methodname?

I like the  "<methodName>" format, because it looks better in the
generated documentation (ooclass element should be used in this case).
However the problem with this format is that the method name's are not
linked to the method documentation in the class synopsis ( see
http://php.net/manual/en/class.simplexmlelement.php ).

-- 
Joris van de Sande
[prev in list] [next in list] [prev in thread] [next in thread]