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-03 12:53:56 PDT
Message Hi,

> 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).

That would be ideal, if possible.

> 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/com​mands.html#cmdvar )
> Also, does this mean that we cannot use the @ingroup tag to group things
> together ?

No, no. I just mean that we should try to preserve the syntax for those
tags that are recognized (like @param). That's all. If we changed to
using type.$varname then I don't think the other parsers would even be
able to recognize the $varname part -- much less the type. That's why I
was saying that in that case we'd be breaking compatibility; I think being
compatible is worth something. That doesn't preclude using new tags that
the other parsers don't support -- that's fine. We may have to decide
whether we want to *also* use @package tags, but I'm not so worried about
that. (I have to think about what the packages should be for Propel,
which isn't as straightforward as Creole -- and I don't think it
necessarily makes sense to just use java-style directory-based package
naming).

Cool work!

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 | 11 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: