Login | Register
My pages Projects Community openCollabNet

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

propel
Reply to message

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

Original message

Author Michael Aichler <aichler@mediacluster.de>
Full name Michael Aichler <aichler@mediacluster.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