Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

#603 SuppressionCommentFilter father

release_1.0
closed
nobody
5
2013-11-12
2010-03-11
Angelo D'Agnano
No

In the solution for bug 1267314 it is mentioned that SuppressionCommentFilter has to be child of Checker and not of FileContentsHolder.

Nevertheless current documentation says:

To configure the check that makes comments available to the filter: 

 <module name="TreeWalker">
    ...
    <module name="FileContentsHolder"/>
    ...
</module>  

To configure a filter to suppress audit events between a comment containing CHECKSTYLE:OFF and a comment containing CHECKSTYLE:ON: 

 <module name="SuppressionCommentFilter"/>

Leading the user to put the option in the wrong place.

Discussion

  • Roman Ivanov
    Roman Ivanov
    2013-11-07

    • Description has changed:

    Diff:

    --- old
    +++ new
    @@ -2,11 +2,11 @@
    
     Nevertheless current documentation says:
    
    -<quote>
    +~~~~~~
    
     To configure the check that makes comments available to the filter: 
    
    -   
    +
      <module name="TreeWalker">
         ...
         <module name="FileContentsHolder"/>
    @@ -14,11 +14,12 @@
     </module>  
    
    +
     To configure a filter to suppress audit events between a comment containing CHECKSTYLE:OFF and a comment containing CHECKSTYLE:ON: 
    
      <module name="SuppressionCommentFilter"/>  
    
    -</quote>
    +~~~~~~
    
     Leading the user to put the option in the wrong place.
    
    • Group: --> release_1.0
     
  • Roman Ivanov
    Roman Ivanov
    2013-11-12

    • status: open --> closed