Javadoc cleanup

jpace · May 4, 2019 · bdfd2fd · bdfd2fd
1 parent 90c43f2
commit bdfd2fd
Showing 1 changed file with 21 additions and 14 deletions.
diff --git a/src/main/java/org/qualog/Filter.java b/src/main/java/org/qualog/Filter.java
@@ -4,18 +4,17 @@
 import org.incava.ijdk.lang.Range;
 
 /**
- * Represents a filter for selective enabling or disabling of logging
- * statements.
+ * Represents a filter for selective enabling or disabling of logging statements.
  */
 public class Filter {
     public static final Pattern NO_PATTERN = null;
     public static final Range NO_RANGE = null;
 
     private final Level level;
-    private final Pattern fileNamePat;
-    private final Range lineNumberRng;    
-    private final Pattern classNamePat;
-    private final Pattern methodNamePat;
+    private final Pattern fileNamePattern;
+    private final Range lineNumberRange;    
+    private final Pattern classNamePattern;
+    private final Pattern methodNamePattern;
 
     public Filter(Level level) {
         this(level, (Pattern)null, null, null, null);
@@ -24,10 +23,10 @@ public Filter(Level level) {
     public Filter(Level level, Pattern fnamePat, Range lnum, Pattern clsName, Pattern methName) {
         this.level = level;
 
-        fileNamePat = fnamePat;
-        lineNumberRng = lnum;
-        classNamePat = clsName;
-        methodNamePat = methName;
+        fileNamePattern = fnamePat;
+        lineNumberRange = lnum;
+        classNamePattern = clsName;
+        methodNamePattern = methName;
     }
 
     public Filter(Level level, String fname, Range lnum, String clsName, String methName) {
@@ -40,19 +39,27 @@ private static Pattern toPattern(String str) {
 
     /**
      * Returns the level.
+     *
+     * @return the level of this filter
      */
     public Level getLevel() {
         return level;
     }
 
     /**
      * Returns whether the given parameters match this filter.
+     *
+     * @param fileName the name of the file
+     * @param lineNumber the line number
+     * @param className the name of the class
+     * @param methodName the name of the method
+     * @return whether all fields match
      */
     public boolean isMatch(String fileName, int lineNumber, String className, String methodName) {
-        return (isMatch(fileNamePat,   fileName)   &&
-                isMatch(lineNumberRng, lineNumber) &&
-                isMatch(classNamePat,  className)  && 
-                isMatch(methodNamePat, methodName));
+        return (isMatch(fileNamePattern,   fileName)   &&
+                isMatch(lineNumberRange,   lineNumber) &&
+                isMatch(classNamePattern,  className)  && 
+                isMatch(methodNamePattern, methodName));
     }
 
     private boolean isMatch(Pattern pattern, String name) {