Login | Register
My pages Projects Community openCollabNet

Discussions > dev > [propel-dev] phpdoc tips? > Reply to message

Reply to message

* = Required fields
* Subject
* Body
Send reply to
Author (directly in email)
Please type the letters in the image above.

Original message

Author hlellelid
Full name Hans Lellelid
Date 2004-05-31 21:38:52 PDT
Message I'm trying to generate some API docs for Propel. I'm using PHPDoc
1.3.0RC3, I believe -- whatever the latest version is (the one that
finally works w/ PHP5). I'm able to generate the docs, but they just
look crappy. I'm used to docs built by PHPEdit's plugin (just much
cleaner, but also more functional), and I know that I've seen some
people use a PHPEdit template for PHPDoc too.

Does anyone have INI files (or configuration tips) for PhpDocumentor
that make decent & usable API docs?

I've got Propel broken into Java-style packages right now, but it would
be nice to be able to see all classes, or browse by files too. I don't
know if these features are just missing or what. Every time I go to the
PhpDocumentor site to get help, I get completely frustrated with their
"manual". The online docs at that site are just completely unusable --
mostly due to the fact that they're written using phpdoc, which I
strongly believe is a case of "just because you want to prove you can
doesn't mean you should." This idea that PEAR loves of writing
tutorials from within the API docs is just ludicrous ... ok, </rant>. :)

Once I get this working, it'll be great, I'm sure. Now that
PhpDocumentor supports PHP5 I'd like to create a <phpdoc/> Phing task &
a target in build-propel.xml so that API docs can be built as part of
the om generation.

Anyway, thanks in advance for any tips, etc.


To unsubscribe, e-mail: dev-unsubscribe@prop​el.tigris.org
For additional commands, e-mail: dev-help at propel dot tigris dot org