[Fb-contrib-commit] SF.net SVN: fb-contrib: [791] trunk/fb-contrib/src/com/mebigfatguy/ fbcontrib/detect/OverlyConcreteParameter.java

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

Revision: 791
          http://svn.sourceforge.net/fb-contrib/?rev=791&view=rev
Author:   dbrosius
Date:     2007-01-28 12:14:52 -0800 (Sun, 28 Jan 2007)

Log Message:
-----------
javadoc

Modified Paths:
--------------
    trunk/fb-contrib/src/com/mebigfatguy/fbcontrib/detect/OverlyConcreteParameter.java

Modified: trunk/fb-contrib/src/com/mebigfatguy/fbcontrib/detect/OverlyConcreteParameter.java
===================================================================
--- trunk/fb-contrib/src/com/mebigfatguy/fbcontrib/detect/OverlyConcreteParameter.java	2007-01-28 16:31:35 UTC (rev 790)
+++ trunk/fb-contrib/src/com/mebigfatguy/fbcontrib/detect/OverlyConcreteParameter.java	2007-01-28 20:14:52 UTC (rev 791)
@@ -262,6 +262,12 @@
 		}
 	}
 	
+	/** 
+	 * builds a map of method information for each method of each interface that each parameter implements of this method
+	 * @return a map by parameter id of all the method signatures that interfaces of that parameter implements
+	 * 
+	 * @throws ClassNotFoundException if the class can't be loaded
+	 */
 	private boolean buildParameterDefiners() 
 		throws ClassNotFoundException {
 		
@@ -293,6 +299,13 @@
 		return hasPossiblyOverlyConcreteParm;
 	}
 	
+	/**
+	 * returns a map of method information for each public method for each interface this class implements
+	 * @param cls the class whose interfaces to record
+	 * 
+	 * @return a map of (method name)(method sig) by interface
+	 * @throws ClassNotFoundException if unable to load the class
+	 */
 	private Map<JavaClass, List<String>> getClassDefiners(final JavaClass cls) 
 		throws ClassNotFoundException {
 		Map<JavaClass, List<String>> definers = new HashMap<JavaClass, List<String>>();
@@ -308,6 +321,12 @@
 		return definers;
 	}
 	
+	/**
+	 * returns a lost of method information of all public or protected methods in this class
+	 * 
+	 * @param cls the class to look for methods
+	 * @return a map of (method name)(method signature)
+	 */
 	private List<String> getPublicMethodInfos(final JavaClass cls) {
 		List<String> methodInfos = new ArrayList<String>();
 		Method[] methods = cls.getMethods();


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.