Issue #34: Add javadocs

policeman-tools · Mar 28, 2015 · 971d50d · 971d50d
1 parent 78b62ba
commit 971d50d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/main/java/de/thetaphi/forbiddenapis/Checker.java b/src/main/java/de/thetaphi/forbiddenapis/Checker.java
@@ -384,10 +384,12 @@ public final boolean hasNoSignatures() {
     return forbiddenMethods.isEmpty() && forbiddenClasses.isEmpty() && forbiddenFields.isEmpty() && (!internalRuntimeForbidden);
   }
 
+  /** Adds the given annotation class for suppressing errors. */
   public final void addSuppressAnnotation(Class<? extends Annotation> anno) {
     suppressAnnotations.add(Type.getDescriptor(anno));
   }
 
+  /** Adds suppressing annotation name in binary form (dotted). The class name is not checked. */
   public final void addSuppressAnnotation(String annoName) throws ParseException {
     final Type type = Type.getObjectType(annoName.replace('.', '/'));
     if (type.getSort() != Type.OBJECT) {