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 Michael Aichler <aichler at mediacluster dot de>
Full name Michael Aichler <aichler at mediacluster dot de>
Date 2004-06-03 10:52:30 PDT
Message On Thursday 03 June 2004 18:46, Hans Lellelid wrote: > First: that's cool; aweome work :) Heh, I wanted to have this feature for php but didn't have the motivation to look into doxygens source code ;) > Next, not to discredit your work, but > it seems to me that it might make more sense to leave the types out or > make an effort to specify them in the description. w/o this patch it > still will get the correct varname even when type specified, right? Yes, the varname is taken from the function definition. As for the types; I do not want to miss this feature now that it is available ;) Here are some suggestion how to remain compatible: 1) I'll change the patch tonight to get it recognize a space instead of a dot (or both). 2) We provide a simple php script that converts the @param tag back, e.g: ----- $file = file_get_contents("./Creole.php"); $file = preg_replace('/\@param\s+(\w+)\.(\$[a-zA-Z_][a-zA-Z0-9_]*)/', '@param \1 \2', $file); echo $file; ----- 3) Doxygen nows about a tag called @fn (aliases are @var and @typedef) that initiates a function declaration, e.g.: @fn Connection getConnection(string $phptype, string $dotpath) It would be possible to search this tag in a comment block and extract the return value and param type information. Anyway, if we want to have compatibility with other documentation tools then we'll miss a bunch of useful tags provided by doxygen (see http://www.stack.nl/~dimitri/doxygen/commands.html#cmdvar ) Also, does this mean that we cannot use the @ingroup tag to group things together ? 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.mediacluster.de/pgp/aichler.asc --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscribe@propel.tigris.org For additional commands, e-mail: dev-help@propel.tigris.org

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