| Package home | Report new bug | New search | Development Roadmap | Status: Open | Feedback | All | Closed Since Version 1.1.2 |
| Bug #16181 | Ordering issues | ||
|---|---|---|---|
| Submitted: | 2009-05-05 17:31 UTC | ||
| From: | hm2k | Assigned: | hm2k |
| Status: | Closed | Package: | PHP_DocBlockGenerator (version 1.1.1) |
| PHP Version: | 5.2.9 | OS: | |
| Roadmaps: | 1.1.2 | ||
[2009-05-05 17:31 UTC] hm2k
(James Wade)
Description:
------------
After running docblockgen, even though it sorts out the spacing, it doesn't fix the ordering outlined by PHP_CodeSniffer.
eg:
The @license tag is in the wrong order; the tag follows @copyright (if used) or @author
The @copyright tag is in the wrong order; the tag follows @author
The @link tag is in the wrong order; the tag follows @version
...
Comments
[2011-09-05 22:33 UTC] hm2k
(James Wade)
To reproduce these errors, you need to do the following:
Get Compat.php from the PHP_Compat package.
Run:
docblockgen Compat.php Compat.phps
This should create a new file called Compat.phps
Diff Compat.php and Compat.phps and you should be able to see the spacing is
sorted.
Run:
phpcs --standard=PEAR Compat.phps
It should tell you that the "tags" are in the wrong order.
eg:
11 | ERROR | The @license tag is in the wrong order; the tag follows
| | @copyright (if used) or @author
12 | ERROR | The @copyright tag is in the wrong order; the tag follows
| | @author
13 | ERROR | The @version tag is in the wrong order; the tag follows
| | @license
The result would be similar to the Align.php which appears to deal with aligning, but
not ordering.
[2011-09-05 22:34 UTC] hm2k
(James Wade)
To reproduce these errors, you need to do the following:
Get Compat.php from the PHP_Compat package.
Run:
docblockgen Compat.php Compat.phps
This should create a new file called Compat.phps
Diff Compat.php and Compat.phps and you should be able to see the spacing is
sorted.
Run:
phpcs --standard=PEAR Compat.phps
It should tell you that the "tags" are in the wrong order.
eg:
11 | ERROR | The @license tag is in the wrong order; the tag follows
| | @copyright (if used) or @author
12 | ERROR | The @copyright tag is in the wrong order; the tag follows
| | @author
13 | ERROR | The @version tag is in the wrong order; the tag follows
| | @license
The result would be similar to the Align.php which appears to deal with spacing, but
not ordering.
[2011-09-06 16:35 UTC] hm2k
(James Wade)
-Status: Open
+Status: Closed
-Assigned To:
+Assigned To: hm2k
-Roadmap Versions:
+Roadmap Versions: 1.1.2
This bug has been fixed in SVN.
If this was a documentation problem, the fix will appear on pear.php.net by the end of next Sunday (CET).
If this was a problem with the pear.php.net website, the change should be live shortly.
Otherwise, the fix will appear in the package's next release.
Thank you for the report and for helping us make PEAR better.