Re: Contributions are ready for review
| From: | Christoph M. Becker | Date: | Tue, 09 Jan 2018 13:21:01 +0000 |
| Subject: | Re: Contributions are ready for review | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969386871@lists.php.net to get a copy of this message | ||
On 09.01.2018 at 13:31, Pasindu De Silva wrote:
> On Mon, Jan 8, 2018 at 9:00 PM, <phpdoc@lists.php.net> wrote:
>
>> Modified: en/language/predefined/iteratoraggregate/getiterator.xml
>> By: Trent Harvey on 2017-08-21 14:20:10
>> ===================================================================
>> --- en/language/predefined/iteratoraggregate/getiterator.xml
>> +++ en/language/predefined/iteratoraggregate/getiterator.xml
>> @@ -10,7 +10,7 @@
>> <refsect1 role="description">
>> &reftitle.description;
>> <methodsynopsis>
>> - <modifier>abstract</modifier> <modifier>public</modifier>
>> <type>Traversable</type><methodname>IteratorAggregate::
>> getIterator</methodname>
>> + <modifier>public</modifier> <type>Traversable</type><
>> methodname>IteratorAggregate::getIterator</methodname>
>> <void />
>> </methodsynopsis>
>> <para>
>>
>>
>> => Put this change into your patches :
>>
>> https://edit.php.net/?project=php&action=putIntoMyPatches&idDB=75083
>> => Delete this change:
>> https://edit.php.net/?project=
>> php&action=deleteThisChange&idDB=75083
>>
>>
> The commit message for the above patch is - Pre-defined interfaces such as
> ArrayAccess and JsonSerializable incorrectly spec'd their method signatures
> as "abstract". They are interfaces and not classes and cannot have
> "abstract" methods. Because they are interfaces it is assumed they are
> "abstract" and have no concrete implementation in their definition and must
> be implemented by the class which uses it.
>
> Is abstracts in interfaces a convention in docs to be more verbose ?
I think so. At least docgen appears to insert
<modifier>abstract</modifier> by default.
--
Christoph M. Becker