Re: DS docs: xpointer failing on en and translations

From: Date: Mon, 01 Aug 2016 15:53:32 +0000
Subject: Re: DS docs: xpointer failing on en and translations
References: 1 2 3 4 5 6  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969386229@lists.php.net to get a copy of this message
Sure thing, I'll take a look at this today. Could we perhaps discuss this on the issue? https://github.com/php-ds/docs/issues/4 I'll paste this discussion there for the record. Also, while Vector::copy() returns a Vector, the Collection interface requires that Collection be the return type. I couldn't get it to work that it's enforced by the base interface while also using self as the return type. On 2 August 2016 at 03:38, Christoph Becker <cmbecker69@gmx.de> wrote: > On 01.08.2016 at 02:24, André L F S Bacci wrote: > > > On Sun, Jul 31, 2016 at 6:38 PM, André L F S Bacci <ae@php.net> wrote: > > > >> Just commited a test. > >> > >> I was in doubt if to repeat all methodsynopsis in the child files or to > >> link directly to interface members. I tried the second method with this > fix. > >> > > > > It's online now: > > http://docs.php.net/manual/en/class.ds-vector.php . And > > it's not so good. > > > > The copied methods show as "abstract public". Links goes to interface (as > > expected) but returns are probably wrong. A copy() Ds\Vector returns a > > Ds\Vector instead of Ds\Collection, right? > > > > The solution is "flat" all members of all interfaces and repeat the > methods > > in reference/ds/ds/vector, with correct parameters and returns. Manually > or > > by script, to sync (or check) if all members are present. There is no > > copy() on ToC of Ds\Vector, by the way. > > > > Actual files on reference/ds/ds/vector have no refentry/refsect1 > > role="description"/methodsynopsis, and so the class synopsis will be > empty. > > After the files are synced and filled with methodsynopsis, patch below > will > > use local definitions instead of interface definitions. If the blank > class > > synopsis is preferable, I'll revert my alterations. > > Rudi, can you please have a look at this issue? > > > Index: reference/ds/ds.vector.xml > > =================================================================== > > --- reference/ds/ds.vector.xml (revisão 339754) > > +++ reference/ds/ds.vector.xml (cópia de trabalho) > > @@ -80,18 +80,8 @@ > > </fieldsynopsis> > > > > <classsynopsisinfo > > role="comment">&Methods;</classsynopsisinfo> > > - <!-- constructor --> > > <xi:include > > xpointer="xmlns(db=http://docbook.org/ns/docbook) > > > > xpointer(id('class.ds-vector')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis)" > > /> > > - <!-- Ds\Collection implements JsonSerializable --> > > - <xi:include > > xpointer="xmlns(db=http://docbook.org/ns/docbook) > > > > xpointer(id('class.jsonserializable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis)" > > /> > > - <!-- Ds\Collection implements Countable --> > > - <xi:include > > xpointer="xmlns(db=http://docbook.org/ns/docbook) > > > > xpointer(id('class.countable')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis)" > > /> > > - <!-- Ds\Collection implements Traversable a.k.a. Iterator --> > > - <xi:include > > xpointer="xmlns(db=http://docbook.org/ns/docbook) > > > > xpointer(id('class.iterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" > > /> > > - <!-- Ds\Sequence implements Ds\Collection --> > > - <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbookã > > k´ðºl:¨E—Q óË) > > > > xpointer(id('class.ds-collection')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis)" > > /> > > - <!-- Ds\Vector implements Ds\Sequence --> > > - <xi:include > > xpointer="xmlns(db=http://docbook.org/ns/docbook) > > > > xpointer(id('class.ds-sequence')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis)" > > /> > > + <xi:include > > xpointer="xmlns(db=http://docbook.org/ns/docbook) > > > > xpointer(id('class.ds-vector')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis)" > > /> > > </classsynopsis> > > <!-- }}} --> > > -- > Christoph M. Becker >

« previous php.doc (#969386229) next »