Re: Re: PHPDoc again
| From: | Greg Beaver | Date: | Mon, 17 Jun 2002 21:10:22 +0000 |
| Subject: | Re: Re: PHPDoc again | ||
| References: | 1 2 3 4 5 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-7152@lists.php.net to get a copy of this message | ||
Hi,
Thought I might be able to answer some of these questions
phpDocumentor is not regexp-based, it uses an event-driven parser which is
much faster and more powerful. Fortunately, the project is separated into
two components: parsing and conversion, so substitution of another parser
would be trivial and remain compatible with the output converters, which
currently support HTML, PDF, and CHM, and will expand to include
(well-defined with a DTD) XML, DocBook and whatever else people are inspired
to write.
I think you'll find phpDocumentor is very useful, as its error-catching
abilities are extensive. Honestly, the PEAR repository is laden with tag
errors, and is not as standardized as having a standard PHPDoc would lead
one to think. Many projects have spelling errors in their tags (@acess, for
example) and others seem to have been written for a different documentor.
Many projects do not use the @package tag, which causes name conflicts when
they are grouped into the default package. Changing documentation comments
to be error-free is not very difficult.
phpDocumentor also supports clearer @package usage (class-level package
syntax, procedural page package syntax) and has more powerful linking
options through the JavaDoc-standardized {@link} inline tag.
In addition, @see parent::method() works, as does @see method() where method
is any method in the class or in any of the parent classes.
There are many things, both small and large, that make phpDocumentor very
useful. The next release makes use of the Smarty template engine to
generate output for the CHM and one of the HTML converters. Modifying
phpDocumentor to use a different template is not difficult (it took about 3
days to create a new converter for Smarty based on the default HTML
converter, 5 days to create a new PDF converter using the free CPdf
library).
Merging in the best of PHPDoc would not be difficult, but there are a few
catches. One - the source code does not conform 100% to the PEAR coding
standards. The differences are trivial, however. The other catch is that
CVS is located at cvs.joshuaeichorn.com. The biggest problem is that the
xml files generated by PHPDoc are not powerful enough to accomodate for all
the features of phpDocumentor. To this end, Josh is working on a DTD which
will abstract all of the essential features of php and its documentation for
the 1.2 release, and plans to include a class browser written in php that
reads the xml files. He can answer any questions about that.
Take care,
Greg
phpDocumentor
http://phpdocu.sourceforge.net
http://www.phpdoc.org
"Jonas Koch Bentzen" <test@understroem.dk> wrote in message
news:3D0E3D4F.4000505@understroem.dk...
> Jonas Koch Bentzen wrote:
> > Björn Schotte wrote:
> >
> >>
> >> * Jonas Koch Bentzen wrote:
> >>
> >>> I really hope so. phpDocumentor (http://phpdocu.sourceforge.net/) is
> >>> very much alive and mature, and it's compatible with PHPDoc, meaning
> >>
> >>
> >> Does ist also use ext/phpdoc or is it regex based?
> >
> >
> > Maybe we should ask the phpDocumentor team about this. I've CC'ed this
> > messaged to Joshua Eichorn @ the phpDocumentor team.
>
> I just got a reply from Joshua Eichorn:
>
> "phpDocumentor doesn't use the c extension but were willing to look into
> if, its actualy under active development, we don't have the resource to
> support a C extension that i've never got to compile.
> -joshua eichorn"
>