Win a copy of Think Java: How to Think Like a Computer Scientist this week in the Java in General forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Checkstyle Configuration Issue (Javadoc comments)

 
H Grey
Greenhorn
Posts: 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I'm new to this forum, so if I commit a posting faux pas then please let me know and I will correct it. (Edit: I just realized that I posted this in the Testing forum rather than the intended Ant, Maven and Other Build Tools forum; my apologies.)

I recently set up a Checkstyle 'checks' xml configuration file, which I wanted to check class-level Javadoc comments for @author and @version tags. Furthermore, I only wanted Checkstyle to check Javadoc comments for non-private classes.

If I add the following xml, then it successfully finds Javadocs without @author and @version, but it checks private classes as well.



I then modified the file to contain the following:



Now Checkstyle checks all non-private classes, BUT it no longer checks for the @author and @version tags. Am I missing something here?

Thank you in advance for your help.
 
Jeanne Boyarsky
author & internet detective
Marshal
Posts: 34371
345
Eclipse IDE Java VI Editor
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
H Grey wrote:I'm new to this forum, so if I commit a posting faux pas then please let me know and I will correct it. (Edit: I just realized that I posted this in the Testing forum rather than the intended Ant, Maven and Other Build Tools forum; my apologies.)

No problem. I've moved it for you.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic