Re: DocGen, PHPDOC, PhD and namespaced extensions.
| From: | Hannes Magnusson | Date: | Tue, 14 Jun 2011 12:37:10 +0000 |
| Subject: | Re: DocGen, PHPDOC, PhD and namespaced extensions. | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969382802@lists.php.net to get a copy of this message | ||
On Tue, Jun 14, 2011 at 12:31, Kalle Sommer Nielsen <kalle@php.net> wrote:
> Hi Richard
>
> 2011/6/14 Richard Quadling <rquadling@gmail.com>:
>> Do we want the namespace to be a sub directory or do we want name the
>> '\' in the namespace translated to '_' or '-' or something
>> like that?
>
> I thought of the same thing a while back, and to keep the "style" that
> we currently got, then how about doing it like:
> "namespace.[class|interface]" as the directory name and
> class/interface synopsis files, so if we have a simple structure like
> this in a project:
>
> namespace Project;
> class database { }
> class userapi { }
> interface extension { }
>
> We will have a phpdoc structure like the following (without including
> the default files):
>
> ~/phpdoc/en/reference/project/
>
> project.database.xml - (Project\database class synopsis)
> project.userapi.xml - (Project\userapi class synopsis)
> project.extension.xml - (Project\extension interface synopsis)
>
> etc.
>
> And for methods and implementations, we would have the following in
> the same directory:
>
> project.database/construct.xml
> project.database/destruct.xml
> project.userapi/login.xml
> project.extension/getmetainfo.xml
>
> etc.
>
> I don't think this structure will collide with anything we currently
> got, thoughts?
Essentially replacing the namespace separator with a dot?
I agree with that.
The namespace itself doesn't need any docs, so no need for
project/book.xml project/datebase.xml project/database/construct.xml
-Hannes