Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:34
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Date: Thu, 13 Mar 2003 16:05:28 -0500
To: marcus.boerger@post.rwth-aachen.de
Cc: PHP Internals <internals@lists.php.net>
Message-ID: <20030313210528.GA21790@hyperion.gravitonic.com>
Mail-Followup-To: Andrei Zmievski <andrei@gravitonic.com>,
	marcus.boerger@post.rwth-aachen.de,
	PHP Internals <internals@lists.php.net>
References: <20030313205122.GA21734@hyperion.gravitonic.com> <5.1.0.14.2.20030313215807.024804b0@pop.t-online.de>
Mime-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
In-Reply-To: <5.1.0.14.2.20030313215807.024804b0@pop.t-online.de>
User-Agent: Mutt/1.4i
Subject: Re: [PHP-DEV] Doc comment patch
From: andrei@gravitonic.com (Andrei Zmievski)

On Thu, 13 Mar 2003, Marcus B=F6rger wrote:
> Great!
>=20
> Some questions:
>=20
> 1) Will you allow compatibility with doxygen by this:
>=20
> +<ST_IN_SCRIPTING>"/** "{NEWLINE} {
> +       CG(comment_start_line) =3D CG(zend_lineno);
> +       BEGIN(ST_DOC_COMMENT);
> +       yymore();
> +}
> +
>=20
> changed to:
> +<ST_IN_SCRIPTING>("/** "|"/*! "){NEWLINE} {
> +       CG(comment_start_line) =3D CG(zend_lineno);
> +       BEGIN(ST_DOC_COMMENT);
> +       yymore();
> +}
> +

When Stig and I discussed this feature, I was under the impression that
it would be used in PEAR mostly, and that PEAR would adhere to
JavaDoc-style comments. Is there enough demand for doxygen comments?

> 2) Why is it '/' '*' '*' and SPACE?

That's what Stig told me to use. :) Stig?

> 3) How about single line comments started by '//!'?

I think Doc comments should be multi-line.

> 4) What about removing everything upto '*' if it is the first character=
=20
> after a new line starts?

It's a possibility. You basically want to strip the example that I gave
down to this?:

@name foo
@param blah string

-Andrei                                       http://www.gravitonic.com/
* Use the source, Luke. *