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

Request #12700 avoid raising error when @ignore tag is set for a class/function
Submitted: 2007-12-15 15:30 UTC
From: farell Assigned: squiz
Status: Closed Package: PHP_CodeSniffer (version 1.0.0RC3)
PHP Version: 5.2.5 OS: windows xp
Roadmaps: (Not assigned)    
Subscription  


 [2007-12-15 15:30 UTC] farell (Laurent Laville)
Description: ------------ When I have a class or function that I don't want to be include into API documentation (use phpdoc tag @ignore), I would like no check / error messages raised on component. Is it possible Greg ? Laurent Test script: --------------- 19: /** 20: * @ignore 21: */ 22: class PEAR_Info3 extends PEAR_Info 23: { 24: function PEAR_Info3($pear_dir = '') 25: { 26: $this->__construct($pear_dir); 27: } 28: 29: function toHtml() 30 { Expected result: ---------------- no error message Actual result: -------------- 20 | ERROR | There must be exactly one blank line before the tags in class | | comment 21 | ERROR | Missing @category tag in class comment 21 | ERROR | Missing @package tag in class comment 21 | ERROR | Missing @author tag in class comment 21 | ERROR | Missing @license tag in class comment 21 | ERROR | Missing @link tag in class comment 24 | ERROR | Missing function doc comment 29 | ERROR | Missing function doc comment

Comments

 [2007-12-16 07:48 UTC] squiz (Greg Sherwood)
It is, of course, possible to change the test, but I would not make a change like this unless the PEAR standards are officially changed. The way I see it, class (etc) comments are not just for PHPDocumentor, but also for the developers reading the code. Just because something is ignored doesn't mean you should leave out the comments. I'm going to close this report because I can't change the PEAR standard without the documented standard changing first. I know PEAR are considering changes to their standards, so you could propose this change to be voted on.