Added some documentation

src/main/java/jp/co/worksap/oss/findbugs/guava/MisuseOfVisibleForTestingDetector.java

@@ -20,7 +20,9 @@
 
 /**
  * <p>
- * Detector to check the corect usage of <code>@VisibleForTesting</code>.
+ * Detector to check the correct usage of <code>@VisibleForTesting</code>. This annotation should be allowed only
+ * for methods and fields with package-private visibility, because the only valid usecase is promoting a private
+ * method or field to package-private for the use in a unit test in the same package. 
  * </p>
  * 
  * @author tolina GmbH
@@ -48,7 +50,7 @@ public boolean apply(final AnnotationEntry input) {
 		}
 	};
 
-	public MisuseOfVisibleForTestingDetector(final BugReporter reporter) {
+	public MisuseOfVisibleForTestingDetector(final @Nonnull BugReporter reporter) {
 		this.reporter = reporter;
 	}
 
@@ -74,7 +76,7 @@ private boolean hasVisibleForTestingAnnotation(final FieldOrMethod obj) {
 	public void visit(final Method obj) {
 		if (hasVisibleForTestingAnnotation(obj) && !isPackageVisible(obj)) {
 			final BugInstance bug = bugInstanceSupplier.get();
-			bug.addClassAndMethod(this); //.addSourceLine(this);
+			bug.addClassAndMethod(this);
 			reporter.reportBug(bug);
 		}
 	}

src/main/meta/messages.xml

@@ -289,6 +289,8 @@
 
   <Detector class="jp.co.worksap.oss.findbugs.guava.MisuseOfVisibleForTestingDetector">
     <Details>
+      This detector will find all methods and fields annotated with @VisibleForTesting whose visibility is not 
+      package-private.
     </Details>
   </Detector>
 

src/test/java/jp/co/worksap/oss/findbugs/guava/MisuseOfVisibleForTestingDetectorTest.java

@@ -57,7 +57,7 @@ public void test() throws Exception {
 		when(bugInstanceSupplier.get()).thenAnswer(new Answer<BugInstanceStub>() {
 			public BugInstanceStub answer(org.mockito.invocation.InvocationOnMock invocation) throws Throwable {
 				return new BugInstanceStub();
-			};
+			}
 		});
 
 		// visit all fields