Fail on javadoc errors and fix remaining javadoc errors

Author: HannesWell

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/ApiTestingEnvironment.java

@@ -183,7 +183,7 @@ public void fullBuild(IProject project, String builderid) {
 	 * @return all API usage problem markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#API_USAGE_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#API_USAGE_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllUsageMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -241,7 +241,7 @@ protected IMarker[] getAllJDTMarkers(IResource resource) throws CoreException {
 	 * @return all unsupported tag problem markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#UNSUPPORTED_TAG_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#UNSUPPORTED_TAG_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllUnsupportedTagMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -277,7 +277,7 @@ protected IMarker[] getAllUnsupportedAnnotationMarkers(IResource resource) throw
 	 * @return all compatibility problem markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#COMPATIBILITY_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#COMPATIBILITY_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllCompatibilityMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -296,7 +296,7 @@ protected IMarker[] getAllCompatibilityMarkers(IResource resource) throws CoreEx
 	 * @return all API baseline problem markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#DEFAULT_API_BASELINE_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#DEFAULT_API_BASELINE_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllApiBaselineMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -315,7 +315,7 @@ protected IMarker[] getAllApiBaselineMarkers(IResource resource) throws CoreExce
 	 * @return all since tag problem markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#SINCE_TAGS_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#SINCE_TAGS_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllSinceTagMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -333,7 +333,7 @@ protected IMarker[] getAllSinceTagMarkers(IResource resource) throws CoreExcepti
 	 * @return all version problem markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#VERSION_NUMBERING_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#VERSION_NUMBERING_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllVersionMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -352,7 +352,7 @@ protected IMarker[] getAllVersionMarkers(IResource resource) throws CoreExceptio
 	 * @return all unused problem filter markers
 	 * @throws CoreException
 	 *
-	 * @see {@link IApiMarkerConstants#UNUSED_FILTER_PROBLEM_MARKER}
+	 * @see IApiMarkerConstants#UNUSED_FILTER_PROBLEM_MARKER
 	 */
 	protected IMarker[] getAllUnusedApiProblemFilterMarkers(IResource resource) throws CoreException {
 		if (resource == null) {
@@ -456,7 +456,7 @@ public ApiProblem[] getProblems() {
 	}
 
 	/**
-	 * Returns the current workspace {@link IApiProfile}
+	 * Returns the current workspace {@link IApiBaseline}
 	 *
 	 * @return the workspace baseline
 	 */

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/annotations/AnnotationTest.java

@@ -154,10 +154,10 @@ protected void setBuilderOptions() {
 
 	/**
 	 * Returns an array composed only of the specified number of
-	 * {@link #PROBLEM_ID}
+	 * {@link #getDefaultProblemId()}
 	 *
-	 * @return an array of {@link #PROBLEM_ID} of the specified size, or an
-	 *         empty array if the specified size is < 1
+	 * @return an array of {@link #getDefaultProblemId()} of the specified size,
+	 *         or an empty array if the specified size is smaller 1
 	 */
 	protected int[] getDefaultProblemSet(int problemcount) {
 		if (problemcount < 1) {
@@ -183,7 +183,7 @@ protected String getTestingProjectName() {
 
 	/**
 	 * Deploys a build test for API Javadoc tags using the given source file,
-	 * looking for problems specified from {@link #getExpectedProblemIds()()}
+	 * looking for problems specified from {@link #getExpectedProblemIds()}
 	 *
 	 * @param incremental if an incremental build should take place
 	 * @param usedefault if the default package should be used or not

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/TagTest.java

@@ -146,10 +146,10 @@ protected void setBuilderOptions() {
 
 	/**
 	 * Returns an array composed only of the specified number of
-	 * {@link #PROBLEM_ID}
+	 * {@link #getDefaultProblemId()}
 	 *
-	 * @return an array of {@link #PROBLEM_ID} of the specified size, or an
-	 *         empty array if the specified size is < 1
+	 * @return an array of {@link #getDefaultProblemId()} of the specified size,
+	 *         or an empty array if the specified size is smaller 1
 	 */
 	protected int[] getDefaultProblemSet(int problemcount) {
 		if (problemcount < 1) {
@@ -175,7 +175,7 @@ protected String getTestingProjectName() {
 
 	/**
 	 * Deploys a build test for API Javadoc tags using the given source file,
-	 * looking for problems specified from {@link #getExpectedProblemIds()()}
+	 * looking for problems specified from {@link #getExpectedProblemIds()}
 	 *
 	 * @param incremental if an incremental build should take place
 	 * @param usedefault if the default package should be used or not

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/search/tests/TestCompositeSearchReporter.java

@@ -19,10 +19,11 @@
 import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement;
 import org.eclipse.pde.api.tools.internal.provisional.search.IApiSearchReporter;
 import org.eclipse.pde.api.tools.internal.provisional.search.IMetadata;
+import org.eclipse.pde.api.tools.internal.search.XmlSearchReporter;
 
 /**
- * Test implementation of a search reporter that delegates to two
- * reporters: The {@link TestReporter} and the {@link XMLApiSearchReporter}
+ * Test implementation of a search reporter that delegates to two reporters: The
+ * {@link TestReporter} and the {@link XmlSearchReporter}
  *
  * <p>The {@link TestReporter} is always called first to validate we are getting the references / skipped
  * components that we are expecting to see</p>

apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java

@@ -140,7 +140,7 @@ public void testGetQualifiedMethodSignature() throws Exception {
 	}
 
 	/**
-	 * Tests the {@link Signatures#getQualifiedMethodSignature(org.eclipse.pde.api.tools.internal.provisional.descriptors.IMethodDescriptor, boolean)} method
+	 * Tests the {@link Signatures#getQualifiedMethodSignature(IMethodDescriptor, boolean, boolean)} method
 	 */
 	@Test
 	public void testGetQualifiedMethodSignature2() throws Exception {

apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiToolsLabelProvider.java

@@ -52,7 +52,7 @@
 public class ApiToolsLabelProvider extends BaseLabelProvider implements ILabelProvider, IFontProvider {
 
 	/**
-	 * Font for the default {@link IApiProfile}
+	 * Font for the default {@link IApiBaseline}
 	 */
 	private Font font = null;
 
@@ -237,7 +237,7 @@ public String getText(Object element) {
 	}
 
 	/**
-	 * Returns if the specified {@link IApiProfile} is the default profile or
+	 * Returns if the specified {@link IApiBaseline} is the default profile or
 	 * not
 	 *
 	 * @return if the profile is the default or not

apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiUIPlugin.java

@@ -150,7 +150,7 @@ public static ImageDescriptor getImageDescriptor(String key) {
 
 	/**
 	 * @return the id of this plugin. Value is
-	 *         <code><org.eclipse.pde.api.tools.ui></code>
+	 *         {@code org.eclipse.pde.api.tools.ui}
 	 */
 	public static String getPluginIdentifier() {
 		return PLUGIN_ID;

apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/markers/CreateApiFilterOperation.java

@@ -63,7 +63,9 @@ public class CreateApiFilterOperation extends Job {
 	/**
 	 * Constructor
 	 *
-	 * @see IApiProblemFilter#getKinds()
+	 * @see IApiProblemFilter#getUnderlyingProblem()
+	 * @see IApiProblem#getKind()
+	 * @see IApiProblem#getElementKind()
 	 */
 	public CreateApiFilterOperation(IMarker[] markers, boolean addingcomments) {
 		super(MarkerMessages.CreateApiFilterOperation_0);

apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/preferences/ApiBaselinePreferencePage.java

@@ -74,8 +74,8 @@ public class ApiBaselinePreferencePage extends PreferencePage implements IWorkbe
 	public static final String ID = "org.eclipse.pde.api.tools.ui.apiprofiles.prefpage"; //$NON-NLS-1$
 
 	/**
-	 * Override to tell the label provider about uncommitted {@link IApiProfile}
-	 * s that might have been set to be the new default
+	 * Override to tell the label provider about uncommitted
+	 * {@link IApiBaseline}s that might have been set to be the new default
 	 */
 	class BaselineLabelProvider extends ApiToolsLabelProvider {
 		@Override
@@ -206,11 +206,12 @@ public int compare(Viewer viewer, Object e1, Object e2) {
 	}
 
 	/**
-	 * Returns if the {@link IApiProfile} with the given name has been removed,
+	 * Returns if the {@link IApiBaseline} with the given name has been removed,
 	 * but not yet committed back to the manager
 	 *
-	 * @param name the name of the {@link IApiProfile}
-	 * @return true if the {@link IApiProfile} has been removed from the page,
+	 * @param name
+	 *            the name of the {@link IApiBaseline}
+	 * @return true if the {@link IApiBaseline} has been removed from the page,
 	 *         false otherwise
 	 */
 	public static boolean isRemovedBaseline(String name) {
@@ -267,7 +268,7 @@ protected void doEdit(final IApiBaseline baseline) {
 	}
 
 	/**
-	 * Returns if the specified {@link IApiProfile} is the default profile or
+	 * Returns if the specified {@link IApiBaseline} is the default profile or
 	 * not
 	 *
 	 * @return if the profile is the default or not
@@ -314,7 +315,7 @@ public boolean performCancel() {
 
 	/**
 	 * Applies the changes from the current change set to the
-	 * {@link ApiProfileManager}. When done the current change set is cleared.
+	 * {@link IApiBaselineManager}. When done the current change set is cleared.
 	 */
 	protected void applyChanges() {
 		if (!dirty) {

apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/refactoring/FilterChange.java

@@ -96,26 +96,6 @@ protected String getDeleteName() {
 		return NLS.bind(RefactoringMessages.FilterChange_remove_used_filter, problem.getMessage());
 	}
 
-	/**
-	 * Returns the name to use for a {@link #RENAME} change operation
-	 *
-	 * @return the name for a {@link #RENAME} change
-	 */
-	protected String getRenameName() {
-		IApiProblem problem = this.filter.getUnderlyingProblem();
-		return NLS.bind(RefactoringMessages.FilterChange_remove_used_filter, new Object[] { problem.getMessage() });
-	}
-
-	/**
-	 * Returns the name to use for a {@link #MOVE} change operation
-	 *
-	 * @return the name for a {@link #MOVE} change
-	 */
-	protected String getMoveName() {
-		IApiProblem problem = this.filter.getUnderlyingProblem();
-		return NLS.bind(RefactoringMessages.FilterChange_remove_used_filter, new Object[] { problem.getMessage() });
-	}
-
 	@Override
 	public String getName() {
 		switch (this.kind) {

apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/wizards/ApiBaselineWizardPage.java

@@ -107,8 +107,8 @@ public Object getParent(Object element) {
 	}
 
 	/**
-	 * Operation that creates a new working copy for an {@link IApiProfile} that
-	 * is being edited
+	 * Operation that creates a new working copy for an {@link IApiBaseline}
+	 * that is being edited
 	 */
 	static class WorkingCopyOperation implements IRunnableWithProgress {
 
@@ -146,8 +146,8 @@ public void run(IProgressMonitor monitor) throws InvocationTargetException, Inte
 		}
 
 		/**
-		 * Returns the newly created {@link IApiProfile} working copy or
-		 * <code>null</code>
+		 * Returns the newly created {@link IApiBaseline} working copy or
+		 * {@code null}
 		 *
 		 * @return the working copy or <code>null</code>
 		 */
@@ -231,7 +231,7 @@ protected IApiComponent[] getCurrentComponents() {
 	/**
 	 * Creates or edits the profile and returns it
 	 *
-	 * @return a new {@link IApiProfile} or <code>null</code> if an error was
+	 * @return a new {@link IApiBaseline} or {@code null} if an error was
 	 *         encountered creating the new profile
 	 */
 	public abstract IApiBaseline finish() throws IOException, CoreException;

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionXmlCreator.java

@@ -137,8 +137,6 @@ public void endVisitElement(IElementDescriptor element, IApiAnnotations descript
 
 	/**
 	 * Returns the settings as a XML {@link Document}.
-	 *
-	 * @throws CoreException if something goes wrong
 	 */
 	public Document getXML() {
 		return fDoc;

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractProblemDetector.java

@@ -170,7 +170,6 @@ public boolean considerReference(IReference reference, IProgressMonitor monitor)
 	 * @param reference   reference
 	 * @param javaProject java project (with reference source location)
 	 * @return problem or <code>null</code> if none
-	 * @exception CoreException if something goes wrong
 	 */
 	protected IApiProblem createProblem(IReference reference, IJavaProject javaProject) {
 		IProject project = javaProject.getProject();

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceExtractor.java

@@ -883,7 +883,7 @@ public int hashCode() {
 	private final boolean fIncludeLocalRefs = false;
 
 	/**
-	 * Bit mask of {@link ReferenceModifiers} to extract.
+	 * Bit mask of {@link IReference} constants to extract.
 	 */
 	private int fReferenceKinds = 0;
 
@@ -932,7 +932,7 @@ public int hashCode() {
 	 * @param type the type to extract references from
 	 * @param collector the listing of references to annotate from this pass
 	 * @param referenceKinds kinds of references to extract as defined by
-	 *            {@link ReferenceModifiers}
+	 *            {@link IReference}
 	 */
 	public ReferenceExtractor(IApiType type, Set<Reference> collector, int referenceKinds) {
 		super(Util.LATEST_OPCODES_ASM, new ClassNode());

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TagValidator.java

@@ -48,8 +48,7 @@
  * <br>
  * The logic in this class must be kept in sync with how we determine what is
  * visible in out completion proposal code
- *
- * @see org.eclipse.pde.api.tools.ui.internal.completion.APIToolsJavadocCompletionProposalComputer
+ * {@code org.eclipse.pde.api.tools.ui.internal.completion.APIToolsJavadocCompletionProposalComputer}
  *
  * @since 1.0.0
  */

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/DeltaXmlVisitor.java

@@ -100,8 +100,8 @@ public void endVisit(IDelta delta) {
 	}
 
 	/**
-	 * Return the xml dom document this visitor generates. Use {@link #getXML()}
-	 * to get the serialized xml string.
+	 * Return the xml dom document this visitor generates. Use
+	 * {@link Util#serializeDocument(Document)} to get the serialized xml string.
 	 *
 	 * @return xml dom document
 	 */

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeContainer.java

@@ -102,7 +102,7 @@ public void close() throws CoreException {
 	}
 
 	/**
-	 * @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer#findTypeRoot(java.lang.String)
+	 * @see IApiTypeContainer#findTypeRoot(java.lang.String)
 	 */
 	@Override
 	public IApiTypeRoot findTypeRoot(String qualifiedName) throws CoreException {
@@ -117,8 +117,7 @@ public IApiTypeRoot findTypeRoot(String qualifiedName) throws CoreException {
 	}
 
 	/**
-	 * @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer#findTypeRoot(java.lang.String,
-	 *      java.lang.String)
+	 * @see IApiTypeContainer#findTypeRoot(java.lang.String, java.lang.String)
 	 */
 	@Override
 	public IApiTypeRoot findTypeRoot(String qualifiedName, String id) throws CoreException {

apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeRoot.java

@@ -80,7 +80,7 @@ public IApiType getStructure() throws CoreException {
 	}
 
 	/**
-	 * @see org.eclipse.pde.api.tools.internal.provisional.IApiTypeRoot#getApiComponent()
+	 * @see IApiTypeRoot#getApiComponent()
 	 */
 	@Override
 	public IApiComponent getApiComponent() {