|
From: Dan K. <da...@ku...> - 2001-05-10 18:02:26
|
So far you guys support @see @param and @return which is a great start.
Whats your stratagy for adding more, or are you not planning to at all?
I am the project leader of the phpGroupWare project and I have been
spending the last week with PHPDoc which is a serious *mess* to end all
messes. The code is all but impossible to follow, and adding support for
additional tags has been a nightmare.
I was just referred to your code by one of our users and I am pleased at
how clean the code is and how few files are involved (PHPDoc has what
seems to be at least a 100 files).
Anyways, I would like a few more tags and am starting to run thru the
code and will try and add support for them myself. Here is the ones Im
looking to add
The stuff in the [] 's are just a sample of what the tag would be used
for
@author [Dan Kuykendall <da...@ku...>]
@copyright [GPL/LGPL/BSD]
@package [appname]
@access [public or private]
@syntax [CreateObject('app.class', 'constructor_params'); ]
@example [$phpgw->acl = CreateObject('phpgwapi.acl');]
It might also be useful to have a way to 'make up' tags. This may be a
way to support whatever tags developers want to use, but without having
to build too much extra code into your prog.
Something along the lines of:
@generic copyright [GPL/LGPL/BSD]
@generic package [appname]
@generic access [public or private]
@generic syntax [CreateObject('app.class', 'constructor_params'); ]
@generic example [$phpgw->acl = CreateObject('phpgwapi.acl');]
Make sense?
I am going to try and implement one or the other today as I hammer on
your code for use in our project. If I get anything working I will send
it back to you.
Seek3r
|