Re: Tags you plan to support/how to add more

[Michel <da...@re...>]

Dan Kuykendall wrote:

> 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?
>=20
> 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 fo=
r
> additional tags has been a nightmare.
>=20
> I was just referred to your code by one of our users and I am pleased a=
t
> how clean the code is and how few files are involved (PHPDoc has what
> seems to be at least a 100 files).
>=20
> 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.

Look for '@' in the parselines() function and follow the flow. :)


I think the parser is the part of the code which needs the most work. It =
has a=20
few bugs which are hard if not impossible to fix with the current approac=
h.


> Here is the ones Im looking to add
>=20
> The stuff in the [] 's are just a sample of what the tag would be used
> for
>=20
> @author [Dan Kuykendall <da...@ku...>]
> @copyright [GPL/LGPL/BSD]
> @package  [appname]
> @access	[public or private]
> @syntax [CreateObject('app.class', 'constructor_params'); ]
> @example [$phpgw->acl =3D CreateObject('phpgwapi.acl');]
>=20
>=20
> 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:
>=20
> @generic copyright [GPL/LGPL/BSD]
> @generic package  [appname]
> @generic access	[public or private]
> @generic syntax [CreateObject('app.class', 'constructor_params'); ]
> @generic example [$phpgw->acl =3D CreateObject('phpgwapi.acl');]

Sounds like a great idea for those that don't require any special treatme=
nt,=20
others should be tags of their own IMHO.

This reminds me of HTML meta tags so what does everyone think about @meta=
? (or=20
@info? ...)


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

Great! We're excited to hear that our code is useful and there is interes=
t in=20
further development.


PS: If I'm not mistaken, our company is looking into using phpGroupWare...

--=20
Michel D=E4nzer           |      Relog-Reagency AG      |        http://r=
elog.ch
Weinbergstrasse 108     |         8006 Z=FCrich         |     +41 (0)1 36=
8 55 55