Re: PHPDoc renderer not working
| From: | Jesus M. Castagnetto | Date: | Mon, 29 Apr 2002 08:55:51 +0000 |
| Subject: | Re: PHPDoc renderer not working | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-5877@lists.php.net to get a copy of this message | ||
Antonio,
--- Antonio Carlos Venancio Junior <floripa@organiKa.com.br> wrote:
> Jesus,
>
>
> Just for curiosity: I tried about 3 times to generate documentation for
> 3 files and never get it to work. =)
I've had no problem just getting the latest from CVS (pear/PHPDoc), making the
pear dir available from my local web server, and then just running it on, for
example, pear/Math_Science.
> We are just trying to continue Ulf's work and release something stable
> (yeah, it's beta yet). We have a lot of improvements to make.
Parsing speed will be a good improvement. Perhaps also modify the system to use
the pear/PECL/phpdoc C extension, which seems to have 2 functions defined:
confirm_phpdoc_compiled and phpdoc_xml_from_string
Also, it will be good if PHPDoc detected previously created XML files, and
asked the user whether to use them and just generate a rendering or to process
the classes again. In this way, an aborted rendering can be restarted.
> And I didn't know about this other project, that seems a brother of
> PHPDoc (maybe a clone).
> Why don't merge both works and make an "Official" PHPDoc engine using
> all our skills and time ?
> What do you all think about that? =)
As a user of PHPDoc/phpdocu(mentor), anything that makes things faster and more
reliable is good in my book. Go for it.
>
> On Sat, 2002-04-27 at 21:48, Jesus M. Castagnetto wrote:
> > You might want to take a look at phpdocu.sourceforge.net
> >
> > In (informal) tests running PHPDoc (using the web interface, which works OK
> > btw), and phpdocu (command line interface). The second one was faster,
> mainly
> > because it did not generate intermediate XML files.
> >
> > When running PHPDoc on pear/Math_Vector (local version, with several
> > modifications, like addition of unit tests and more examples), I had to
> stop
> > the run after 2.5 hours (yes *hours*). In contrast phpdocu took 46 seconds
> to
> > produce the documentation.
> >
> > The second documentation tool, has its quirks, but on the other hand allows
> > documentation to be associated w/ packages, functions, define(), etc. And
> seems
> > to be OK w/ tags like:
> >
> > @see NameOfOtherClass
> >
> > which PHPDoc reports as incorrect, even though it is correct according to
> > JavaDoc specs. I like PHPDoc, it is more complete than phpdocu, but if I
> have
> > to wait for hours vs seconds, then guess what will be the tool that I will
> use
> > on a day to day basis.
> --
>
>
> Cya
>
>
> +++
> Antonio CVS .: organiKa :.
> "We use only recicled bits"
> floripa@organiKa.com.br
> http://www.organiKa.com.br
> Key fingerprint = 9F5B 31B0 C52A 4C4D 3A37 3A9F 7304 2779 5BBE B073
>
> ATTACHMENT part 2 application/pgp-signature name=signature.asc
=====
--- Jesus M. Castagnetto (jcastagnetto@yahoo.com)
Research:
http://metallo.scripps.edu/
Personal: http://www.castagnetto.org/
__________________________________________________
Do You Yahoo!?
Yahoo! Health - your guide to health and wellness
http://health.yahoo.com