• Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 3925
  • Last Modified:

JavaDoc + Package-info.java + Eclipse + Maven + Checkstyle = ?

I am upgrading my project from using Checkstyle 4.4 to 5.3 and while I am at it, updating my packages to include Package-info.java for package annotation support. My project is built with Maven and am using M2Eclipse plugin for Eclipse. The suggested Maven project structure has my main java classes and test classes under different files but with the same package names.

Eclipse gives a compile error "The type package-info is already defined" if I add the Package-info.java to both main and test packages. And Checkstyle will complain if I do not have it in both.

What is the best practice here? I do not want to have to configure any special filters in my Eclipse build source, because we are relying on M2Eclipse to import the existing Maven projects out of the box. I do not want to disable the checkstyle rule because it needs to be checked. And I would rather not keep using the old 1.4 convention.
0
Uncle_J
Asked:
Uncle_J
  • 4
  • 3
1 Solution
 
objectsCommented:
does checkstyle need to be accessing your test classes? would think you would only run it on your main classes
and why do you have a test class for package-info
0
 
Uncle_JAuthor Commented:
Why would I not want our test classes to conform to the same coding style as production code? Also, I do not have a test class for package-info. Checkstyle does not seem to be aware that package-info.java already exists, just under a different file path (maven convention). I cannot be the first person to have this question. I am assuming there is a common solution to this.
0
 
objectsCommented:
>  if I add the Package-info.java to both main and test packages.

>  Also, I do not have a test class for package-info.

Am confused by these two. Do you have a copy of package-info in your test directory?
0
VIDEO: THE CONCERTO CLOUD FOR HEALTHCARE

Modern healthcare requires a modern cloud. View this brief video to understand how the Concerto Cloud for Healthcare can help your organization.

 
Uncle_JAuthor Commented:
Here is the setup

src/main/java/com/domain/my/ (com.domain.my package main)
...
src/test/java/com/domain/my/ (com.domain.my package test)

both src/main/java and src/test/java are in the Eclipse build path, but with different output dirs for the compiled classes (target/classes and target/test-classes). Yet, Eclipse shows a compiler error if I have package-info.java in both of these dirs. And if I dont have in both, Checkstyle complains that I am missing the package-info.java in the one without. Its a catch 22.
0
 
objectsCommented:
> Yet, Eclipse shows a compiler error if I have package-info.java in both of these dirs.

which is expected, you can't have two classes with the same name and package

>  Checkstyle complains that I am missing the package-info.java in the one without

Whats it complaining about exactly?
0
 
Uncle_JAuthor Commented:
The Package Javadoc module for Checkstyle will complain "Missing package-info.java file". I have attached an example project. Enable Checkstyle in Eclipse using the standard sun checks and notice the warning.
 product.zip
Note: change the classpath.txt and project.txt to .classpath and .project to import into eclipse.
0
 
mccarlIT Business Systems Analyst / Software DeveloperCommented:
It seems that the JavadocPackage check doesn't have any properties that will allow you to exclude the test packages, however, you should be able to setup the suppression filter to exclude those errors. (http://checkstyle.sourceforge.net/config.html#SuppressionFilter

I would say that your suppressions XML document would need to look something like this... (you may need to tweak the regexp in the 'files' attribute)


<?xml version="1.0"?>

<!DOCTYPE suppressions PUBLIC
    "-//Puppy Crawl//DTD Suppressions 1.1//EN"
    "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">

<suppressions>
    <suppress checks="JavadocPackage"
              files="src/test/java"/>
</suppressions>

Open in new window

0
 
Uncle_JAuthor Commented:
That works. Thank you
0

Featured Post

Concerto's Cloud Advisory Services

Want to avoid the missteps to gaining all the benefits of the cloud? Learn more about the different assessment options from our Cloud Advisory team.

  • 4
  • 3
Tackle projects and never again get stuck behind a technical roadblock.
Join Now