Re[2]: [PHP-DOC] Documenting object methods
| From: | techtonik | Date: | Wed, 10 Nov 2004 21:45:00 +0000 |
| Subject: | Re[2]: [PHP-DOC] Documenting object methods | ||
| References: | 1 2 3 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969364994@lists.php.net to get a copy of this message | ||
||*()*|| Hi, Sean.
SC> Nuno Lopes wrote:
>>> 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?
>> Another good question :) There are several OO function which are
>> currently using mixed case.
>> I can't really thing in a good reason why they should be lowercased or
>> not... I would keep as-is.
SC> This makes filenames mixed-case, too.. All well and good on a filesystem
SC> that supports mixed-case filenames, but on (e.g.) Windows,
SC> pdo-beginTransaction.xml would collide with pdo-begintransaction.xml
SC> (which may or may not be a big deal.. probably not).
Also consider <function>ArrayObject::count</function>. To link it we
need to make an id from "ArrayObject::count" string. Refentry has an
id="function.ArrayObject-count" for this method. Solution seems to be
straightforward - replace :: with -, but if we take DOM extensions -
an id for DOMDocument->createElementNS is
"function.dom-domdocument-createelementns".
An illustrative example of id conflicts is in Function Index if you
can generate new xCHM from the latest CVS templates. Index is taken
from funcindex.xml, where all id's are lowercased. I can't upload
manual until weekend.
Since id's are case-sensitive in XML, we have to stick to one solution
and describe it in HOWTO. I prefer ArrayObject-count id's because they
are easily transformed from such <function> references. With wrong
capitalization in <function> block link will not be created and PHP
code with such capitalization will not work too, so the authors will
have to fix it anyways.
t
--