Login | Register
My pages Projects Community openCollabNet

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

propel
Discussion topic

Back to topic list

[propel-dev] phpdoc tips?

Reply

Author Michael Aichler <aichler at mediacluster dot de>
Full name Michael Aichler <aichler at mediacluster dot de>
Date 2004-06-03 07:23:02 PDT
Message Hi,

> > The docs you created look great, though. Perhaps a little less info than
> > some of the phpdoc stuff (var type for params seemed missing),

I managed to get the parameter types into the doxygen documentation.
It's quite a bad hack - however it works, so - who cares ? ;)

Doxygen's param tag : @param <name> <description>

For php it is now: @param <type>.<name> <description>, e.g.

@param string.$phptype The phptype (mysql, mssql, etc.)

The return type is fetched from the @return tag.

Not too expensive, isn't it ?

I updated the online documentation, however only the creole class is
completely updated to the new tags:

http://www.aichler.n​et/creole/5/docs/htm​l/classCreole.html

The attached patch contains both qt-style and php support.
You need to patch a vanilla doxygen source tree as this patch conflicts with
the two from yesterday, sorry.

Cheers
micha

--
MediaCluster GmbH
Webentwicklung
  
Michael Aichler
Alt-Wuerttemberg-Allee 42
71638 Ludwigsburg
  
Tel.: +49 71 41 - 90 64 42
Fax.: +49 71 41 - 90 64 43
Email: aichler (at) mediacluster (dot) de
PGP: https://www.mediaclu​ster.de/pgp/aichler.​asc
Attachments

« Previous message in topic | 8 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: