Discussion:
PHPDoc parsing too restrictive?
Yannick
2008-07-28 01:52:39 UTC
Permalink
Hi again,

Apparently, the parsing of the PHPDoc comments is so severe that if I
use:

/**
* This library provides functions for user management.
* it in your code to use its functionality.
*
* @service
* @binding.soap
*
*/

it won't work, but if I add one space before the star on the line
before the last, then it works:

/**
* This library provides functions for user management.
* it in your code to use its functionality.
*
* @service
* @binding.soap
*
*/

However, the last line (the closing tag) works, with or without space.
I haven't found any documentation about this, but it sure takes some
time to figure out! (and error reporting is un-existing about that
one)

Isn't this a little too restrictive for a package that is supposed to
provide a simple mechanism of re-use of existing functions?

Yannick
Matthew Peters
2008-07-29 10:07:47 UTC
Permalink
Hi Yannick, that's really bad! You could spend hours hunting that down
and then you would really hate SCA at the end of it. I don't know what
causes that but I totally agree that it should be fixed. One of the
package owners will get to it in due course, or of course anyone is
free to sign the CLA and submit a patch.

Matthew
Post by Yannick
Hi again,
Apparently, the parsing of the PHPDoc comments is so severe that if I
/**
* This library provides functions for user management.
* it in your code to use its functionality.
*
*
*/
it won't work, but if I add one space before the star on the line
/**
* This library provides functions for user management.
* it in your code to use its functionality.
*
*
*/
However, the last line (the closing tag) works, with or without space.
I haven't found any documentation about this, but it sure takes some
time to figure out! (and error reporting is un-existing about that
one)
Isn't this a little too restrictive for a package that is supposed to
provide a simple mechanism of re-use of existing functions?
Yannick
Yannick
2008-07-30 03:10:21 UTC
Permalink
What's the CLA?
Post by Matthew Peters
Hi Yannick, that's really bad! You could spend hours hunting that down
and then you would really hate SCA at the end of it. I don't know what
causes that but I totally agree that it should be fixed. One of the
package owners will get to it in due course, or of course anyone is
free to sign the CLA and submit a patch.
Matthew
Post by Yannick
Hi again,
Apparently, the parsing of the PHPDoc comments is so severe that if I
/**
 * This library provides functions for user management.
 * it in your code to use its functionality.
 *
*
*/
it won't work, but if I add one space before the star on the line
/**
 * This library provides functions for user management.
 * it in your code to use its functionality.
 *
 *
*/
However, the last line (the closing tag) works, with or without space.
I haven't found any documentation about this, but it sure takes some
time to figure out! (and error reporting is un-existing about that
one)
Isn't this a little too restrictive for a package that is supposed to
provide a simple mechanism of re-use of existing functions?
Yannick
Graham Charters
2008-07-30 08:29:34 UTC
Permalink
Hi Yannick,

The CLA is a Contributors License Agreement. The one we have in place
for SCA_SDO is derived from the CLA which covers contributions to the
Apache projects. It's contained in the SCA_SDO distribution and is a
text document called "CLA". We are only able to include contributions
to the project from people who have signed the CLA.

Regards, Graham.
Post by Yannick
What's the CLA?
Post by Matthew Peters
Hi Yannick, that's really bad! You could spend hours hunting that down
and then you would really hate SCA at the end of it. I don't know what
causes that but I totally agree that it should be fixed. One of the
package owners will get to it in due course, or of course anyone is
free to sign the CLA and submit a patch.
Matthew
Post by Yannick
Hi again,
Apparently, the parsing of the PHPDoc comments is so severe that if I
/**
* This library provides functions for user management.
* it in your code to use its functionality.
*
*
*/
it won't work, but if I add one space before the star on the line
/**
* This library provides functions for user management.
* it in your code to use its functionality.
*
*
*/
However, the last line (the closing tag) works, with or without space.
I haven't found any documentation about this, but it sure takes some
time to figure out! (and error reporting is un-existing about that
one)
Isn't this a little too restrictive for a package that is supposed to
provide a simple mechanism of re-use of existing functions?
Yannick
Loading...