Javadoc for added interface

Signed-off-by: Rob Stryker <[email protected]>

org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ICompilationUnitResolver.java

@@ -23,34 +23,82 @@
  * @since 3.38
  */
 public interface ICompilationUnitResolver {
+	/**
+	 * Resolve the given source paths with the following options.
+	 *
+	 * @param sourceFilePaths the compilation units to create ASTs for
+	 * @param encodings the given encoding for the source units
+	 * @param bindingKeys the binding keys to create bindings for
+	 * @param requestor the AST requestor that collects abstract syntax trees and bindings
+	 * @param apiLevel Level of AST API desired.
+	 * @param compilerOptions Compiler options. Defaults to JavaCore.getOptions().
+	 * @param classpathList A list of classpaths to use during this operation
+	 * @param flags Flags to to be used during this operation
+	 * @param monitor A progress monitor
+	 */
 	void resolve(String[] sourceFilePaths, String[] encodings, String[] bindingKeys, FileASTRequestor requestor,
-			int apiLevel, Map<String, String> compilerOptions, List<Classpath> list, int flags,
+			int apiLevel, Map<String, String> compilerOptions, List<Classpath> classpathList, int flags,
 			IProgressMonitor monitor);
 
+	/**
+	 * Parse the given source paths with the following options.
+	 *
+	 * @param compilationUnits the compilation units to create ASTs for
+	 * @param requestor the AST requestor that collects abstract syntax trees and bindings
+	 * @param apiLevel Level of AST API desired.
+	 * @param compilerOptions Compiler options. Defaults to JavaCore.getOptions().
+	 * @param flags Flags to to be used during this operation
+	 * @param monitor A progress monitor
+	 */
 	void parse(ICompilationUnit[] compilationUnits, ASTRequestor requestor, int apiLevel,
 			Map<String, String> compilerOptions, int flags, IProgressMonitor monitor);
 
+	/**
+	 *
+	 * @param sourceFilePaths the compilation units to create ASTs for
+	 * @param encodings the given encoding for the source units
+	 * @param requestor the AST requester that collects abstract syntax trees and bindings
+	 * @param apiLevel Level of AST API desired.
+	 * @param compilerOptions Compiler options. Defaults to JavaCore.getOptions().
+	 * @param flags Flags to to be used during this operation
+	 * @param monitor A progress monitor
+	 */
 	void parse(String[] sourceFilePaths, String[] encodings, FileASTRequestor requestor, int apiLevel,
 			Map<String, String> compilerOptions, int flags, IProgressMonitor monitor);
 
+	/**
+	 *
+	 * @param compilationUnits the compilation units to create ASTs for
+	 * @param bindingKeys the binding keys to create bindings for
+	 * @param requestor the AST requester that collects abstract syntax trees and bindings
+	 * @param apiLevel Level of AST API desired.
+	 * @param compilerOptions Compiler options. Defaults to JavaCore.getOptions().
+	 * @param project The project providing the context of the resolution
+	 * @param workingCopyOwner  The owner of the working copy
+	 * @param flags Flags to to be used during this operation
+	 * @param monitor A progress monitor
+	 */
 	void resolve(ICompilationUnit[] compilationUnits, String[] bindingKeys, ASTRequestor requestor, int apiLevel,
 			Map<String, String> compilerOptions, IJavaProject project, WorkingCopyOwner workingCopyOwner, int flags,
 			IProgressMonitor monitor);
 
+
+
 	/**
+	 * Convert the given source unit into a CompilationUnit using the following options.
 	 *
-	 * @param sourceUnit
-	 * @param initialNeedsToResolveBinding
-	 * @param project
-	 * @param classpaths
+	 * @param sourceUnit A source unit
+	 * @param initialNeedsToResolveBinding Initial guess as to whether we need to resolve bindings
+	 * @param project The project providing the context of the conversion
+	 * @param classpaths A list of classpaths to use during this operation
 	 * @param focalPosition a position to focus on, or -1 if N/A
-	 * @param apiLevel
-	 * @param compilerOptions
-	 * @param parsedUnitWorkingCopyOwner
-	 * @param typeRootWorkingCopyOwner
-	 * @param flags
-	 * @param monitor
-	 * @return
+	 * @param apiLevel Level of AST API desired.
+	 * @param compilerOptions Compiler options. Defaults to JavaCore.getOptions().
+	 * @param parsedUnitWorkingCopyOwner The working copy owner of the unit
+	 * @param typeRootWorkingCopyOwner The working copy owner of the type
+	 * @param flags Flags to to be used during this operation
+	 * @param monitor A progress monitor
+	 * @return A CompilationUnit
 	 */
 	CompilationUnit toCompilationUnit(org.eclipse.jdt.internal.compiler.env.ICompilationUnit sourceUnit, final boolean initialNeedsToResolveBinding, IJavaProject project, List<Classpath> classpaths, int focalPosition,
 			int apiLevel, Map<String, String> compilerOptions, WorkingCopyOwner parsedUnitWorkingCopyOwner, WorkingCopyOwner typeRootWorkingCopyOwner, int flags, IProgressMonitor monitor);