Re: Documentation Generation
| From: | Ulf Wendel | Date: | Tue, 03 Oct 2000 09:14:46 +0000 |
| Subject: | Re: Documentation Generation | ||
| References: | 1 2 3 4 5 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-317@lists.php.net to get a copy of this message | ||
Chuck Hagenbuch wrote:
>
> Quoting Ulf Wendel <ulf.wendel@redsys.de>:
>
> > You mean @param $foo1, $foo2, $foo3 ? No, this is not supported. The
> > syntax is:
> >
> > @param (object objectname|type) [$varname] [description]
>
> Actually, no, I meant @param string $foo [multi-line description]
> [... more decription ]
This is allowed. The parsing rule is "take everything from @tag to the
next @tag". That means you can have multiple line descriptions but you
can't have descriptions that contain other tags. If you need any other
rule you would have to replace a functions with less than 30 lines of
code.
> > And no, it was not a design goal to have user defined tag sets. A patch
> > would take me about 4 hours - but I do not like the syntax and we should
> > discuss which one is better.
>
> Hmm? You kind of lost me here - how did we get to user defined tag sets?
Javadoc offers user defined tag sets in the doc comments. Thougt you
where looking for something like that, but you're not.
> > I can place it on Sourceforge or in the PEAR Repository, or even
> > introduce a new website and have a (public) CVS at NetUSE. It's up to
> > the PEAR community.
>
> Hmm. Sourceforge is a nice infrastructure; I'd vote either for that or the
> PEAR repository, depending on whether or not the community wants to adopt
> PHPDoc as the official documentation generator, and whether or not you
> _want_ it to take on that status.
Yes, I can put it under the PHP licence and I would like to see it in
the PEAR repository. A documentation generator and some other important
tools/applications could be checked in to the PEAR repository in my
eyes.
Ulf