Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:87135
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 209.85.212.178 as permitted sender)
MIME-Version: 1.0
In-Reply-To: <55A39493.6020909@lsces.co.uk>
References: <CAObuZdsA6T7uTCPignr_9g1bAbd83hsTrv9mAg7jU=oY96C9+Q@mail.gmail.com>
 <CALW=WECOo-JDWgHbmy=eUAVWCxt-0m_9sP-JeXe1hc0SokH37w@mail.gmail.com>
 <55A16375.4000707@php.net> <CAOsHV+sV2p7aBWOro=D5+xV+LZvNrt4Au3R3SqcJDy9qdPj8ig@mail.gmail.com>
 <55A220D8.3090004@gmail.com> <CAOsHV+tEjzAnG4ygRj1=0JgO4ps4AbWFQVHFex0+GuY44rdZbA@mail.gmail.com>
 <55A363A0.5060307@gmail.com> <CAEZPtU6+PNos4Cg8EwZjgL=ZJ0y-h_UWxAkKGsmWMJJS_QjYWA@mail.gmail.com>
 <55A39493.6020909@lsces.co.uk>
Date: Mon, 13 Jul 2015 11:51:55 +0100
Message-ID: <CADyq6s+T-79iKjNOCeWgpPe=cocEkoEYAqpK5vEWo9WPErVW1Q@mail.gmail.com>
To: Lester Caine <lester@lsces.co.uk>
Cc: PHP Internals List <internals@lists.php.net>
Content-Type: multipart/alternative; boundary=089e0102f146bae387051abf83b4
Subject: Re: [PHP-DEV] PHP7 and types - and alternatives to annotation
From: ocramius@gmail.com (Marco Pivetta)

--089e0102f146bae387051abf83b4
Content-Type: text/plain; charset=UTF-8

Hi Lester,

On 13 July 2015 at 11:36, Lester Caine <lester@lsces.co.uk> wrote:

> On 13/07/15 08:49, Pierre Joye wrote:
> >> No, not "just" my IDE can work. IDE is just the side effect. Proper
> >> > documentation does much more than that.
> > It seems to go off topic. Docblocks are only slightly related to this
> > thread. The same could be said about annotation (which are widely used
> too).
>
> Coming from a background of 'traditional' php design, all of my code and
> the libraries I use are documented via phpdoc style annotation which the
> IDE picks up, and phpdocumentor1 produced a good API description. This
> was also a GOOD basis to tidy up the various changes through PHP5.x
>
> Today much of the infrastructure to make that work is broken and
> http://lsces.org.uk/wiki/bitweaver+documentation is a starting point at
> getting the material all up to date. The original documentation had a
> few errors on the log file, but http://lsces.org.uk/bwdocs2/index.html
> is the version I've been working on and is listing 3300 errors in the
> documentation! The next step is to work out how to address those errors,
> but once again that is unproductive work so perhaps fixing the problems
> with the older V1 documenter may be a better use of time? The rules
> phpdocumenter2 follow seem far adrift from the original 'standard'. So
> it WOULD be nice if there was an approved standard rather than these
> seeming to be subject to different interpretation all the time.
>
> This before addressing the problems of PHP7 migration ...
>
>
Please refer to https://github.com/php-fig/fig-standards/pull/169

Greets,

Marco Pivetta

http://twitter.com/Ocramius

http://ocramius.github.com/

--089e0102f146bae387051abf83b4--