Login | Register
My pages Projects Community openCollabNet

Discussions > dev > Re: [propel-dev] phpdoc tips?

propel
Discussion topic

Back to topic list

Re: [propel-dev] phpdoc tips?

Reply

Author hlellelid
Full name Hans Lellelid
Date 2004-06-01 12:03:43 PDT
Message Hi micha,

> I do not have any tips on phpdoc or another php tool for api documentation
> as
> I wasn't able to configure anyone of them to output clean and functional
> documentation (from my point of view ;)

Yes, I agree. I was able to get PhpDocumentor to output PHPEdit-styled
docs using the following command:

phpdoc -d classes -t docs\api -dn "Propel" -ti "Propel API Docs" -o
HTML:frames:phpedit

but I'm still very unhappy with these docs; they're still basically useless.

>
> IMHO the best documentation style I've ever seen is from QT's Toolkit
> (http://doc.trolltech​.com/3.3/index.html)​.
>
> Doxygen is the only tool I found whose output is close to QT's
> ( unfortunatly doxygen's php5 support is quite limited - more precisely
> unusable at the moment).
>
> I patched the source a little so that it's *more* close ;)
> A preview of creole's php4 api is at
> http://www.aichler.n​et/creole/docs/api/h​tml/index.html .
> I'd like to use it for the php4 version. There have to be changed a few
> tags,
> though.

This looks much better -- I like that all the classes can be browsed in
addition to the modules. Very clean. I might make some trivial changes
to the method detail list to make it clearer where one method starts &
ends, but that's just stylistic & I imagine that can be changed.

I like the way that it cross-references text from within the docblocks
(like constants, methods) -- did you have to add code to make that happen
or is that automatic?

I've heard good things about doxygen, just never used it.

What kind of changes would we need to make to the sourcecode / phpdoc to
use doxygen? Is it reasonable to think that I could sit down w/ doxygen
for a couple evenings & get PHP5 support working? (i.e. do you know how
difficult it would be to modify the PHP4 parser?)

> How do you think about it ?

Cool, am interested :)

Hans


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

« Previous message in topic | 3 of 14 | Next message in topic »

Messages

Show all messages in topic

[propel-dev] phpdoc tips? hlellelid Hans Lellelid 2004-05-31 21:38:52 PDT
     Re: [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-01 11:30:27 PDT
         Re: [propel-dev] phpdoc tips? hlellelid Hans Lellelid 2004-06-01 12:03:43 PDT
             Re: [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-01 12:58:26 PDT
                 Re: [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-02 05:30:57 PDT
                     Re: [propel-dev] phpdoc tips? hlellelid Hans Lellelid 2004-06-02 05:45:41 PDT
                         Re: [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-02 05:59:16 PDT
                             [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-03 07:23:02 PDT
                                 Re: [propel-dev] phpdoc tips? hlellelid Hans Lellelid 2004-06-03 09:46:06 PDT
                                     Re: [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-03 10:52:30 PDT
                                         Re: [propel-dev] phpdoc tips? hlellelid Hans Lellelid 2004-06-03 12:53:56 PDT
                                             Re: [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-03 13:14:22 PDT
                                                 [propel-dev] phpdoc tips? Michael Aichler <aichler at mediacluster dot de> Michael Aichler <aichler at mediacluster dot de> 2004-06-03 17:44:00 PDT
                                                     Re: [propel-dev] phpdoc tips? hlellelid Hans Lellelid 2004-06-03 17:56:09 PDT
Messages per page: