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 - *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"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:
* - * 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
/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).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.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
- *