Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 0.1.15
Bug #16178 Header Comment Blocks (Docblocks) aren't fixed or made pretty
Submitted: 2009-05-04 19:14 UTC
From: hm2k Assigned: jespino
Status: Closed Package: PHP_Beautifier (version 0.1.14)
PHP Version: 5.2.9 OS:
Roadmaps: (Not assigned)    
Subscription  
Comments Add Comment Add patch


Anyone can comment on a bug. Have a simpler test case? Does it work for you on a different platform? Let us know! Just going to say 'Me too!'? Don't clutter the database with that please !
Your email address:
MUST BE VALID
Solve the problem : 49 - 15 = ?

 
 [2009-05-04 19:14 UTC] hm2k (James Wade)
Description: ------------ Regarding bug #15139 (https://pear.php.net/bugs/bug.php?id=15139) Using PHP_CodeSniffer I generated a report, then passed the files through PHP_Beautifier, and created another report. I found that PHP_Beautifier didn't prettify the "Header Comment Blocks" as per this proposal: http://pear.php.net/pepr/pepr-proposal-show.php?id=128 Many of the issues raised by PHP_CodeSniffer are simply spacing issues. Are the "Header Comment Blocks" going something that is covered by PHP_Beautifier? Thanks.

Comments

 [2009-05-05 17:23 UTC] hm2k (James Wade)
-Summary: Header Comment Blocks aren't fixed or made pretty +Summary: Header Comment Blocks (Docblocks) aren't fixed or made pretty
This exact issue is mentioned in an article entitled: Proposal for "Amendment of Docblock Comment Standards": http://pear.php.net/pepr/pepr-proposal-show.php?id=580 Perhaps it can utilise the following packages: http://pear.php.net/package/PHP_DocBlockGenerator/ http://pear.php.net/package/PHP_Parser_DocblockParser/ I will direct my attention to these until somebody gets back to me here.
 [2009-05-05 17:33 UTC] cweiske (Christian Weiske)
I never used PHP_Beautifier for real code, I doubt that it will do everything.
 [2009-05-05 17:34 UTC] cweiske (Christian Weiske)
The proposal has not finished yet.
 [2009-05-05 18:17 UTC] hm2k (James Wade)
What is the point of PHP_Beautifier if not for real code? Ah, I was under the impression that the "Proposed" status, meant that the proposal was final. I now realise the error of my ways! It should read "Finished" once voting has finished. My mistake. Having said this, it's a proposal worth taking note of. However, I noticed that voting has not started yet either, who has the permissions to start the voting?
 [2009-05-05 18:20 UTC] cweiske (Christian Weiske)
a bug tracker is no discussion forum. please mail to pear-dev@lists.php.net
 [2009-05-05 18:20 UTC] cweiske (Christian Weiske)
-Status: Open +Status: Bogus
bogusing.
 [2009-05-05 18:26 UTC] hm2k (James Wade)
-Status: Bogus +Status: Open
I suspect you are right though Christian, I'm not sure this is covered by PHP_Beautifier. However PHP_Beautifier COULD easily impliment PHP_DocBlockGenerator to do the leg work to get the desired results.
 [2010-05-29 03:48 UTC] jespino (Jesús Espino)
Now solved in the repository. The problem is solved in a new Filter (DocBlock) that use the DocBlockGenerator to beatify the phpdoc code
 [2010-05-29 03:52 UTC] clbustos (Claudio Bustos)
-Assigned To: +Assigned To: jespino
 [2010-05-30 05:57 UTC] jespino (Jesús Espino)
-Status: Assigned +Status: Closed
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.