Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 3.7.2

Bug #20268 Incorrect documentation titles in PEAR documentation
Submitted: 2014-05-08 17:54 UTC
From: senyahnoj Assigned: squiz
Status: Closed Package: PHP_CodeSniffer (version 1.5.3)
PHP Version: 5.5.12 OS: Linux
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 : 18 + 21 = ?

 
 [2014-05-08 17:54 UTC] senyahnoj (Jon Haynes)
Description: ------------ In PHP_CodeSniffer/CodeSniffer/Standards/PEAR/Docs/Commen ting/FunctionCommentStandard.xml PHP_CodeSniffer/CodeSniffer/Standards/PEAR/Docs/Commen ting/FileCommentStandard.xml the <documentation> title attribute is "Class Comments". It should be "Function Comments" or "File Comments" respectively. This problem is visible when using the generator to output the coding standard to HTML as the headings are wrong. Test script: --------------- phpcs --standard=PEAR --generator=HTML > docs.html Expected result: ---------------- Not to get dupicate "Class Comments" headings in my HTML output. Actual result: -------------- I get dupicate "Class Comments" headings in my HTML output.

Comments

 [2014-05-09 05:32 UTC] squiz (Greg Sherwood)
-Status: Open +Status: Closed -Assigned To: +Assigned To: squiz
Thanks for finding this. I've committed the fix here: https://github.com/squizlabs/PHP_CodeSniffer/commit/31b8e1e1e0e7fe92f5a901c6f0f ae17b03f8eb72