[Fb-contrib-commit] fb-contrib/src/com/mebigfatguy/fbcontrib/detect AbstractClassEmptyMethods.java,1.3,1.4

[Dave B. <dbr...@us...>]

Update of /cvsroot/fb-contrib/fb-contrib/src/com/mebigfatguy/fbcontrib/detect
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21081/src/com/mebigfatguy/fbcontrib/detect

Modified Files:
	AbstractClassEmptyMethods.java 
Log Message:
java doc

Index: AbstractClassEmptyMethods.java
===================================================================
RCS file: /cvsroot/fb-contrib/fb-contrib/src/com/mebigfatguy/fbcontrib/detect/AbstractClassEmptyMethods.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- AbstractClassEmptyMethods.java	5 Dec 2005 05:21:15 -0000	1.3
+++ AbstractClassEmptyMethods.java	5 Dec 2005 05:30:24 -0000	1.4
@@ -73,6 +73,11 @@
 		return super.clone();
 	}
 	
+	/**
+	 * overrides the visitor to check for abstract classes
+	 * 
+	 * @param classContext the context object that holds the JavaClass being parsed
+	 */
 	@Override
 	public void visitClassContext(ClassContext classContext) {
 		JavaClass cls = classContext.getJavaClass();
@@ -80,12 +85,22 @@
 			super.visitClassContext(classContext);
 	}
 	
+	/**
+	 * overrides the visitor to grab the method name and reset the state
+	 * 
+	 * obj the method being parsed
+	 */
 	@Override
 	public void visitMethod(Method obj) {
 		methodName = obj.getName();
 		state = SEEN_NOTHING;
 	}
 	
+	/**
+	 * overrides the visitor to filter out constructors
+	 * 
+	 * @param obj the code to parse
+	 */
 	@Override
 	public void visitCode(Code obj) {
 		if ("<init>".equals(methodName) || "<clinit>".equals(methodName))
@@ -94,6 +109,11 @@
 		super.visitCode(obj);
 	}
 	
+	/**
+	 * overrides the visitor to look for empty methods or simple exception throwers
+	 * 
+	 * @param seen the opcode currently being parsed
+	 */
 	@Override
 	public void sawOpcode(int seen) {
 		try {