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

[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-serv11711/src/com/mebigfatguy/fbcontrib/detect

Modified Files:
	ConfusingAutoboxedOverloading.java 
Log Message:
javadoc

Index: ConfusingAutoboxedOverloading.java
===================================================================
RCS file: /cvsroot/fb-contrib/fb-contrib/src/com/mebigfatguy/fbcontrib/detect/ConfusingAutoboxedOverloading.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- ConfusingAutoboxedOverloading.java	5 Dec 2005 05:21:15 -0000	1.4
+++ ConfusingAutoboxedOverloading.java	6 Dec 2005 05:38:31 -0000	1.5
@@ -65,6 +65,11 @@
 		return super.clone();
 	}
 	
+	/**
+	 * overrides the visitor to look for confusing signatures
+	 * 
+	 * @param classContent the context object that holds the JavaClass currently being parsed
+	 */
 	public void visitClassContext(ClassContext classContext) {
 		JavaClass cls = classContext.getJavaClass();
 		
@@ -93,6 +98,13 @@
 		}
 	}
 	
+	/**
+	 * returns if one signature is a Character and the other is a primitive
+	 * @param sig1 the first method signature
+	 * @param sig2 the second method signature
+	 * 
+	 * @return if one signature is a Character and the other a primitive
+	 */
 	private boolean confusingSignatures(String sig1, String sig2) {
 		if (sig1.equals(sig2))
 			return false;
@@ -124,6 +136,12 @@
 		return foundParmDiff;
 	}
 	
+	/**
+	 * fills out a set of method details for possibly confusing method signatures
+	 * 
+	 * @param cls the current class being parsed
+	 * @param methodInfo a collection to hold possibly confusing methods
+	 */
 	private void populateMethodInfo(JavaClass cls, Map<String, Set<String>> methodInfo) {
 		try {
 			if ("java.lang.Object".equals(cls.getClassName()))
@@ -150,6 +168,13 @@
 		}
 	}
 	
+	/**
+	 * returns whether a method signature has either a Character or primitive
+	 * 
+	 * @param sig the method signature
+	 * 
+	 * @return whether a method signature has either a Character or primitive
+	 */
 	private boolean isPossiblyConfusingSignature(String sig) {
 		Type[] types = Type.getArgumentTypes(sig);
 		for (Type t : types) {
@@ -162,6 +187,9 @@
 		return false;
 	}
 		
+	/**
+	 * implements the detector with null implementation
+	 */
 	public void report() {		
 	}
 }