Bug 3963 Clean up the [Issues] in javadoc (1GF9P7T)
Search for Issues in our plug-ins and clean up. This was found for JDT: org.eclipse.jdt.ui.wizards.NewJavaProjectWizardPage * [Issue: It is slightly unfortunate to make appeal to a preference in an API * method but not expose that preference as API. * ] public void setDefaultClassPath(IClasspathEntry[] entries, boolean appendDefaultJRE) { ==> There's a setter but no getter. This is a designed. Remove the Issue comment. org.eclipse.jdt.ui.JavaUI * [Issue: SelectionDialogs must be parented. shell must not be null.] * @param parent the parent shell of the dialog to be created public static SelectionDialog createMainTypeDialog(Shell parent, IRunnableContext cont... ==> This is a designed: we want to allow unparented dialogs. Remove the Issue comment. * [Issue: Explain semantics of opening an editor on a class file.] * </p> * <p> * [Issue: Explain under which conditions it returns null, throws JavaModelException, * or throws JavaModelException. * ] * </p> * @param element the input element; either a compilation unit * (<code>ICompilationUnit</code>) or a class file (</code>IClassFile</code>) * @return the editor, or </code>null</code> if wrong element type or opening failed * @exception PartInitException if the editor could not be initialized * @exception JavaModelException if this element does not exist or if an * exception occurs while accessing its underlying resource */ public static IEditorPart openInEditor(IJavaElement element) throws JavaModelException, PartInitException { ==> Better explanation would be good. * Reveals the source range of the given source reference element in the * given editor. No checking is done if the editor displays a compilation unit or * class file that contains the given source reference. * <p> * [Issue: Explain what is meant by that last sentence.] * </p> * <p> * [Issue: Explain what happens if the source reference is from some other * compilation unit, editor is not open, etc.] * </p> public static void revealInEditor(IEditorPart part, ISourceReference element) { ==> Better explanation would be good. PackageViewer // defensive code. Multithread issue? if (item.isDisposed()) ==> Would write: // guard for thread safety --- or --- remove the ? NOTES:
org.eclipse.jdt.ui/ui/org/eclipse/jdt/ui/JavaUI.java
* </p>
	 * <p>
	 * [Issue: SelectionDialogs must be parented. shell must not be null.]
	 * </p>
	 * 
	 * @param parent the parent shell of the dialog to be created
	 * @param context the runnable context used to show progress when the dialog
	 *   is being populated
	 * @param scope the scope that limits which types are included
	 * @param style flags defining the style of the dialog; the only valid values are
	 *   <code>IJavaElementSearchConstants.CONSIDER_BINARIES</code>,
	 *   <code>CONSIDER_EXTERNAL_JARS</code>, or their bitwise OR, or <code>0</code>
	 * @param multipleSelection <code>true</code> if multiple selection is allowed
	 * @param filter the filter
	 * @return a new selection dialog
	 */
	public static SelectionDialog createMainTypeDialog(Shell parent, IRunnableContext context, IJavaSearchScope scope, int style, boolean multipleSelection, String filter) {
		AbstractElementListSelectionDialog dialog= null;
		if (multipleSelection) {
			dialog= new MultiMainTypeSelectionDialog(parent, context, scope, style);
		} else {
			dialog= new MainTypeSelectionDialog(parent, context, scope, style);
		}		
		dialog.setFilter(filter);
		return dialog;
	}
	/**
	 * @see createMainTypeDialog(Shell,IRunnableContext,IJavaSearchScope,int,boolean,String)
	 */
	public static SelectionDialog createMainTypeDialog(Shell parent, IRunnableContext context, IJavaSearchScope scope, int style, boolean multipleSelection) {