Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:49734
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 209.85.160.170 as permitted sender)
DomainKey-Status: bad
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=mime-version:from:date:message-id:subject:to:content-type;
        b=wFhA/chx4eWhCPM2jy0W29K/B/XA6jK30OWU6OP2LcFKytADOjJDuK9cmLtOHPYWQ7
         iyjq1Hzo3CgttWplSDi3++auuPNFyEuZF3dbmHsUWDp0jY4OmWQnjVgoBWOCwC3fNprr
         hV32VhfsbbZs2KGGqAdQLVEBLzNJROrRbuRxw=
MIME-Version: 1.0
Date: Thu, 16 Sep 2010 13:56:04 -0700
Message-ID: <AANLkTinGFY8OobnjxEm6EDZyrqrTtvMJdceFMgAcGb7t@mail.gmail.com>
To: internals@lists.php.net
Content-Type: text/plain; charset=ISO-8859-1
Subject: docBlock Parser RFC
From: chadfulton@gmail.com (Chad Fulton)

Hello,

Based on comments from the annotations thread, I have created a
docBlock parser RFC at http://wiki.php.net/rfc/docblockparser

This RFC does not deal with annotations per se, but only with the idea
of adding a function to the Reflection extension which would parse
docBlocks according to a set docBlock syntax into a simple associative
array containing three elements: short description, long description,
and an array of tags.

This is only meant to aid meta-data retrieval for classes and does not
automatically instantiate anything objects.

The RFC was meant to conform to existing convention on the formatting
of docBlocks - so one major way to improve it would be to note any
inconsistencies with accepted practice.

Feel free to improve in any other way as well, of course.

Thanks,
Chad