Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:33
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Reply-to:marcus.boerger@post.rwth-aachen.de
Message-ID: <5.1.0.14.2.20030313215807.024804b0@pop.t-online.de>
Date: Thu, 13 Mar 2003 22:01:50 +0100
To: Andrei Zmievski <andrei@gravitonic.com>
Cc: PHP Internals <internals@lists.php.net>
In-Reply-To: <20030313205122.GA21734@hyperion.gravitonic.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"; format=flowed
Subject: Re: [PHP-DEV] Doc comment patch
From: marcus.boerger@t-online.de ((Marcus =?iso-8859-1?Q?B=F6rger?=))
References: <20030313205122.GA21734@hyperion.gravitonic.com>

At 21:51 13.03.2003, Andrei Zmievski wrote:
>Pursuant to the introspection portion of TODO-PHP5, here is a small
>patch that:
>
>- Keeps track of starting/ending line numbers for user functions.
>- Removes extraneous T_ML_COMMENT token.
>- Stores the last seen doc comment (JavaDoc style) in the compiler
>   globals for future access by the introspection features and introduces
>   the new T_DOC_COMMENT token. The doc comment is defined as a multiline
>   comment starting with "/** \n" and ending with "*/". So, in the
>   following example:
>
>/**
>  * @name foo
>  * @param blah string
>  */
>function foo($blah)
>{
>}
>
>The CG(doc_comment) will contain:
>  * @name foo
>  * @param blah string
>
>What is left to do here is adding the T_DOC_COMMENT to parser rules and
>storing it in the appropriate structures (zend_op_array for functions,
>zend_class_entry for classes, etc).
>
>If no one objects, I will commit it shortly.

Great!

Some questions:

1) Will you allow compatibility with doxygen by this:

+<ST_IN_SCRIPTING>"/** "{NEWLINE} {
+       CG(comment_start_line) = CG(zend_lineno);
+       BEGIN(ST_DOC_COMMENT);
+       yymore();
+}
+

changed to:
+<ST_IN_SCRIPTING>("/** "|"/*! "){NEWLINE} {
+       CG(comment_start_line) = CG(zend_lineno);
+       BEGIN(ST_DOC_COMMENT);
+       yymore();
+}
+

2) Why is it '/' '*' '*' and SPACE?

3) How about single line comments started by '//!'?

4) What about removing everything upto '*' if it is the first character 
after a new line starts?

regards
marcus