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

Request #20270 Missing docs for Squiz.WhiteSpace.SuperfluousWhitespace
Submitted: 2014-05-09 17:15 UTC
From: senyahnoj Assigned:
Status: Open Package: PHP_CodeSniffer (version 1.5.3)
PHP Version: 5.5.12 OS: Linux
Roadmaps: (Not assigned)    
Subscription  


 [2014-05-09 17:15 UTC] senyahnoj (Jon Haynes)
Description: ------------ I have incorporated your very helpful Superfluous whitespace sniff into our custom coding standard. When using the doc generator this function didn't appear as there is no SuperfluousWhitespaceStandard.xml file in CodeSniffer/Standards/Squiz/Docs/WhiteSpace/ I wrote a quick XML file based on what was written in the sniff class which I've attached but I expect you'll want to write your own ;) Test script: --------------- My custom ruleset.xml has the following node: <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace"/> Then I run: phpcs --generator=HTML --standard=MyCodingStandard Expected result: ---------------- I expected to see the Superfluous whitespace function documented. Actual result: -------------- Superfluous whitespace function did not appear in the outputted documentation.

Comments

 [2014-05-09 17:15 UTC] senyahnoj (Jon Haynes)