From d7f7ee3fb34b748805adc841e22b8544aaa441bb Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Sun, 8 Sep 2024 14:57:33 +0200 Subject: [PATCH] Fail on javadoc errors and fix remaining javadoc errors --- .../builder/tests/ApiTestingEnvironment.java | 16 +++++++-------- .../tests/annotations/AnnotationTest.java | 8 ++++---- .../api/tools/builder/tests/tags/TagTest.java | 8 ++++---- .../tests/TestCompositeSearchReporter.java | 5 +++-- .../api/tools/util/tests/SignaturesTests.java | 2 +- .../ui/internal/ApiToolsLabelProvider.java | 4 ++-- .../api/tools/ui/internal/ApiUIPlugin.java | 2 +- .../markers/CreateApiFilterOperation.java | 4 +++- .../ApiBaselinePreferencePage.java | 15 +++++++------- .../ui/internal/refactoring/FilterChange.java | 20 ------------------- .../wizards/ApiBaselineWizardPage.java | 10 +++++----- .../internal/ApiDescriptionXmlCreator.java | 2 -- .../builder/AbstractProblemDetector.java | 1 - .../internal/builder/ReferenceExtractor.java | 4 ++-- .../tools/internal/builder/TagValidator.java | 3 +-- .../internal/comparator/DeltaXmlVisitor.java | 4 ++-- .../model/AbstractApiTypeContainer.java | 5 ++--- .../internal/model/AbstractApiTypeRoot.java | 2 +- .../model/ArchiveApiTypeContainer.java | 11 +++++----- .../tools/internal/model/BundleComponent.java | 3 +-- .../tools/internal/provisional/ApiPlugin.java | 2 +- .../tools/internal/provisional/Factory.java | 2 +- .../provisional/builder/IApiAnalyzer.java | 4 ++-- .../builder/IApiProblemDetector.java | 2 +- .../provisional/comparator/IDelta.java | 2 +- .../provisional/model/IApiElement.java | 9 +++------ .../internal/provisional/model/IApiType.java | 8 +++----- .../provisional/problems/IApiProblem.java | 2 +- .../search/IApiSearchRequestor.java | 5 ++--- .../search/ConsumerReportConvertor.java | 2 +- .../internal/search/UseReportConverter.java | 5 +++-- .../pde/api/tools/internal/util/Util.java | 2 -- .../internal/tasks/ApiMigrationTask.java | 2 +- .../api/tools/internal/tasks/ApiUseTask.java | 3 --- build/org.eclipse.pde.build/build.properties | 2 ++ .../internal/build/BuildScriptGenerator.java | 4 ++-- .../build/fetch/COPYFetchTasksFactory.java | 6 +++--- .../build/fetch/CVSFetchTaskFactory.java | 6 ++---- .../internal/build/site/ReachablePlugin.java | 2 +- .../build/tasks/BuildScriptGeneratorTask.java | 6 +++--- .../build/tasks/FeatureGeneratorTask.java | 2 +- .../build/tasks/FetchFileGeneratorTask.java | 2 +- .../pde/internal/build/tasks/FetchTask.java | 2 +- .../internal/build/tasks/IdReplaceTask.java | 4 ++-- .../build/tasks/JNLPGeneratorTask.java | 2 +- .../internal/build/tasks/PackagerTask.java | 2 +- .../build/tasks/UnzipperGeneratorTask.java | 2 +- pom.xml | 9 +++++++++ ui/org.eclipse.pde.core/build.properties | 1 + .../pde/internal/core/bundle/Bundle.java | 2 +- .../pde/internal/core/ischema/ISchema.java | 5 +++-- .../ui/editor/StructuredViewerSection.java | 13 ++++++++---- .../internal/ui/util/ModelModification.java | 9 ++++++--- .../pde/internal/ui/util/PDELabelUtility.java | 14 ++++++++++--- .../pde/internal/ui/samples/SampleWizard.java | 6 ------ .../internal/ui/samples/ShowSampleAction.java | 4 ++-- 56 files changed, 136 insertions(+), 148 deletions(-) diff --git a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/ApiTestingEnvironment.java b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/ApiTestingEnvironment.java index 2919fdacdb..b824c00973 100644 --- a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/ApiTestingEnvironment.java +++ b/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 */ diff --git a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/annotations/AnnotationTest.java b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/annotations/AnnotationTest.java index 10ac262870..7c6ecf0711 100644 --- a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/annotations/AnnotationTest.java +++ b/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 diff --git a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/TagTest.java b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/TagTest.java index cdfd85fcc1..a25dc8e3f6 100644 --- a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/builder/tests/tags/TagTest.java +++ b/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 diff --git a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/search/tests/TestCompositeSearchReporter.java b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/search/tests/TestCompositeSearchReporter.java index 0fb6f126ee..d9d139c250 100644 --- a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/search/tests/TestCompositeSearchReporter.java +++ b/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} * *

The {@link TestReporter} is always called first to validate we are getting the references / skipped * components that we are expecting to see

diff --git a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java b/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java index b280d033bb..a832329428 100644 --- a/apitools/org.eclipse.pde.api.tools.tests/src/org/eclipse/pde/api/tools/util/tests/SignaturesTests.java +++ b/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 { diff --git a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiToolsLabelProvider.java b/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiToolsLabelProvider.java index b71e24d8ca..a37485c0bb 100644 --- a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiToolsLabelProvider.java +++ b/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 diff --git a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiUIPlugin.java b/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiUIPlugin.java index 4874ce1307..a4b2e276b4 100644 --- a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/ApiUIPlugin.java +++ b/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} */ public static String getPluginIdentifier() { return PLUGIN_ID; diff --git a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/markers/CreateApiFilterOperation.java b/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/markers/CreateApiFilterOperation.java index ac291e7f1c..e586dcba2d 100644 --- a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/markers/CreateApiFilterOperation.java +++ b/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); diff --git a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/preferences/ApiBaselinePreferencePage.java b/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/preferences/ApiBaselinePreferencePage.java index 266a6319d5..3479d906cb 100644 --- a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/preferences/ApiBaselinePreferencePage.java +++ b/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) { diff --git a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/refactoring/FilterChange.java b/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/refactoring/FilterChange.java index 7f67c964bd..4882b47fa3 100644 --- a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/refactoring/FilterChange.java +++ b/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) { diff --git a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/wizards/ApiBaselineWizardPage.java b/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/wizards/ApiBaselineWizardPage.java index 2889cf8df1..93029d9f77 100644 --- a/apitools/org.eclipse.pde.api.tools.ui/src/org/eclipse/pde/api/tools/ui/internal/wizards/ApiBaselineWizardPage.java +++ b/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 - * null + * Returns the newly created {@link IApiBaseline} working copy or + * {@code null} * * @return the working copy or null */ @@ -231,7 +231,7 @@ protected IApiComponent[] getCurrentComponents() { /** * Creates or edits the profile and returns it * - * @return a new {@link IApiProfile} or null 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; diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionXmlCreator.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionXmlCreator.java index 20197e191b..37b745f855 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionXmlCreator.java +++ b/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; diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractProblemDetector.java index eb6d97cfcf..1c69d7639c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractProblemDetector.java +++ b/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 null if none - * @exception CoreException if something goes wrong */ protected IApiProblem createProblem(IReference reference, IJavaProject javaProject) { IProject project = javaProject.getProject(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceExtractor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceExtractor.java index c711b9b8a7..d4251eb340 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceExtractor.java +++ b/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 collector, int referenceKinds) { super(Util.LATEST_OPCODES_ASM, new ClassNode()); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TagValidator.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TagValidator.java index 61ffa7a98e..ce910d6d1a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TagValidator.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TagValidator.java @@ -48,8 +48,7 @@ *
* 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 */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/DeltaXmlVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/DeltaXmlVisitor.java index a778220771..e08175f586 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/DeltaXmlVisitor.java +++ b/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 */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeContainer.java index 3d4764e0f6..970d056fa6 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeContainer.java +++ b/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 { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeRoot.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeRoot.java index c3225bee36..aa2efb41db 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/AbstractApiTypeRoot.java +++ b/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() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ArchiveApiTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ArchiveApiTypeContainer.java index 34948de49f..89c325d868 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ArchiveApiTypeContainer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ArchiveApiTypeContainer.java @@ -148,7 +148,7 @@ private Path getLocation() throws IOException { } /** - * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#accept(org.eclipse.pde.api.tools.internal.provisional.ApiTypeContainerVisitor) + * @see AbstractApiTypeContainer#accept(ApiTypeContainerVisitor) */ @Override public void accept(ApiTypeContainerVisitor visitor) throws CoreException { @@ -181,7 +181,7 @@ public String toString() { } /** - * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#close() + * @see AbstractApiTypeContainer#close() */ @Override public synchronized void close() throws CoreException { @@ -189,7 +189,7 @@ public synchronized 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 { @@ -206,7 +206,7 @@ public IApiTypeRoot findTypeRoot(String qualifiedName) throws CoreException { } /** - * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#getPackageNames() + * @see AbstractApiTypeContainer#getPackageNames() */ @Override public String[] getPackageNames() throws CoreException { @@ -262,8 +262,7 @@ public int hashCode() { } /** - * @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 { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/BundleComponent.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/BundleComponent.java index b9703ddf04..fc8d4a3241 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/BundleComponent.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/BundleComponent.java @@ -477,7 +477,6 @@ protected Set getLocalPackageNames() throws CoreException { * @param bundle the bundle to load from * @param packages the complete set of packages names originating from the * backing component - * @throws CoreException if an error occurs */ public static void initializeApiDescription(IApiDescription apiDesc, BundleDescription bundle, Set packages) { @@ -568,7 +567,7 @@ protected IApiFilterStore createApiFilterStore() throws CoreException { } /** - * @see org.eclipse.pde.api.tools.internal.AbstractApiTypeContainer#createApiTypeContainers() + * @see AbstractApiTypeContainer#createApiTypeContainers() */ @Override protected List createApiTypeContainers() throws CoreException { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiPlugin.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiPlugin.java index cfb428af83..4a3ffee9f6 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiPlugin.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiPlugin.java @@ -494,7 +494,7 @@ public static boolean isRunningInFramework() { * {@link org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline} * s stored in the manager. * - * @return the singleton instance of the {@link IApiProfileManager} + * @return the singleton instance of the {@link IApiBaselineManager} */ public IApiBaselineManager getApiBaselineManager() { return ApiBaselineManager.getManager(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/Factory.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/Factory.java index 1cd2588b47..ce8892ab29 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/Factory.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/Factory.java @@ -88,7 +88,7 @@ public static IPackageDescriptor packageDescriptor(String packageName) { * fully qualified name. Package names are dot qualified and type names are * '$'-qualified. * - * @return an {@link ITypeDescriptor} for the type + * @return an {@link IReferenceTypeDescriptor} for the type */ public static IReferenceTypeDescriptor typeDescriptor(String fullyQualifiedName) { String packageName = Signatures.getPackageName(fullyQualifiedName); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiAnalyzer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiAnalyzer.java index 8f1d45ce47..46a9cac51d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiAnalyzer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiAnalyzer.java @@ -56,8 +56,8 @@ public interface IApiAnalyzer { * @param context the build context reported from the * {@link ApiAnalysisBuilder} * @param monitor to report progress - * @see PluginProjectApiComponent - * @see BundleApiComponent + * @see org.eclipse.pde.api.tools.internal.model.ProjectComponent + * @see org.eclipse.pde.api.tools.internal.model.BundleComponent */ public void analyzeComponent(final BuildState buildState, final IApiFilterStore filterStore, final Properties preferences, final IApiBaseline baseline, final IApiComponent component, final IBuildContext context, IProgressMonitor monitor); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiProblemDetector.java index d9a69e0653..cf0a9da4be 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IApiProblemDetector.java @@ -28,7 +28,7 @@ public interface IApiProblemDetector { /** * Returns a bit mask of reference kinds this analyzer is interested in. * - * @return bit mask of {@link ReferenceModifiers} constants + * @return bit mask of {@link IReference} constants */ public int getReferenceKinds(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/IDelta.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/IDelta.java index 568b0b64d6..57f8d5170b 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/IDelta.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/IDelta.java @@ -927,7 +927,7 @@ public interface IDelta { * {@link IDelta#METHOD_ELEMENT_TYPE}, {@link IDelta#INTERFACE_ELEMENT_TYPE} * , {@link IDelta#CLASS_ELEMENT_TYPE}, {@link IDelta#FIELD_ELEMENT_TYPE}, * {@link IDelta#API_COMPONENT_ELEMENT_TYPE} and - * {@link IDelta#API_PROFILE_ELEMENT_TYPE}. + * {@link IDelta#API_BASELINE_ELEMENT_TYPE}. * * @return flags that describe how an element has changed */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiElement.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiElement.java index 37b3a3e2da..a686f36e6d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiElement.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiElement.java @@ -24,8 +24,7 @@ public interface IApiElement { /** - * Constant representing an - * {@link org.eclipse.pde.api.tools.internal.provisional.IApiComponent} + * Constant representing an {@link IApiComponent} */ public int COMPONENT = 1; @@ -35,8 +34,7 @@ public interface IApiElement { public int TYPE = 2; /** - * Constant representing an - * {@link org.eclipse.pde.api.tools.internal.provisional.IApiTypeContainer} + * Constant representing an {@link IApiTypeContainer} */ public int API_TYPE_CONTAINER = 3; @@ -56,8 +54,7 @@ public interface IApiElement { public int METHOD = 6; /** - * Constant representing an - * {@link org.eclipse.pde.api.tools.internal.provisional.IApiTypeRoot} + * Constant representing an {@link IApiTypeRoot} */ public int API_TYPE_ROOT = 7; diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiType.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiType.java index 91fcfcc2e0..aabb2bdcc9 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiType.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiType.java @@ -153,9 +153,8 @@ public interface IApiType extends IApiMember { * "java.lang.Object". For anonymous types, the superclass name * is the name appearing after the 'new' keyword'. If the superclass is a * parameterized type, the string may include its type arguments enclosed in - * "<>". If the returned string is needed for anything other than - * display purposes, use {@link #getSuperclassTypeSignature()} which returns - * a structured type signature string containing more precise information. + * "<>". If the returned string is needed for anything other than display + * purposes, use {@link #getSuperclass()}. *

* * @return the name of this type's superclass or null @@ -231,8 +230,7 @@ public interface IApiType extends IApiMember { * kind. The list contains instances of {@link IReference}. * * @param referenceMask kinds of references to extract/search for as - * described by - * {@link org.eclipse.pde.api.tools.internal.provisional.search.ReferenceModifiers} + * described by {@link IReference} constants * @param monitor progress monitor or null * @return extracted {@link IReference}s, possibly an empty collection * @throws CoreException if this type does not exist or an exception occurs diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblem.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblem.java index 186f9e085a..7656b9abcf 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblem.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblem.java @@ -714,7 +714,7 @@ public interface IApiProblem { /** * Returns the names of the extra marker attributes associated to this - * problem when persisted into a marker by the {@link ApiProblemReporter}. + * problem when persisted into a marker. * By default, no EXTRA attributes is persisted, and an {@link IApiProblem} * only persists the following attributes: *
    diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchRequestor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchRequestor.java index d0b41e111e..d40a580355 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchRequestor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchRequestor.java @@ -31,7 +31,7 @@ public interface IApiSearchRequestor { * Search mask that will cause the engine to consider API references when * searching * - * @see #includesApi() + * @see #includesAPI() */ public static final int INCLUDE_API = 0x0001; /** @@ -98,8 +98,7 @@ public interface IApiSearchRequestor { /** * Returns the or'd listing of {@link IReference} kinds to look for. * - * @see org.eclipse.pde.api.tools.internal.provisional.builder.ReferenceModifiers - * for a complete listing of reference kinds + * @see IReference for a complete listing of reference kinds * * @return the listing of {@link IReference} kinds to consider during the * search this requestor is used for. diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ConsumerReportConvertor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ConsumerReportConvertor.java index bb42a56d30..632bc59a28 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ConsumerReportConvertor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ConsumerReportConvertor.java @@ -567,7 +567,7 @@ protected void writeConsumerReport(Consumer consumer, Map prod * Writes the html report for a given producer. The page lists all the types * that are referenced by the parent consumer that are from the producer. *

    - * Called from {@link #writeConsumerReport(Consumer)} + * Called from {@link #writeConsumerReport(Consumer, Map)} *

    * * @param producer producer to write the report for diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseReportConverter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseReportConverter.java index 31e06f08dd..236116e3ef 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseReportConverter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseReportConverter.java @@ -499,8 +499,9 @@ public void startElement(String uri, String localName, String qName, Attributes /** * Visibility constant indicating an element has host-fragment level of - * visibility. i.e. fragments have {@link #PRIVATE_PERMISSIBLE}-like access - * to the internals of their host. + * visibility. i.e. fragments have + * {@link VisibilityModifiers#PRIVATE_PERMISSIBLE}-like access to the internals + * of their host. * * @since 1.0.1 */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Util.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Util.java index 689148bdc4..77b63c10ce 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Util.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Util.java @@ -1788,8 +1788,6 @@ private static Path resolveEntryTarget(Path destDir, String name) throws CoreExc /** * Gets the .ee file supplied to run tests based on system property. - * - * @throws CoreException */ public static ExecutionEnvironmentDescription getEEDescriptionFile() { // generate a fake 1.6 ee file diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationTask.java index 94468dfe3e..c32aa72288 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationTask.java @@ -156,7 +156,7 @@ public void setDebug(String debugValue) { } /** - * @see org.eclipse.pde.api.tools.internal.tasks.UseTask#assertParameters() + * @see ApiUseTask#assertParameters() */ protected void assertParameters() throws BuildException { if (this.reportLocation == null) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseTask.java index 2f98785d2c..1c43a778d9 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseTask.java @@ -269,9 +269,6 @@ public void setArchivePatterns(String patterns) { archivePatterns = parsePatterns(patterns); } - /** - * @see org.eclipse.pde.api.tools.internal.tasks.UseTask#assertParameters() - */ protected void assertParameters() throws BuildException { if (this.reportLocation == null) { StringWriter out = new StringWriter(); diff --git a/build/org.eclipse.pde.build/build.properties b/build/org.eclipse.pde.build/build.properties index 5bbc866363..80d6567470 100644 --- a/build/org.eclipse.pde.build/build.properties +++ b/build/org.eclipse.pde.build/build.properties @@ -33,3 +33,5 @@ source.lib/pdebuild-ant.jar = src_ant/ output.lib/pdebuild-ant.jar = bin_ant/ jars.extra.classpath = platform:/plugin/org.apache.ant/lib/ant.jar,\ platform:/plugin/org.eclipse.equinox.p2.repository.tools/lib/repository-tools-ant.jar + +pom.model.property.javadoc.excludePackageNames = org.eclipse.pde.internal.build.publisher diff --git a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/BuildScriptGenerator.java b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/BuildScriptGenerator.java index 23826b5478..ebb63ec72f 100644 --- a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/BuildScriptGenerator.java +++ b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/BuildScriptGenerator.java @@ -98,7 +98,7 @@ public class BuildScriptGenerator extends AbstractScriptGenerator { /** flag indicating if missing properties file should be logged */ private boolean ignoreMissingPropertiesFile = true; - /** flag indicating if we should generate the plugin & feature versions lists */ + /** flag indicating if we should generate the plugin and feature versions lists */ protected boolean generateVersionsList = false; private Properties antProperties = null; @@ -497,7 +497,7 @@ public void setGenerateAssembleScript(boolean generateAssembleScript) { } /** - * Whether or not to generate plugin & feature versions lists + * Whether or not to generate plugin and feature versions lists */ public void setGenerateVersionsList(boolean generateVersionsList) { this.generateVersionsList = generateVersionsList; diff --git a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/COPYFetchTasksFactory.java b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/COPYFetchTasksFactory.java index 4327b1542b..7dfcaa404f 100644 --- a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/COPYFetchTasksFactory.java +++ b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/COPYFetchTasksFactory.java @@ -33,21 +33,21 @@ * copying from a specific location (id: COPY). *

    * Map file arguments: - * <ROOT_LOCATION>[,<ELEMENT_LOCATION>] + * {@code [,] } + *

    *
    *
    ROOT_LOCATION
    *
    The ROOT_LOCATION (eg. /source/eclipse, or * D:/dev/myproduct) is used as root path to determine the * location to fetch. It can be overwritten via the * fetchTag to fetch from another location (for example, on a different machine).
    - *
    *
    ELEMENT_LOCATION
    *
    A path withing the ROOT_LOCATION (eg. * org.eclipse.sdk-feature/features/org.eclipse.rcp) to retrive * the element from if it is not within the root. If this is not provided the * default path will be used which simply maps to the element name.
    * - *

    + * */ public class COPYFetchTasksFactory implements IFetchFactory, IPDEBuildConstants { public static final String ID = "COPY"; //$NON-NLS-1$ diff --git a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/CVSFetchTaskFactory.java b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/CVSFetchTaskFactory.java index 1a3f48da46..2d9bed6fb2 100644 --- a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/CVSFetchTaskFactory.java +++ b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/fetch/CVSFetchTaskFactory.java @@ -33,8 +33,7 @@ /** * An FetchTaskFactory for building fetch scripts that will * fetch content from a CVS repository (id: CVS). - *

    - * 

    + * 
      * Map file format:
  * 	type@id,[version]=CVS,args
  * args is a comma-separated list of key/value pairs
@@ -45,8 +44,7 @@
  * 	path - optional path relative to the cvsRoot
  * 	prebuilt - optional boolean value indicating that the entry points to a pre-built bundle in the repository
  * 	tag - mandatory CVS tag
- * 
    
- * 
    
+ *
    */ public class CVSFetchTaskFactory implements IFetchFactory { public static final String ID = "CVS"; //$NON-NLS-1$ diff --git a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/site/ReachablePlugin.java b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/site/ReachablePlugin.java index 08b3a79dc9..01447d662a 100644 --- a/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/site/ReachablePlugin.java +++ b/build/org.eclipse.pde.build/src/org/eclipse/pde/internal/build/site/ReachablePlugin.java @@ -22,7 +22,7 @@ /** * ReachablePlugin's are sorted first by id, then by the width of the version range. - * With equal range width, R1 < R2 if R1.range.getMinimum() < R2.range.getMaximum() + * With equal range width, {@code R1 < R2} if {@code R1.range.getMinimum() < R2.range.getMaximum()} */ public class ReachablePlugin implements Comparable { public static final VersionRange WIDEST_RANGE = Utils.EMPTY_RANGE; diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/BuildScriptGeneratorTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/BuildScriptGeneratorTask.java index dda6958b26..3ad94fc828 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/BuildScriptGeneratorTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/BuildScriptGeneratorTask.java @@ -181,7 +181,7 @@ public void setRecursiveGeneration(boolean recursiveGeneration) { /** * Set the configuration for which the script should be generated. The default is set to be configuration independent. - * @param configInfo an ampersand separated list of configuration (for example win32, win32, x86 & macoxs, carbon, ppc). + * @param configInfo an ampersand separated list of configuration (for example {@code win32, win32, x86 & macoxs, carbon, ppc}). * @since 3.0 */ public void setConfigInfo(String configInfo) throws CoreException { @@ -190,7 +190,7 @@ public void setConfigInfo(String configInfo) throws CoreException { /** * Set on a configuration basis, the format of the archive being produced. The default is set to be configuration independent. - * @param archivesFormat an ampersand separated list of configuration (for example win32, win32 - zip, x86 & macoxs, carbon, ppc - tar). + * @param archivesFormat an ampersand separated list of configuration (for example {@code win32, win32 - zip, x86 & macoxs, carbon, ppc - tar}). * @since 3.0 */ public void setArchivesFormat(String archivesFormat) { @@ -280,7 +280,7 @@ public void setGenerateFeatureVersionSuffix(boolean value) { } /** - * Set whether or not to generate plugin & feature versions lists + * Set whether or not to generate plugin and feature versions lists */ public void setGenerateVersionsLists(boolean value) { generator.setGenerateVersionsList(value); diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FeatureGeneratorTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FeatureGeneratorTask.java index 784e629dec..d1501c0803 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FeatureGeneratorTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FeatureGeneratorTask.java @@ -146,7 +146,7 @@ public void setVerify(boolean verify) { /** * Set the configuration for which the script should be generated. The default is set to be configuration independent. - * @param configInfo an ampersand separated list of configuration (for example win32, win32, x86 & macoxs, carbon, ppc). + * @param configInfo an ampersand separated list of configuration (for example {@code win32, win32, x86 & macoxs, carbon, ppc}). */ public void setConfigInfo(String configInfo) throws CoreException { AbstractScriptGenerator.setConfigInfo(configInfo); diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchFileGeneratorTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchFileGeneratorTask.java index e5914583eb..891d7add68 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchFileGeneratorTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchFileGeneratorTask.java @@ -38,7 +38,7 @@ public void setWorkingDirectory(String workingDirectory) { /** * Set the configuration for which the script should be generated. The default is set to be configuration independent. - * @param config an ampersand separated list of configuration (for example win32, win32, x86 & macoxs, carbon, ppc). + * @param config an ampersand separated list of configuration (for example {@code win32, win32, x86 & macoxs, carbon, ppc}). */ public void setConfigInfo(String config) throws CoreException { AbstractScriptGenerator.setConfigInfo(config); diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchTask.java index e35ad2ecd5..dde762e331 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/FetchTask.java @@ -140,7 +140,7 @@ public void setPluginPath(String pluginPath) { /** * Set the configuration for which the script should be generated. The default is set to be configuration independent. - * @param configInfo an ampersand separated list of configuration (for example win32, win32, x86 & macoxs, carbon, ppc). + * @param configInfo an ampersand separated list of configuration (for example {@code win32, win32, x86 & macoxs, carbon, ppc}). * @since 3.0 */ public void setConfigInfo(String configInfo) throws CoreException { diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/IdReplaceTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/IdReplaceTask.java index 6e363eae2b..76caedf850 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/IdReplaceTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/IdReplaceTask.java @@ -89,7 +89,7 @@ public void setSelfVersion(String version) { /** * Set the values to use when replacing a generic value used in a plugin reference. * Note all the pluginIds that have a generic number into the feature.xml must be - * listed in values. + * listed in {@code values}. * @param values a comma separated list alternating pluginId and versionNumber. * For example: org.eclipse.pde.build,2.1.0,org.eclipse.core.resources,1.2.0 */ @@ -112,7 +112,7 @@ public void setPluginIds(String values) { /** * Set the values to use when replacing a generic value used in a feature reference * Note that all the featureIds that have a generic number into the feature.xml must - * be liste in values. + * be listed in {@code values}. */ public void setFeatureIds(String values) { featureIds = new HashMap<>(10); diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/JNLPGeneratorTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/JNLPGeneratorTask.java index 4e31964cfa..00d34d8c12 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/JNLPGeneratorTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/JNLPGeneratorTask.java @@ -71,7 +71,7 @@ public void setJ2SE(String value) { /** * The locale in which the jnlp file generated should be translated into. - *The translation values are read from the feature_.properties file. + *The translation values are read from the feature_<locale>.properties file. * @param nlsString - the locale in which to generate the jnlp files. * */ public void setLocale(String nlsString) { diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/PackagerTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/PackagerTask.java index d91195d7b1..1cce37ca6a 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/PackagerTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/PackagerTask.java @@ -69,7 +69,7 @@ public void setConfigInfo(String configInfo) throws CoreException { /** * Set on a configuration basis, the format of the archive being produced. The default is set to be configuration independent. - * @param archivesFormat an ampersand separated list of configuration (for example win32, win32 - zip, x86 & macoxs, carbon, ppc - tar). + * @param archivesFormat an ampersand separated list of configuration (for example {@code win32, win32 - zip, x86 & macoxs, carbon, ppc - tar}). * @since 3.0 */ public void setArchivesFormat(String archivesFormat) { diff --git a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/UnzipperGeneratorTask.java b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/UnzipperGeneratorTask.java index 44065419a3..8a0021d38c 100644 --- a/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/UnzipperGeneratorTask.java +++ b/build/org.eclipse.pde.build/src_ant/org/eclipse/pde/internal/build/tasks/UnzipperGeneratorTask.java @@ -55,7 +55,7 @@ public void setWorkingDirectory(String installLocation) { /** * Set the configuration for which the script should be generated. The default is set to be configuration independent. - * @param configInfo an ampersand separated list of configuration (for example win32, win32, x86 & macoxs, carbon, ppc). + * @param configInfo an ampersand separated list of configuration (for example {@code win32, win32, x86 & macoxs, carbon, ppc}). */ public void setConfigInfo(String configInfo) throws BuildException { try { diff --git a/pom.xml b/pom.xml index 8844334ea8..8eeba7dbad 100644 --- a/pom.xml +++ b/pom.xml @@ -27,6 +27,8 @@ scm:git:https://github.com/eclipse-pde/eclipse.pde.git + true + @@ -57,6 +59,13 @@ true + + org.apache.maven.plugins + maven-javadoc-plugin + + ${javadoc.excludePackageNames} + + diff --git a/ui/org.eclipse.pde.core/build.properties b/ui/org.eclipse.pde.core/build.properties index 480b680330..33678f966e 100644 --- a/ui/org.eclipse.pde.core/build.properties +++ b/ui/org.eclipse.pde.core/build.properties @@ -38,3 +38,4 @@ jars.extra.classpath = platform:/plugin/org.apache.ant/lib/ant.jar,\ extra.lib/pde-ant.jar = ../org.apache.ant/ant.jar,\ ../org.eclipse.pde.build/lib/pdebuild-ant.jar pom.model.property.defaultSigning-excludeInnerJars = true +pom.model.property.javadoc.excludePackageNames = org.eclipse.pde.internal.core.ant diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/Bundle.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/Bundle.java index 3227cd9f80..d65b1108ef 100644 --- a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/Bundle.java +++ b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/bundle/Bundle.java @@ -62,7 +62,7 @@ public String getHeader(String key) { * headers previously loaded will be cleared. Empty value strings will create empty headers. * Null values will be ignored. * - * @param headers map of manifest key and values + * @param headers Map<String, String> of manifest key and values */ public void load(Map headers) { fDocumentHeaders.clear(); diff --git a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/ischema/ISchema.java b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/ischema/ISchema.java index a97c275a96..c52ccc41ae 100644 --- a/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/ischema/ISchema.java +++ b/ui/org.eclipse.pde.core/src/org/eclipse/pde/internal/core/ischema/ISchema.java @@ -157,15 +157,16 @@ public interface ISchema extends ISchemaObject, IBaseModel, IModelChangeProvider ISchemaInclude[] getIncludes(); /** - * Returns whether the root schema element (the element) + * Returns whether the root schema element (the <extension> element) * has been marked deprecated, making this schema deprecated. * @return true if this schema is deprecated */ public boolean isDeperecated(); /** - * Returns whether the root schema element (the element) + * Returns whether the root schema element (the <extension> element) * has been marked internal, making this schema internal. + * * @return true if this schema is internal * * @since 3.4 diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/StructuredViewerSection.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/StructuredViewerSection.java index 997658741d..150f4335e8 100644 --- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/StructuredViewerSection.java +++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/editor/StructuredViewerSection.java @@ -164,11 +164,16 @@ public StructuredViewerPart getStructuredViewerPart() { } /** - *

    Given the index of TreeViewer item and the size of the array of its immediate - * siblings, gets the index of the desired new selection as follows: - *

    • if this is the only item, return -1 (meaning select the parent)
      • + *

      + * Given the index of TreeViewer item and the size of the array of its + * immediate siblings, gets the index of the desired new selection as + * follows: + *

      + *
        + *
      • if this is the only item, return -1 (meaning select the parent)
        • *
      • if this is the last item, return the index of the predecessor
        • - *
      • otherwise, return the index of the successor

        • + *
      • otherwise, return the index of the successor
        • + *
      * * @param thisIndex * the item's index diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/ModelModification.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/ModelModification.java index 07fd84b3ea..dc28cee145 100644 --- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/ModelModification.java +++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/ModelModification.java @@ -44,9 +44,12 @@ public ModelModification(IFile modelFile) { /** * Create a full IBundlePluginModelBase modification - * @param bundleFile the MANIFEST.MF file - * @param xmlFile the plugin.xml/fragment.xml file for this modification (optional - can be null) - * @pre bundleFile must not be null + * + * @param bundleFile + * the MANIFEST.MF file (must not be {@code null}) + * @param xmlFile + * the plugin.xml/fragment.xml file for this modification + * (optional - may be {@code null}) */ public ModelModification(IFile bundleFile, IFile xmlFile) { createFullBundleModification(bundleFile, xmlFile); diff --git a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDELabelUtility.java b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDELabelUtility.java index 66a2ab5233..9156a6744a 100644 --- a/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDELabelUtility.java +++ b/ui/org.eclipse.pde.ui/src/org/eclipse/pde/internal/ui/util/PDELabelUtility.java @@ -180,9 +180,17 @@ public static String generateName(String[] names, String base) { } /** - *

      Generates a name that does not conflict with any of the given names with one of two forms: - *

      1. "<base> (#)"
      2. "<base>#"
      - * The number will be omitted if the base name alone is available.

      + *

      + * Generates a name that does not conflict with any of the given names with + * one of two forms: + *

      + *
        + *
      1. "<base> (#)"
        2. + *
      2. "<base>#"
        3. + *
      + *

      + * The number will be omitted if the base name alone is available. + *

      * * @param names * the existing names that should not be conflicted diff --git a/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/SampleWizard.java b/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/SampleWizard.java index 3b83dc5644..1d6264de22 100644 --- a/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/SampleWizard.java +++ b/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/SampleWizard.java @@ -242,7 +242,6 @@ public void setSampleEditorNeeded(boolean sampleEditorNeeded) { /** * @return Returns the switchPerspective. - * @todo Generated comment */ public boolean isSwitchPerspective() { return switchPerspective; @@ -250,7 +249,6 @@ public boolean isSwitchPerspective() { /** * @param switchPerspective The switchPerspective to set. - * @todo Generated comment */ public void setSwitchPerspective(boolean switchPerspective) { this.switchPerspective = switchPerspective; @@ -258,7 +256,6 @@ public void setSwitchPerspective(boolean switchPerspective) { /** * @return Returns the selectRevealEnabled. - * @todo Generated comment */ public boolean isSelectRevealEnabled() { return selectRevealEnabled; @@ -266,7 +263,6 @@ public boolean isSelectRevealEnabled() { /** * @param selectRevealEnabled The selectRevealEnabled to set. - * @todo Generated comment */ public void setSelectRevealEnabled(boolean selectRevealEnabled) { this.selectRevealEnabled = selectRevealEnabled; @@ -274,7 +270,6 @@ public void setSelectRevealEnabled(boolean selectRevealEnabled) { /** * @return Returns the activitiesEnabled. - * @todo Generated comment */ public boolean getActivitiesEnabled() { return activitiesEnabled; @@ -282,7 +277,6 @@ public boolean getActivitiesEnabled() { /** * @param activitiesEnabled The activitiesEnabled to set. - * @todo Generated comment */ public void setActivitiesEnabled(boolean activitiesEnabled) { this.activitiesEnabled = activitiesEnabled; diff --git a/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ShowSampleAction.java b/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ShowSampleAction.java index 130844413b..1a3713cb65 100644 --- a/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ShowSampleAction.java +++ b/ui/org.eclipse.pde.ui/src_samples/org/eclipse/pde/internal/ui/samples/ShowSampleAction.java @@ -215,8 +215,8 @@ private boolean downloadFeature() { } /** - * Returns a Collection of the installable units that contain the samples - * to be installed. + * Returns a Collection<IInstallableUnit> of the installable units + * that contain the samples to be installed. */ protected Collection findSampleIUs(URI location, SubMonitor monitor) throws ProvisionException { IMetadataRepository repository = provUI.loadMetadataRepository(location, false, monitor.split(5));