Re: Method links in class synopsys
| From: | Richard Quadling | Date: | Fri, 04 Dec 2009 15:37:47 +0000 |
| Subject: | Re: Method links in class synopsys | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969381177@lists.php.net to get a copy of this message | ||
2009/12/4 Gustavo Lopes <glopes@nebm.ist.utl.pt>
>
> I'm having some difficulties with the link generation on a class synopsys.
>
> See http://www.php.net/manual/en/class.rarentry.php
>
> This line
>
> <xi:include
> xpointer="xmlns(db=http://docbook.org/ns/docbook)
> xpointer(id('class.rarentry')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"
> />
>
> includes all the methods with the correct signatures, but only those methods I've added
> recently:
> public resource getStream ([ string $password ] )
> public bool isEncrypted ( void )
> public string __toString ( void )
>
> have the correct links.
>
> public bool extract ( string $dir [, string $filepath [, string $password ]] )
>
> has an incorrect link to the extract()
>
> I've recently changed the ids of the old method's doc pages from
> function.rarentry-xxx to rarentry.xxx
>
> Can someone tell what's wrong?
>
> Thanks
>
>
> --
> Gustavo Lopes
I've rebuilt the manual locally yesterday and the links look are OK
for the TOC on RarEntry, but in the class synopsis, they are odd ...
public bool extract ( string $dir [, string $filepath [, string
$password ]] ) => extract
public resource getStream ([ string $password ] ) => RarEntry::getStream
public bool isEncrypted ( void ) => RarEntry::isEncrypted
public string __toString ( void ) => RarEntry::__toString
It looks like the include is doing its job, but the methodname tag
that is then included doesn't include the reference to the class, so
is treated like <function>extract</function>.
The methodname tag for extract is ...
<methodname>extract</methodname>
rather than
<methodname>RarEntry::extract</methodname>
--
-----
Richard Quadling
"Standing on the shoulders of some very clever giants!"
EE : http://www.experts-exchange.com/M_248814.html
Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731
ZOPA : http://uk.zopa.com/member/RQuadling