diff options
| author | Lars Vogel | 2015-10-27 09:47:31 +0000 |
|---|---|---|
| committer | Lars Vogel | 2015-10-30 23:29:49 +0000 |
| commit | e54ef67df9d00032f4747b52511ea1dd994965c9 (patch) | |
| tree | cb34ec5ca55b910a19a8cc4981c76595eeb2bb40 | |
| parent | a2394f9f4ec79c84753a36ddaa4f1e051b8c5f13 (diff) | |
| download | eclipse.pde.ui-e54ef67df9d00032f4747b52511ea1dd994965c9.tar.gz eclipse.pde.ui-e54ef67df9d00032f4747b52511ea1dd994965c9.tar.xz eclipse.pde.ui-e54ef67df9d00032f4747b52511ea1dd994965c9.zip | |
Bug 480743 - Remove unnecessary whitespace from eclipse.pde.api.tools
Change-Id: Ibb6a49120522ecdf0e7763fe16deb82a61521e14
Signed-off-by: Lars Vogel <Lars.Vogel@vogella.com>
195 files changed, 1963 insertions, 1957 deletions
diff --git a/apitools/org.eclipse.pde.api.tools/.settings/org.eclipse.jdt.ui.prefs b/apitools/org.eclipse.pde.api.tools/.settings/org.eclipse.jdt.ui.prefs index e7dfdc6431..f8b69410c7 100644 --- a/apitools/org.eclipse.pde.api.tools/.settings/org.eclipse.jdt.ui.prefs +++ b/apitools/org.eclipse.pde.api.tools/.settings/org.eclipse.jdt.ui.prefs @@ -68,10 +68,12 @@ sp_cleanup.always_use_blocks=true sp_cleanup.always_use_parentheses_in_expressions=false sp_cleanup.always_use_this_for_non_static_field_access=false sp_cleanup.always_use_this_for_non_static_method_access=false +sp_cleanup.convert_functional_interfaces=false sp_cleanup.convert_to_enhanced_for_loop=false sp_cleanup.correct_indentation=false sp_cleanup.format_source_code=true sp_cleanup.format_source_code_changes_only=true +sp_cleanup.insert_inferred_type_arguments=false sp_cleanup.make_local_variable_final=false sp_cleanup.make_parameters_final=false sp_cleanup.make_private_fields_final=true @@ -87,7 +89,8 @@ sp_cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class= sp_cleanup.qualify_static_member_accesses_with_declaring_class=false sp_cleanup.qualify_static_method_accesses_with_declaring_class=false sp_cleanup.remove_private_constructors=true -sp_cleanup.remove_trailing_whitespaces=false +sp_cleanup.remove_redundant_type_arguments=false +sp_cleanup.remove_trailing_whitespaces=true sp_cleanup.remove_trailing_whitespaces_all=true sp_cleanup.remove_trailing_whitespaces_ignore_empty=false sp_cleanup.remove_unnecessary_casts=true @@ -100,10 +103,13 @@ sp_cleanup.remove_unused_private_methods=true sp_cleanup.remove_unused_private_types=true sp_cleanup.sort_members=false sp_cleanup.sort_members_all=false +sp_cleanup.use_anonymous_class_creation=false sp_cleanup.use_blocks=true sp_cleanup.use_blocks_only_for_return_and_throw=false +sp_cleanup.use_lambda=false sp_cleanup.use_parentheses_in_expressions=false sp_cleanup.use_this_for_non_static_field_access=false sp_cleanup.use_this_for_non_static_field_access_only_if_necessary=true sp_cleanup.use_this_for_non_static_method_access=false sp_cleanup.use_this_for_non_static_method_access_only_if_necessary=true +sp_cleanup.use_type_arguments=false diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AntFilterStore.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AntFilterStore.java index 377b7d6074..661eff751c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AntFilterStore.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AntFilterStore.java @@ -35,7 +35,7 @@ public class AntFilterStore extends FilterStore { public static ArrayList<IApiProblem> filteredAPIProblems = new ArrayList<>(); /** * Constructor - * + * * @param debug * @param filtersRoot * @param componentID @@ -83,7 +83,7 @@ public class AntFilterStore extends FilterStore { /** * Internal use method that allows auto-persisting of the filter file to be * turned on or off - * + * * @param problems the problems to add the the store * @param persist if the filters should be auto-persisted after they are * added diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AnyValue.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AnyValue.java index 5c250e394e..ab301a3fdc 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AnyValue.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/AnyValue.java @@ -13,14 +13,14 @@ package org.eclipse.pde.api.tools.internal; /** * Used to represent any value for system settings in OSGi state. For example, * ws, os, arch. - * + * * @since 1.0.0 */ public class AnyValue { /** * Constructor - * + * * @param arg */ public AnyValue(String arg) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAccess.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAccess.java index ab7a3d2e16..0317b66f9d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAccess.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAccess.java @@ -14,7 +14,7 @@ import org.eclipse.pde.api.tools.internal.provisional.IApiAccess; /** * Default implementation of {@link IApiAccess} - * + * * @since 1.0.1 * @noextend This class is not intended to be subclassed by clients. * @noinstantiate This class is not intended to be instantiated by clients. @@ -34,7 +34,7 @@ public class ApiAccess implements IApiAccess { /** * Constructor - * + * * @param access */ public ApiAccess(int access) { @@ -69,7 +69,7 @@ public class ApiAccess implements IApiAccess { /** * Returns a textual representation of an {@link IApiAccess} - * + * * @param access * @return the textual representation of an {@link IApiAccess} */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAnnotations.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAnnotations.java index d00aeefd6c..fbeffdab84 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAnnotations.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiAnnotations.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -16,7 +16,7 @@ import org.eclipse.pde.api.tools.internal.provisional.VisibilityModifiers; /** * Base implementation of the {@linkplain IApiAnnotations} interface - * + * * @since 1.0.0 */ public class ApiAnnotations implements IApiAnnotations { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiBaselineManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiBaselineManager.java index 18761e47bb..bef7f278d3 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiBaselineManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiBaselineManager.java @@ -67,7 +67,7 @@ import org.xml.sax.helpers.DefaultHandler; * baselines. This manager is lazy, in that caches are built and maintained when * requests are made for information, nothing is pre-loaded when the manager is * initialized. - * + * * @since 1.0.0 * @noinstantiate This class is not intended to be instantiated by clients. */ @@ -93,7 +93,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * The main cache for the manager. The form of the cache is: - * + * * <pre> * HashMap<String(baselineid), {@link IApiBaseline}> * </pre> @@ -144,7 +144,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Returns the singleton instance of the manager - * + * * @return the singleton instance of the manager */ public static synchronized ApiBaselineManager getManager() { @@ -207,7 +207,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Loads the infos for the given baseline from persisted storage (the * *.profile file) - * + * * @param baseline the given baseline * @throws CoreException if an exception occurs while loading baseline infos */ @@ -243,7 +243,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Initializes the baseline cache lazily. Only performs work if the current * cache has not been created yet - * + * * @throws FactoryConfigurationError * @throws ParserConfigurationException */ @@ -289,7 +289,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Persists all of the cached elements to individual xml files named with * the id of the API baseline - * + * * @throws IOException */ private void persistStateCache() throws CoreException, IOException { @@ -340,7 +340,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Writes out the current state of the {@link IApiBaseline} as XML to the * given output stream - * + * * @param stream * @throws CoreException */ @@ -357,7 +357,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Returns an XML description of the given baseline. - * + * * @param baseline the given API baseline * @return XML string representation of the given baseline * @throws CoreException if an exception occurs while retrieving the xml @@ -391,7 +391,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Throws a core exception with the given message and underlying exception, * if any. - * + * * @param message error message * @param e underlying exception or <code>null</code> * @throws CoreException @@ -402,7 +402,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Restore a baseline from the given input stream (persisted baseline). - * + * * @param baseline the given baseline to restore * @param stream the given input stream * @throws CoreException if unable to restore the baseline @@ -523,7 +523,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Returns if the given name is an existing baseline name - * + * * @param name * @return true if the given name is an existing baseline name, false * otherwise @@ -622,7 +622,7 @@ public final class ApiBaselineManager implements IApiBaselineManager, ISaveParti /** * Creates a workspace {@link IApiBaseline} - * + * * @return a new workspace {@link IApiBaseline} or <code>null</code> */ private IApiBaseline createWorkspaceBaseline() throws CoreException { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescription.java index 54e3bca485..a32f1e1cbb 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -46,7 +46,7 @@ import com.ibm.icu.text.MessageFormat; * <p> * Note, the implementation is not thread safe. * </p> - * + * * @see IApiDescription * @since 1.0.0 */ @@ -71,7 +71,7 @@ public class ApiDescription implements IApiDescription { /** * A comparator for {@link ManifestNode}s. Used while visiting child nodes * to give a somewhat predictable visit order - * + * * @since 1.0.600 */ static class NodeComparator implements Comparator<IElementDescriptor> { @@ -88,7 +88,7 @@ public class ApiDescription implements IApiDescription { /** * Default instance of the {@link NodeComparator} - * + * * @since 1.0.600 */ static NodeComparator fgComparator = new NodeComparator(); @@ -165,7 +165,7 @@ public class ApiDescription implements IApiDescription { * Returns if the given node has API visibility. If the given node has * {@link ApiDescription#VISIBILITY_INHERITED} visibility this method * recursively asks its' parent nodes if they have API visibility. - * + * * @param node * @return true if this node has API visibility false otherwise */ @@ -186,10 +186,10 @@ public class ApiDescription implements IApiDescription { /** * Ensure this node is up to date. Default implementation does nothing. * Subclasses should override as required. - * + * * Returns the resulting node if the node is valid, or <code>null</code> * if the node no longer exists. - * + * * @return up to date node, or <code>null</code> if no longer exists */ protected ManifestNode refresh() { @@ -201,7 +201,7 @@ public class ApiDescription implements IApiDescription { /** * Persists this node as a child of the given element. - * + * * @param document XML document * @param parentElement parent element in the document * @param component component the description is for or @@ -236,7 +236,7 @@ public class ApiDescription implements IApiDescription { /** * Adds visibility and restrictions to the XML element. - * + * * @param xmlElement XML element to annotate * @param component the component the description is for or * <code>null</code> @@ -250,7 +250,7 @@ public class ApiDescription implements IApiDescription { /** * This is a map of component names to a map of package names to package * node objects represented as: - * + * * <pre> * HashMap<IElementDescriptor(package), ManifestNode(package)> * </pre> @@ -260,7 +260,7 @@ public class ApiDescription implements IApiDescription { /** * This map holds the mapping of special access kinds for packages and has * the form: - * + * * <pre> * HashMap<IPackageDescriptor(package), HashMap<IElementDescriptor(component), IApiAccess>> * </pre> @@ -271,7 +271,7 @@ public class ApiDescription implements IApiDescription { /** * Constructs an API description owned by the specified component. - * + * * @param owningComponentId API component identifier or <code>null</code> if * there is no specific owner. */ @@ -286,7 +286,7 @@ public class ApiDescription implements IApiDescription { /** * Visits all children nodes in the given children map. - * + * * @param visitor visitor to visit * @param childrenMap map of element name to manifest nodes * @param monitor @@ -316,7 +316,7 @@ public class ApiDescription implements IApiDescription { /** * Compares the given version against the embedded version that has been * read from the API description - * + * * @param version * @return returns the same values as a compareTo call: * <ul> @@ -341,7 +341,7 @@ public class ApiDescription implements IApiDescription { * given version string cannot be parsed to a valid version, the embedded * version will default to the current version, as specified in * {@link IApiXmlConstants#API_DESCRIPTION_CURRENT_VERSION} - * + * * @param version the version to set on this description */ public void setEmbeddedVersion(String version) { @@ -354,7 +354,7 @@ public class ApiDescription implements IApiDescription { /** * Visits a node and its children. - * + * * @param visitor visitor to visit * @param node node to visit */ @@ -383,7 +383,7 @@ public class ApiDescription implements IApiDescription { * visibility and no restrictions if insert is <code>true</code> and a node * is not present. Default visibility for packages is API, and for types is * inherited. - * + * * @param element element * @param write <code>true</code> if setting a node, <code>false</code> if * getting a node @@ -458,7 +458,7 @@ public class ApiDescription implements IApiDescription { /** * Returns the visibility of the given node, walking up the tree if needed * to resolve inherited visibility. - * + * * @param node * @return visibility modifier */ @@ -474,7 +474,7 @@ public class ApiDescription implements IApiDescription { /** * Resolves annotations based on inheritance for the given node and element. - * + * * @param node manifest node * @param element the element annotations are being resolved for * @return annotations @@ -513,11 +513,11 @@ public class ApiDescription implements IApiDescription { /** * Creates and returns a new manifest node to be inserted into the tree or * <code>null</code> if the node does not exist. - * + * * <p> * Subclasses should override this method as required. * </p> - * + * * @param parentNode parent node * @param element element the node is to be created for * @return new manifest node or <code>null</code> if none @@ -618,7 +618,7 @@ public class ApiDescription implements IApiDescription { * Default implementation returns <code>false</code>. Subclasses should * override this method as required. * </p> - * + * * @param elementDescriptor * @return whether a new node should be inserted into the API description * when resolving the annotations for an element if a node is not @@ -637,7 +637,7 @@ public class ApiDescription implements IApiDescription { /** * Returns whether this description has been modified. - * + * * @return */ protected synchronized boolean isModified() { @@ -646,7 +646,7 @@ public class ApiDescription implements IApiDescription { /** * Sets the modification of api description - * + * * @param mod * @return */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionManager.java index 3d2c9ec3e1..ceb86b2c60 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionManager.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -56,7 +56,7 @@ import com.ibm.icu.text.MessageFormat; /** * Manages a cache of API descriptions for Java projects. Descriptions are * re-used between API components for the same project. - * + * * @since 1.0 */ public final class ApiDescriptionManager implements ISaveParticipant { @@ -95,7 +95,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Returns the singleton API description manager. - * + * * @return API description manager */ public synchronized static ApiDescriptionManager getManager() { @@ -108,10 +108,10 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Returns an API description for the given project component and connect it * to the given bundle description. - * + * * @param project Java project * @param bundle - * + * * @return API description */ public synchronized IApiDescription getApiDescription(ProjectComponent component, BundleDescription bundle) { @@ -136,7 +136,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Cleans the API description for the given project. - * + * * @param project * @param delete whether to delete the file on disk * @param remove whether to remove the cached API description @@ -165,7 +165,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Notifies the API description that the underlying project has changed. - * + * * @param project */ synchronized void projectChanged(IJavaProject project) { @@ -178,7 +178,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Notifies the API description that the underlying project classpath has * changed. - * + * * @param project */ synchronized void projectClasspathChanged(IJavaProject project) { @@ -190,7 +190,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Flushes the changed element from the model cache - * + * * @param element */ void flushElementCache(IJavaElement element) { @@ -252,7 +252,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Restores the API description from its saved file, if any and returns true * if successful. - * + * * @param project * @param description * @return whether the restore succeeded @@ -383,7 +383,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Returns an integer attribute. - * + * * @param element element with the integer * @param attr attribute name * @return attribute value as an integer @@ -399,7 +399,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Returns a long attribute. - * + * * @param element element with the long * @param attr attribute name * @return attribute value as an long @@ -417,7 +417,7 @@ public final class ApiDescriptionManager implements ISaveParticipant { /** * Throws an exception with the given message and underlying exception. - * + * * @param message error message * @param exception underlying exception, or <code>null</code> * @throws CoreException diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionProcessor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionProcessor.java index 1a1d021eb6..c6618ca872 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionProcessor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiDescriptionProcessor.java @@ -79,7 +79,7 @@ import org.w3c.dom.NodeList; /** * Provides tools for scanning/loading/parsing component.xml files. - * + * * @since 1.0.0 */ public class ApiDescriptionProcessor { @@ -117,7 +117,7 @@ public class ApiDescriptionProcessor { /** * Constructs a new visitor to collect tag updates in a java project. - * + * * @param jp project to update * @param cd project's API description * @param collector collection to place text edits into @@ -171,7 +171,7 @@ public class ApiDescriptionProcessor { /** * Adds a status to the current listing of messages - * + * * @param status */ private void addStatus(IStatus status) { @@ -184,7 +184,7 @@ public class ApiDescriptionProcessor { /** * Returns the status of processing the project. Status is OK if no * errors occurred. - * + * * @return status */ public IStatus getStatus() { @@ -208,7 +208,7 @@ public class ApiDescriptionProcessor { /** * Constructor - * + * * @param APIs a listing of {@link IElementDescriptor}s that we care * about for this visit */ @@ -237,7 +237,7 @@ public class ApiDescriptionProcessor { /** * Returns the kind of type being visited. - * + * * @return <code>TYPE_CLASS</code> or <code>TYPE_INTERFACE</code> */ private int getType() { @@ -267,7 +267,7 @@ public class ApiDescriptionProcessor { /** * Updates the specified javadoc node if needed, creates a new doc node * if one is not present - * + * * @param element the element to get API information from * @param docnode the doc node to update * @param type one of <code>CLASS</code> or <code>INTERFACE</code> @@ -306,7 +306,7 @@ public class ApiDescriptionProcessor { /** * Creates a new {@link TagElement} against the specified {@link AST} * and returns it - * + * * @param ast the {@link AST} to create the {@link TagElement} against * @param tagname the name of the new tag * @return a new {@link TagElement} with the given name @@ -320,7 +320,7 @@ public class ApiDescriptionProcessor { /** * Collects the missing javadoc tags from based on the given listing of * {@link TagElement}s - * + * * @param api * @param tags * @param type one of <code>CLASS</code> or <code>INTERFACE</code> @@ -385,7 +385,7 @@ public class ApiDescriptionProcessor { /** * Determines if the specified tag appears in the {@link TagElement} * listing given - * + * * @param tags * @param tag * @return true if the listing of {@link TagElement}s contains the given @@ -405,7 +405,7 @@ public class ApiDescriptionProcessor { /** * Finds the {@link IElementDescriptor} that matches the specified name * and signature - * + * * @param name * @param signature * @return the matching {@link IElementDescriptor} or <code>null</code> @@ -452,7 +452,7 @@ public class ApiDescriptionProcessor { * Parses a component XML into a string. The location may be a jar, * directory containing the component.xml file, or the component.xml file * itself - * + * * @param location root location of the component.xml file, or the * component.xml file itself * @return component XML as a string or <code>null</code> if none @@ -509,7 +509,7 @@ public class ApiDescriptionProcessor { * This method updates the javadoc for members of the specified java source * files with information retrieved from the the specified component.xml * file. - * + * * @param project the java project to update * @param componentxml the component.xml file to update from * @param collector @@ -532,7 +532,7 @@ public class ApiDescriptionProcessor { * Given the type, the parent type descriptor and an annotated description, * update the javadoc comments for the type and all members of the type * found in the description. - * + * * @param type * @param desc * @param description @@ -578,7 +578,7 @@ public class ApiDescriptionProcessor { /** * Throws an exception with the given message and underlying exception. - * + * * @param message error message * @param exception underlying exception, or <code>null</code> * @throws CoreException @@ -593,7 +593,7 @@ public class ApiDescriptionProcessor { * specified {@link IApiDescription} with {@link IPackageDescriptor}s, * {@link IReferenceTypeDescriptor}s, {@link IMethodDescriptor}s and * {@link IFieldDescriptor}s. - * + * * @param settings API settings to annotate * @param xml XML used to generate settings * @throws CoreException @@ -643,7 +643,7 @@ public class ApiDescriptionProcessor { * Annotates the backing {@link IApiDescription} from the given * {@link Element}, by adding the visibility and restriction attributes to * the specified {@link IElementDescriptor} - * + * * @param settings the settings to annotate * @param descriptor the current descriptor context * @param element the current element to annotate from @@ -660,7 +660,7 @@ public class ApiDescriptionProcessor { /** * Returns restriction settings described in the given element. - * + * * @param project the {@link IJavaProject} context * @param element XML element * @param descriptor the {@link IElementDescriptor} to get the restrictions @@ -730,7 +730,7 @@ public class ApiDescriptionProcessor { /** * Tests if the given restriction exists for the given element and returns * an updated restrictions flag. - * + * * @param element XML element * @param name attribute to test * @param flag bit mask for attribute @@ -750,7 +750,7 @@ public class ApiDescriptionProcessor { /** * Returns visibility settings described in the given element or -1 if none. - * + * * @param element XML element * @return visibility settings or -1 if none */ @@ -780,7 +780,7 @@ public class ApiDescriptionProcessor { * elements that are direct children of the specified {@link Element}. * {@link IFieldDescriptor}s are created as needed and added as children of * the specified {@link IReferenceTypeDescriptor}. - * + * * @param settings the {@link IApiDescription} to add the new * {@link IFieldDescriptor} to * @param typedesc the containing type descriptor for this field @@ -810,7 +810,7 @@ public class ApiDescriptionProcessor { * elements that are direct children of the specified {@link Element}. * {@link IMethodDescriptor}s are created as needed and added as children of * the specified {@link IReferenceTypeDescriptor}. - * + * * @param settings the {@link IApiDescription} to add the new * {@link IMethodDescriptor} to * @param typedesc the containing type descriptor for this method 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 5b6f2ab776..1d1f847c84 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 @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -32,7 +32,7 @@ import org.w3c.dom.Element; /** * {@link IApiDescription} visitor that generates XML for the given * {@link IApiComponent}. - * + * * @since 1.0.0 */ public class ApiDescriptionXmlCreator extends ApiDescriptionVisitor { @@ -69,7 +69,7 @@ public class ApiDescriptionXmlCreator extends ApiDescriptionVisitor { /** * Constructs a new visitor for the given component. - * + * * @param component API component * @throws CoreException if unable to construct the visitor */ @@ -79,10 +79,10 @@ public class ApiDescriptionXmlCreator extends ApiDescriptionVisitor { /** * Constructs a new visitor for the given component. - * + * * @param componentName the given component name * @param componentId the given component id - * + * * @throws CoreException if unable to construct the visitor */ public ApiDescriptionXmlCreator(String componentName, String componentId) throws CoreException { @@ -100,7 +100,7 @@ public class ApiDescriptionXmlCreator extends ApiDescriptionVisitor { /** * Annotates the attribute set of the specified {@link Element} - * + * * @param componentContext component context to which the API applies, or * <code>null</code> * @param description the description to annotate from @@ -140,7 +140,7 @@ public class ApiDescriptionXmlCreator extends ApiDescriptionVisitor { /** * Returns the settings as a UTF-8 string containing XML. - * + * * @return XML * @throws CoreException if something goes wrong */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiFilterStore.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiFilterStore.java index bfdc122423..8cc28b1807 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiFilterStore.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiFilterStore.java @@ -59,7 +59,7 @@ import org.w3c.dom.Element; * {@link org.eclipse.pde.api.tools.internal.provisional.IApiFilterStore} for * workspace projects. Filters can be added or removed and the changes persisted * to the api_filters XML file. - * + * * @since 1.0.0 */ public class ApiFilterStore extends FilterStore implements IResourceChangeListener { @@ -80,7 +80,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen /** * Constructor - * + * * @param owningComponent the id of the component that owns this filter * store */ @@ -92,7 +92,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen /** * Saves the .api_filters file for the component - * + * * @throws IOException */ public void persistApiFilters() { @@ -362,7 +362,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen /** * Converts the information contained in the given map to an XML string - * + * * @param filtermap the mapping of filters to convert to XML * @return an XML string representation of the given mapping of filters * @throws CoreException @@ -564,7 +564,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen /** * Callback hook to tell the filter store it needs to be saved on the next * cycle - * + * * @since 1.1 */ public void needsSaving() { @@ -617,7 +617,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen /** * records that the following filter has been used - * + * * @param resource * @param filter */ @@ -636,7 +636,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen /** * Returns all of the unused filters for this store at the moment in time * this method is called. - * + * * @param the resource the filter applies to * @param typeName the name of the type the filter appears on * @param categories the collection of {@link IApiProblem} categories to @@ -691,7 +691,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen * Collects the complete set of problem filters from the given set whose * underlying problem categories do not match any from the given array and * whose type name matches the underlying problem type name. - * + * * @param filters * @param typename * @param collector @@ -716,7 +716,7 @@ public class ApiFilterStore extends FilterStore implements IResourceChangeListen * Returns if the category of the given problem matches one of the * categories given in the collection. If the collection of categories is * <code>null</code> the problem does not match. - * + * * @param problem * @param categories * @return true if the given collection contains the given problems' diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiJavadocTag.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiJavadocTag.java index aece61697f..016d5a4c55 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiJavadocTag.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiJavadocTag.java @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.provisional.RestrictionModifiers; /** * Base API tools Javadoc tag implementation - * + * * @since 1.0.0 * @noextend This class is not intended to be subclassed by clients. * @noinstantiate This class is not intended to be instantiated by clients. @@ -51,7 +51,7 @@ public class ApiJavadocTag implements IApiJavadocTag { /** * Constructor - * + * * @param id the id of the tag * @param name the name of the tag (not including the '@' symbol) * @param rmodifier @@ -83,7 +83,7 @@ public class ApiJavadocTag implements IApiJavadocTag { /** * Returns the comment for the given type ad member - * + * * @param type * @param member * @return the comment for the tag @@ -149,7 +149,7 @@ public class ApiJavadocTag implements IApiJavadocTag { /** * Returns a key to use for tag when getting / setting comment related * attributes - * + * * @param type * @param member * @return a new key that can be used for map lookups diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiPluginPreferenceInitializer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiPluginPreferenceInitializer.java index 141ee53f2a..636b7c367a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiPluginPreferenceInitializer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ApiPluginPreferenceInitializer.java @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Initializes all of the core preferences for the {@link ApiPlugin} - * + * * @since 1.0.0 */ public class ApiPluginPreferenceInitializer extends AbstractPreferenceInitializer { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/BundleVersionRange.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/BundleVersionRange.java index 2178a6d9d1..c04e0f2914 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/BundleVersionRange.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/BundleVersionRange.java @@ -16,7 +16,7 @@ import org.osgi.framework.Version; /** * Implementation of a required component description based on OSGi bundles. - * + * * @since 1.0.0 */ public class BundleVersionRange implements IVersionRange { @@ -26,7 +26,7 @@ public class BundleVersionRange implements IVersionRange { /** * Constructs a new version range based on the given required bundle version * interval. - * + * * @param versionInterval string representing mathematical interval * describing range of compatible versions */ @@ -36,7 +36,7 @@ public class BundleVersionRange implements IVersionRange { /** * Constructs a new version range based on the given range. - * + * * @param range version range */ public BundleVersionRange(VersionRange range) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompilationUnit.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompilationUnit.java index 114d50b4da..cde669bc20 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompilationUnit.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompilationUnit.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -26,7 +26,7 @@ import org.eclipse.jdt.core.ICompilationUnit; * A compilation unit in the API context acts as a proxy to the stream of file * contents. It holds meta-data about the underlying file, but does not hold on * to the actual contents of the file. - * + * * @since 1.0.0 */ public class CompilationUnit { @@ -36,14 +36,14 @@ public class CompilationUnit { private ICompilationUnit unit = null; /** * The encoding to use when reading the compilation units' contents - * + * * @since 1.0.600 */ private String encoding = null; /** * The full path to the file Constructor - * + * * @param filepath the absolute path to the file. If the path points to a * file that does not exist an {@link IllegalArgumentException} * is thrown @@ -61,7 +61,7 @@ public class CompilationUnit { /** * Constructor for use within the workspace - * + * * @param compilationUnit the {@link ICompilationUnit} backing this * {@link CompilationUnit} */ @@ -82,7 +82,7 @@ public class CompilationUnit { * If there is no backing {@link ICompilationUnit}, for example when created * from one of the Ant tasks, we simply use the system encoding if the * encoding has not already been set. - * + * * @param base * @return the encoding to use for this {@link CompilationUnit} * @since 1.0.600 @@ -122,7 +122,7 @@ public class CompilationUnit { /** * Returns the input stream of the file - * + * * @return the input stream of the files' contents * @throws FileNotFoundException if the input stream could not connect to * the actual file @@ -140,7 +140,7 @@ public class CompilationUnit { /** * Returns the encoding for this compilation unit. - * + * * @return the encoding to use * @throws CoreException * @since 1.0.600 diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompositeApiDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompositeApiDescription.java index 8ce9327c91..256e4476ab 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompositeApiDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CompositeApiDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IPackageDescri /** * A host API description combines descriptions of a host and all its fragments. - * + * * @since 1.0 */ public class CompositeApiDescription implements IApiDescription { @@ -31,7 +31,7 @@ public class CompositeApiDescription implements IApiDescription { /** * Constructs a composite API description out of the given descriptions. - * + * * @param descriptions */ public CompositeApiDescription(IApiDescription[] descriptions) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CoreMessages.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CoreMessages.java index 7c84ba7704..363eec3083 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CoreMessages.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/CoreMessages.java @@ -13,7 +13,7 @@ package org.eclipse.pde.api.tools.internal; import org.eclipse.osgi.util.NLS; /** - * + * */ public class CoreMessages extends NLS { private static final String BUNDLE_NAME = "org.eclipse.pde.api.tools.internal.coremessages"; //$NON-NLS-1$ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/FilterStore.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/FilterStore.java index 5e4337cdc5..4f062d0c52 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/FilterStore.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/FilterStore.java @@ -73,7 +73,7 @@ public class FilterStore implements IApiFilterStore { /** * Constructor - * + * * @param component */ public FilterStore(BundleComponent component) { @@ -199,7 +199,7 @@ public class FilterStore implements IApiFilterStore { /** * Returns <code>true</code> if the attributes of the problems match, * <code>false</code> otherwise - * + * * @param filterProblem the problem from the filter store * @param problem the problem from the builder * @return <code>true</code> if the problems match, <code>false</code> @@ -238,7 +238,7 @@ public class FilterStore implements IApiFilterStore { * <li>both are the same length</li> * <li>both have equal elements at equal positions in the array</li> * </ul> - * + * * @param problemMessageArguments * @param filterProblemMessageArguments * @return <code>true</code> if the arrays are equal, <code>false</code> @@ -293,7 +293,7 @@ public class FilterStore implements IApiFilterStore { * Reads the API problem filter file and calls back to * {@link #addFilters(IApiProblemFilter[])} to store the filters. <br> * This method will not close the given input stream when done reading it. - * + * * @param contents the {@link InputStream} for the contents of the filter * file, <code>null</code> is not allowed. * @throws IOException if the stream cannot be read or fails @@ -381,7 +381,7 @@ public class FilterStore implements IApiFilterStore { /** * Internal use method that allows auto-persisting of the filter file to be * turned on or off - * + * * @param problems the problems to add the the store * @param persist if the filters should be auto-persisted after they are * added @@ -408,7 +408,7 @@ public class FilterStore implements IApiFilterStore { /** * Loads the specified integer attribute from the given XML element - * + * * @param element the XML element * @param name the name of the attribute * @return the specified value in XML or -1 diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiCoreConstants.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiCoreConstants.java index a8a9bd9cee..45e7ded08c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiCoreConstants.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiCoreConstants.java @@ -14,7 +14,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline; /** * Constants used by API tools core plugin - * + * * @since 1.0.0 */ public interface IApiCoreConstants { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiXmlConstants.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiXmlConstants.java index 145001d143..c3d4a977f0 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiXmlConstants.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/IApiXmlConstants.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem; /** * Interface containing all of the constants used in XML documents in API Tools - * + * * @since 1.0.0 */ public interface IApiXmlConstants { @@ -49,7 +49,7 @@ public interface IApiXmlConstants { /** * Constant representing the element attribute for a comment. value is: * <code>comment</code> - * + * * @since 1.1 */ public static final String ATTR_COMMENT = "comment"; //$NON-NLS-1$ @@ -296,7 +296,7 @@ public interface IApiXmlConstants { * Constant representing a package fragment element node in XML. Value is: * <code>package</code> */ - public static final String ELEMENT_PACKAGE_FRAGMENT = "fragment"; //$NON-NLS-1$ + public static final String ELEMENT_PACKAGE_FRAGMENT = "fragment"; //$NON-NLS-1$ /** * Constant representing a plugin element node in XML. Value is: * <code>plugin</code> @@ -306,7 +306,7 @@ public interface IApiXmlConstants { * Constant representing the API component pool node name for an API profile * XML file. Value is <code>pool</code> */ - public static final String ELEMENT_POOL = "pool"; //$NON-NLS-1$ + public static final String ELEMENT_POOL = "pool"; //$NON-NLS-1$ /** * Constant representing a resource element node in XML. Value is: * <code>resource</code> diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/JavadocTagManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/JavadocTagManager.java index dcca466a78..fd8aefc6f0 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/JavadocTagManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/JavadocTagManager.java @@ -24,14 +24,14 @@ import org.eclipse.pde.api.tools.internal.provisional.RestrictionModifiers; /** * Manages contributed javadoc tags. This manager is lazy, in that nothing is * loaded until it is asked for. - * + * * @since 1.0.0 */ public final class JavadocTagManager { /** * Compound key for the annotation cache - * + * * @since 1.0.600 */ class Key { @@ -62,7 +62,7 @@ public final class JavadocTagManager { * Constant for the <code>noinsantiate</code> tag <br> * <br> * Value is: <code>@noinstantiate</code> - * + * * @since 1.0.500 */ public static final String TAG_NOINSTANTIATE = "@noinstantiate"; //$NON-NLS-1$ @@ -70,7 +70,7 @@ public final class JavadocTagManager { * Constant for the <code>@NoInstantiate</code> annotation <br> * <br> * Value is: <code>NoInstantiate</code> - * + * * @since 1.0.600 */ public static final String ANNOTATION_NOINSTANTIATE = "NoInstantiate"; //$NON-NLS-1$ @@ -78,7 +78,7 @@ public final class JavadocTagManager { * Constant for the <code>noextend</code> tag <br> * <br> * Value is: <code>@noextend</code> - * + * * @since 1.0.500 */ public static final String TAG_NOEXTEND = "@noextend"; //$NON-NLS-1$ @@ -86,7 +86,7 @@ public final class JavadocTagManager { * Constant for the <code>@NoExtend</code> annotation <br> * <br> * Value is: <code>NoExtend</code> - * + * * @since 1.0.600 */ public static final String ANNOTATION_NOEXTEND = "NoExtend"; //$NON-NLS-1$ @@ -94,7 +94,7 @@ public final class JavadocTagManager { * Constant for the <code>noimplement</code> tag <br> * <br> * Value is: <code>@noimplement</code> - * + * * @since 1.0.500 */ public static final String TAG_NOIMPLEMENT = "@noimplement"; //$NON-NLS-1$ @@ -102,7 +102,7 @@ public final class JavadocTagManager { * Constant for the <code>@NoImplement</code> annotation <br> * <br> * Value is: <code>NoImplement</code> - * + * * @since 1.0.600 */ public static final String ANNOTATION_NOIMPLEMENT = "NoImplement"; //$NON-NLS-1$ @@ -110,7 +110,7 @@ public final class JavadocTagManager { * Constant for the <code>nooverride</code> tag <br> * <br> * Value is: <code>@nooverride</code> - * + * * @since 1.0.500 */ public static final String TAG_NOOVERRIDE = "@nooverride"; //$NON-NLS-1$ @@ -118,7 +118,7 @@ public final class JavadocTagManager { * Constant for the <code>@NoOverride</code> annotation <br> * <br> * Value is: <code>NoOverride</code> - * + * * @since 1.0.600 */ public static final String ANNOTATION_NOOVERRIDE = "NoOverride"; //$NON-NLS-1$ @@ -126,7 +126,7 @@ public final class JavadocTagManager { * Constant for the <code>noreference</code> tag <br> * <br> * Value is: <code>@noreference</code> - * + * * @since 1.0.500 */ public static final String TAG_NOREFERENCE = "@noreference"; //$NON-NLS-1$ @@ -134,14 +134,14 @@ public final class JavadocTagManager { * Constant for the <code>@NoReference</code> annotation <br> * <br> * Value is: <code>NoReference</code> - * + * * @since 1.0.600 */ public static final String ANNOTATION_NOREFERENCE = "NoReference"; //$NON-NLS-1$ /** * The collection of all tags - * + * * @see #TAG_NOEXTEND * @see #TAG_NOIMPLEMENT * @see #TAG_NOINSTANTIATE @@ -152,20 +152,20 @@ public final class JavadocTagManager { /** * The collection of all annotation names - * + * * @see #ANNOTATION_NOEXTEND * @see #ANNOTATION_NOIMPLEMENT * @see #ANNOTATION_NOINSTANTIATE * @see #ANNOTATION_NOOVERRIDE * @see #ANNOTATION_NOREFERENCE - * + * * @sine 1.0.600 */ public static final Set<String> ALL_ANNOTATIONS; /** * Cache for simple annotation names mapped to their fully qualified name - * + * * @since 1.0.600 */ private static final HashMap<String, String> fqAnnotationNames; @@ -202,7 +202,7 @@ public final class JavadocTagManager { /** * Cache of annotations keyed by the member the apply to - * + * * @since 1.0.600 */ private HashMap<Key, Set<String>> fAnnotationCache = null; @@ -214,7 +214,7 @@ public final class JavadocTagManager { /** * Initialize the annotation mapping - * + * * @since 1.0.600 */ private void initializeAnnotations() { @@ -311,7 +311,7 @@ public final class JavadocTagManager { * Returns all of the java doc tags for a given kind of type and member. See * {@link IApiJavadocTag} for a complete listing of tag Java type and member * types. - * + * * @param type one of <code>CLASS</code> or <code>INTERFACE</code> * @param member one of <code>METHOD</code> or <code>FIELD</code> or * <code>NONE</code> @@ -331,7 +331,7 @@ public final class JavadocTagManager { /** * Returns the set of supported annotations for the given type and member - * + * * @param type the type kind * @param member the member kind * @return the set of supported annotations or an empty set, never @@ -354,11 +354,11 @@ public final class JavadocTagManager { * <br> * Example: <code>NoExtend</code> returns * <code>org.eclipse.pde.api.toools.annnotations.NoExtend</code> - * + * * @param typename * @return the fully qualified type name of the annotation or * <code>null</code> if unknown - * + * * @since 1.0.600 */ public synchronized String getQualifiedNameForAnnotation(String typename) { @@ -368,7 +368,7 @@ public final class JavadocTagManager { /** * Returns the {@link IApiJavadocTag} that has the given id or * <code>null</code> if there is no tag with the given id - * + * * @param id the id of the tag to fetch * @return the {@link IApiJavadocTag} with the given id or <code>null</code> */ @@ -380,7 +380,7 @@ public final class JavadocTagManager { /** * Returns the complete listing of {@link IApiJavadocTag}s contained in the * manager or an empty array, never <code>null</code> - * + * * @return the complete listing of tags in the manager or <code>null</code> */ public synchronized IApiJavadocTag[] getAllTags() { @@ -409,7 +409,7 @@ public final class JavadocTagManager { * Returns the restriction modifier set on the javadoc tag with the given * name. If the manager has no entry for the specified tag name * <code>-1</code> is returned. - * + * * @param tagname the name of the tag * @param type one of <code>CLASS</code> or <code>INTERFACE</code> * @param member one of <code>METHOD</code> or <code>FIELD</code> or diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/NonApiProjectDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/NonApiProjectDescription.java index 43aaaedee2..7b08d1597f 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/NonApiProjectDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/NonApiProjectDescription.java @@ -16,14 +16,14 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri /** * An API description for a project that does not have an API Tools nature. * Keeps track of package visibility. - * + * * @since 1.1 */ public class NonApiProjectDescription extends ProjectApiDescription { /** * Constructs API description for the given project. - * + * * @param project */ public NonApiProjectDescription(IJavaProject project) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ProjectApiDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ProjectApiDescription.java index 9ab976b8cd..1229c01f26 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ProjectApiDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/ProjectApiDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -54,7 +54,7 @@ import org.w3c.dom.Element; /** * Implementation of an API description for a Java project. - * + * * @since 1.0 */ public class ProjectApiDescription extends ApiDescription { @@ -96,7 +96,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Constructs a new node. - * + * * @param parent * @param element * @param visibility @@ -169,7 +169,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Constructs a node for a reference type. - * + * * @param type * @param parent * @param element @@ -324,7 +324,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Constructs a new API description for the given project API component. - * + * * @param component */ public ProjectApiDescription(IJavaProject project) { @@ -384,7 +384,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Visits a type. - * + * * @param visitor * @param owningComponent * @param type @@ -507,7 +507,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Constructs and returns a new node for the given package fragment. - * + * * @param fragment * @param parent * @param descriptor @@ -521,7 +521,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Constructs and returns a new node for the given type. - * + * * @param type * @param parent * @param descriptor @@ -535,7 +535,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Constructs a new manifest node. - * + * * @param parent * @param element * @param vis @@ -606,7 +606,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Returns the Java project associated with this component. - * + * * @return associated Java project */ private IJavaProject getJavaProject() { @@ -615,7 +615,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Returns a class file container for the given package fragment root. - * + * * @param root package fragment root * @return class file container * @exception CoreException if container cannot be located @@ -630,7 +630,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Returns all package fragments that originate from this project. - * + * * @return all package fragments that originate from this project */ private IPackageFragment[] getLocalPackageFragments() { @@ -657,7 +657,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Returns this API description as XML. - * + * * @throws CoreException */ public synchronized String getXML() throws CoreException { @@ -674,7 +674,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Persists the elements in the given map as XML elements, appended to the * given xmlElement. - * + * * @param document XML document * @param xmlElement node to append children no * @param elementMap elements to persist @@ -725,7 +725,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Returns the API component associated with this API description - * + * * @return API component * @exception CoreException if the API component cannot be located */ @@ -740,7 +740,7 @@ public class ProjectApiDescription extends ApiDescription { /** * Resolves annotations based on inheritance for the given node and element. - * + * * @param node manifest node * @param element the element annotations are being resolved for * @return annotations diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/RequiredComponentDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/RequiredComponentDescription.java index 635bff4c9c..698f58f14c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/RequiredComponentDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/RequiredComponentDescription.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.provisional.IVersionRange; /** * Implementation of a required component description based on OSGi bundles. - * + * * @since 1.0.0 */ public class RequiredComponentDescription implements IRequiredComponentDescription { @@ -29,7 +29,7 @@ public class RequiredComponentDescription implements IRequiredComponentDescripti * Constructs a new required component description based on the given * required component id and version range. The required component * description is mandatory. - * + * * @param id component's symbolic name * @param range version range */ @@ -40,7 +40,7 @@ public class RequiredComponentDescription implements IRequiredComponentDescripti /** * Constructs a new required component description based on the given * required component id and version range. - * + * * @param id component's symbolic name * @param range version range * @param isOptional the optional flag of the required component @@ -70,7 +70,7 @@ public class RequiredComponentDescription implements IRequiredComponentDescripti /** * (non-Javadoc) - * + * * @see IRequiredComponentDescription#getVersionRange() */ @Override diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/SystemApiDescriptionProcessor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/SystemApiDescriptionProcessor.java index 32d80a4b56..5117bba42d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/SystemApiDescriptionProcessor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/SystemApiDescriptionProcessor.java @@ -39,7 +39,7 @@ import org.w3c.dom.NodeList; /** * Provides tools for scanning/loading/parsing component.xml files. - * + * * @since 1.0.0 */ public class SystemApiDescriptionProcessor { @@ -53,7 +53,7 @@ public class SystemApiDescriptionProcessor { * Parses a component XML into a string. The location may be a jar, * directory containing the component.xml file, or the component.xml file * itself - * + * * @param location root location of the component.xml file, or the * component.xml file itself * @return component XML as a string or <code>null</code> if none @@ -108,7 +108,7 @@ public class SystemApiDescriptionProcessor { /** * Throws an exception with the given message and underlying exception. - * + * * @param message error message * @param exception underlying exception, or <code>null</code> * @throws CoreException @@ -123,7 +123,7 @@ public class SystemApiDescriptionProcessor { * specified {@link IApiDescription} with {@link IPackageDescriptor}s, * {@link IReferenceTypeDescriptor}s, {@link IMethodDescriptor}s and * {@link IFieldDescriptor}s. - * + * * @param settings API settings to annotate * @param xml XML used to generate settings * @throws CoreException @@ -167,7 +167,7 @@ public class SystemApiDescriptionProcessor { * Annotates the backing {@link IApiDescription} from the given * {@link Element}, by adding the visibility and restriction attributes to * the specified {@link IElementDescriptor} - * + * * @param settings the settings to annotate * @param descriptor the current descriptor context * @param element the current element to annotate from @@ -185,7 +185,7 @@ public class SystemApiDescriptionProcessor { /** * Tests if the given restriction exists for the given element and returns * an updated restrictions flag. - * + * * @param element XML element * @param name attribute to test * @param flag bit mask for attribute @@ -203,7 +203,7 @@ public class SystemApiDescriptionProcessor { /** * Tests if the given restriction exists for the given element and returns * an updated restrictions flag. - * + * * @param element XML element * @param name attribute to test * @param flag bit mask for attribute @@ -221,7 +221,7 @@ public class SystemApiDescriptionProcessor { /** * Tests if the given restriction exists for the given element and returns * an updated restrictions flag. - * + * * @param element XML element * @param name attribute to test * @param flag bit mask for attribute @@ -241,7 +241,7 @@ public class SystemApiDescriptionProcessor { * elements that are direct children of the specified {@link Element}. * {@link IFieldDescriptor}s are created as needed and added as children of * the specified {@link IReferenceTypeDescriptor}. - * + * * @param settings the {@link IApiDescription} to add the new * {@link IFieldDescriptor} to * @param typedesc the containing type descriptor for this field @@ -269,7 +269,7 @@ public class SystemApiDescriptionProcessor { * elements that are direct children of the specified {@link Element}. * {@link IMethodDescriptor}s are created as needed and added as children of * the specified {@link IReferenceTypeDescriptor}. - * + * * @param settings the {@link IApiDescription} to add the new * {@link IMethodDescriptor} to * @param typedesc the containing type descriptor for this method diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/WorkspaceDeltaProcessor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/WorkspaceDeltaProcessor.java index 231ea9248a..f06e4ed499 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/WorkspaceDeltaProcessor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/WorkspaceDeltaProcessor.java @@ -36,7 +36,7 @@ import org.eclipse.jdt.core.JavaCore; /** * Standard delta processor for us to track element state changes in the workspace * using {@link IJavaElementDelta}s and {@link IResourceDelta}s. - * + * * @since 1.1 */ public class WorkspaceDeltaProcessor implements IElementChangedListener, IResourceChangeListener { @@ -51,7 +51,7 @@ public class WorkspaceDeltaProcessor implements IElementChangedListener, IResour /** * Processes the java element deltas of interest - * + * * @param deltas */ void processJavaElementDeltas(IJavaElementDelta[] deltas, IJavaProject project) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalMethodReference.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalMethodReference.java index 2aa86e7941..1f92f956c6 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalMethodReference.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalMethodReference.java @@ -25,7 +25,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem; /** * Abstract implementation for illegal method references i.e. method calls, * constructor invocation, etc - * + * * @since 1.1 */ public abstract class AbstractIllegalMethodReference extends AbstractProblemDetector { @@ -45,7 +45,7 @@ public abstract class AbstractIllegalMethodReference extends AbstractProblemDete /** * Adds the given type as not to be extended. - * + * * @param type a type that is marked no extend * @param componentId the component the type is located in */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalTypeReference.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalTypeReference.java index a1d13f6bc4..5dc841f50d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalTypeReference.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractIllegalTypeReference.java @@ -35,7 +35,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; /** * Base implementation of a problem detector for type references - * + * * @since 1.1 * @noextend This class is not intended to be sub-classed by clients. */ @@ -49,7 +49,7 @@ public abstract class AbstractIllegalTypeReference extends AbstractProblemDetect /** * Adds the given type as not to be extended. - * + * * @param type a type that is marked no extend * @param componentId the component the type is located in */ @@ -68,7 +68,7 @@ public abstract class AbstractIllegalTypeReference extends AbstractProblemDetect /** * Returns if the mapping contains the referenced type name - * + * * @param reference * @return true of the mapping contains the key false otherwise */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractLeakProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractLeakProblemDetector.java index 926b0ec15c..c7bc422cab 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractLeakProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractLeakProblemDetector.java @@ -23,7 +23,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; /** * Leak detectors keep track of all pre-requisite non-API package names to weed * out public references. - * + * * @since 1.1 * @noextend This class is not intended to be sub-classed by clients. */ @@ -37,7 +37,7 @@ public abstract class AbstractLeakProblemDetector extends AbstractProblemDetecto /** * Returns whether the referenced type name matches a non-API package. - * + * * @param reference * @return whether the referenced type name matches a non-API package */ @@ -63,7 +63,7 @@ public abstract class AbstractLeakProblemDetector extends AbstractProblemDetecto /** * Returns whether all enclosing types of the given member are visible. - * + * * @param member member * @return whether all enclosing types of the given member are visible * @throws CoreException 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 c9fc6be731..4620c8d767 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 @@ -135,7 +135,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Retains the reference for further analysis. - * + * * @param reference reference */ protected void retainReference(IReference reference) { @@ -144,7 +144,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Return the list of retained references. - * + * * @return references */ protected List<IReference> getRetainedReferences() { @@ -158,7 +158,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Creates a problem for a specific reference in the workspace - * + * * @param reference reference * @param associated java project (with reference source location) * @return problem or <code>null</code> if none @@ -266,7 +266,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the source range to include in the associated problem or * <code>null</code> if a valid source range could not be computed. - * + * * @param type resolved type where the reference occurs * @param doc source document of the type * @param reference associated reference @@ -276,14 +276,14 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the element type the problem is reported on. - * + * * @return */ protected abstract int getElementType(IReference reference); /** * Returns problem flags, if any. - * + * * @param reference * @return problem flags */ @@ -291,35 +291,35 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns problem message arguments - * + * * @return message arguments */ protected abstract String[] getMessageArgs(IReference reference) throws CoreException; /** * Returns problem message arguments to be used in headless build - * + * * @return message arguments */ protected abstract String[] getQualifiedMessageArgs(IReference reference) throws CoreException; /** * Returns the kind of problem to create - * + * * @return problem kind */ protected abstract int getProblemKind(); /** * Returns the key used to lookup problem severity. - * + * * @return problem severity key */ protected abstract String getSeverityKey(); /** * Returns the fully qualified type name associated with the given member. - * + * * @param member * @return fully qualified type name */ @@ -343,7 +343,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the qualified type name to display. This method delegates to the * {@link Signatures} class to build the display signatures - * + * * @param member * @return fully qualified display signature for the given {@link IApiType} * or enclosing type if the member is not a type itself @@ -373,7 +373,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the unqualified type name associated with the given member. - * + * * @param member * @return unqualified type name */ @@ -403,7 +403,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { * {@link Position} for the name of the given {@link IType}. Returns * <code>null</code> in the event the given {@link IType} is * <code>null</code> or the name range cannot be computed for the type. - * + * * @param type the type * @param reference the reference * @throws CoreException @@ -424,16 +424,16 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { * Finds the method name to select on the given line of code starting from * the given index. This method will recurse to find a method name in the * even there is a name clash with the type. For example: - * + * * <pre> * MyType type = new MyType(); * </pre> - * + * * If we are trying to find the constructor method call we have a name * collision (and the first occurrence of MyType would be selected). <br> * A name is determined to be a method name if it is followed by a '(' * character (excluding spaces) - * + * * @param namepart * @param line * @param index @@ -527,7 +527,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns whether the resolved reference is a real problem. - * + * * @param reference * @return whether a problem */ @@ -570,7 +570,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Tries to find the given {@link IApiMethod} in the given {@link IType}. If * a matching method is not found <code>null</code> is returned - * + * * @param type the type top look in for the given {@link IApiMethod} * @param method the {@link IApiMethod} to look for * @return the {@link IMethod} from the given {@link IType} that matches the @@ -611,7 +611,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Tries to find the given {@link IApiField} in the given {@link IType}. If * the field cannot be found <code>null</code> is returned - * + * * @param type * @param field * @return the {@link IField} matching the given {@link IApiField} or @@ -638,7 +638,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Tries to find the given {@link IApiType} in the given {@link IType}. If * no match is found <code>null</code> is returned. - * + * * @param type * @param apitype * @param reference @@ -678,7 +678,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the enclosing {@link IMethod} for the given type or * <code>null</code> if it cannot be computed - * + * * @param type * @param jtype * @param reference @@ -740,7 +740,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Performs a quick look-up using the offset into the the * {@link ICompilationUnit} - * + * * @param jtype * @param document * @param reference @@ -764,7 +764,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the source range for the given {@link IApiMethod} within the * given {@link IType} - * + * * @param type the type to look for the method within * @param reference the reference the method comes from * @param method the {@link IApiMethod} to look for the source range for @@ -791,7 +791,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns the source range to use for the given field within the given * {@link IType} - * + * * @param type the type to look in for the given {@link IApiField} * @param reference the reference the field is involved in * @param field the field to find the range for @@ -826,7 +826,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { * <li>Try looking for pattern '*.variable'</li> * <li>Else select the entire line optimistically</li> * </ol> - * + * * @param field the field to find the name range for * @param document the document to look within * @param reference the reference the field is from @@ -889,7 +889,7 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Searches for the name of a method at the line number specified in the * given reference. - * + * * @param name method name * @param document document to search in * @param reference provides line number @@ -965,12 +965,12 @@ public abstract class AbstractProblemDetector implements IApiProblemDetector { /** * Returns if the signature is enclosed by the one of the elements of the * given set of type names. - * + * * @param signature the signature of the element * @param typenames the Set of {@link String}s of type names * @return <code>true</code> if the given set contains a type name that * encloses the given signature, <code>false</code> otherwise - * + * * @since 1.0.400 */ boolean isEnclosedBy(String signature, Set<String> typenames) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractTypeLeakDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractTypeLeakDetector.java index 8af1ac1e37..5425863802 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractTypeLeakDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/AbstractTypeLeakDetector.java @@ -33,7 +33,7 @@ import com.ibm.icu.text.MessageFormat; /** * Detects leaked types. - * + * * @since 1.1 */ public abstract class AbstractTypeLeakDetector extends AbstractLeakProblemDetector { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ApiAnalysisBuilder.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ApiAnalysisBuilder.java index d82c30ef78..cdc499cbda 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ApiAnalysisBuilder.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ApiAnalysisBuilder.java @@ -76,13 +76,13 @@ import com.ibm.icu.text.MessageFormat; /** * Builder for creating API Tools resource markers - * + * * @since 1.0.0 */ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Project relative path to the .settings folder - * + * * @since 1.0.1 */ static final IPath SETTINGS_PATH = new Path(".settings"); //$NON-NLS-1$ @@ -99,7 +99,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * {@link Comparator} to sort {@link ManifestElement}s - * + * * @since 1.0.3 */ static final Comparator<ManifestElement> fgManifestElementComparator = (o1, o2) -> o1.getValue().compareTo(o2.getValue()); @@ -107,7 +107,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Array of header names that we care about when a manifest delta is * discovered - * + * * @since 1.0.3 */ public static final HashSet<String> IMPORTANT_HEADERS = new HashSet<>(7); @@ -174,7 +174,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Cleans up markers associated with API Tools on the given resource. - * + * * @param resource */ void cleanupMarkers(IResource resource) { @@ -189,7 +189,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Cleans up API use scan breakage related markers on the specified resource - * + * * @param resource */ void cleanApiUseScanMarkers(IResource resource) { @@ -220,7 +220,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Cleans up unsupported Javadoc tag markers on the specified resource - * + * * @param resource */ void cleanupUnsupportedTagMarkers(IResource resource) { @@ -239,7 +239,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Removes all of the unsupported annotation markers from the given resource * and all of its children - * + * * @param resource * @since 1.0.600 */ @@ -258,7 +258,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Cleans up only API compatibility markers on the given {@link IResource} - * + * * @param resource the given resource */ void cleanupCompatibilityMarkers(IResource resource) { @@ -280,7 +280,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * cleans up only API usage markers from the given {@link IResource} - * + * * @param resource */ void cleanupUsageMarkers(IResource resource) { @@ -301,7 +301,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * cleans up only fatal problem markers from the given {@link IResource} - * + * * @param resource */ void cleanupFatalMarkers(IResource resource) { @@ -316,7 +316,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Cleans up the unused API filter problems from the given resource - * + * * @param resource */ void cleanUnusedFilterMarkers(IResource resource) { @@ -505,7 +505,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns if the backing project should be fully built, based on the delta - * + * * @param delta the {@link IResourceDelta} to examine * @return <code>true</code> if the project should have a full build, * <code>false</code> otherwise @@ -537,7 +537,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { * Compares the current <code>MANIFEST.MF</code> against the saved state. If * the {@link BuildState} is <code>null</code> or there is no saved state * for the current project context a full build is assumed. - * + * * @param manifest the handle to the <code>MANIFEST.MF</code> file * @param state the current {@link BuildState} or <code>null</code> * @return <code>true</code> if there are changes that require a full build, @@ -614,7 +614,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { * Compares the current <code>build.properties</code> against the saved one. * If the given {@link BuildState} is <code>null</code> or there is no saved * state for the current project context a full build is assumed. - * + * * @param state the current {@link BuildState} or <code>null</code> * @return <code>true</code> if there are changes that require a full build, * <code>false</code> otherwise @@ -661,7 +661,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { * <li>The project has fatal JDT errors that prevent the creation of class * files</li> * </ul> - * + * * @param project * @return true if the builder should abort building the given project, * false otherwise @@ -677,7 +677,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns if the project we are about to build has fatal JDT problems that * prevent class files from being built - * + * * @param project * @return true if the given project has fatal JDT problems * @see @@ -699,7 +699,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * if its worth doing a full build considering the given set if projects - * + * * @param projects projects to check the build state for * @return true if a full build should take place, false otherwise */ @@ -721,7 +721,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Performs a full build for the project - * + * * @param baseline the default baseline * @param wbaseline the workspace baseline * @param monitor @@ -788,7 +788,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns the {@link IApiMarkerConstants} problem type given the problem * category - * + * * @param category the problem category - see {@link IApiProblem} for * problem categories * @param kind the kind of the problem - see {@link IApiProblem} for problem @@ -836,7 +836,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Creates an {@link IMarker} on the resource specified in the problem (via * its path) with the given problem attributes - * + * * @param category the category of the problem - see {@link IApiProblem} for * categories * @param type the marker type to create - see {@link IApiMarkerConstants} @@ -916,7 +916,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { * null)</li> * <li>The resource is not accessible (isAccessible() returns false</li> * </ul> - * + * * @param problem the problem to get the resource for * @return the resource or <code>null</code> */ @@ -948,7 +948,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Creates a single string attribute from an array of strings. Uses the '#' * char as a delimiter - * + * * @param args * @return a single string attribute from an array or arguments */ @@ -986,7 +986,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Cleans the .api_settings file for the given project - * + * * @param project */ void cleanupApiDescription(IProject project) { @@ -1021,7 +1021,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns a listing of deltas for this project and for dependent projects - * + * * @param projects * @return */ @@ -1051,7 +1051,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns the API analyzer to use with this instance of the builder - * + * * @return the API analyzer to use */ protected synchronized IApiAnalyzer getAnalyzer() { @@ -1064,7 +1064,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns the complete listing of required projects from the classpath of * the backing project - * + * * @param includeBinaryPrerequisites * @return the list of projects required * @throws CoreException @@ -1169,7 +1169,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns the output paths of the given project or <code>null</code> if * none have been computed - * + * * @param project * @return the output paths for the given project or <code>null</code> */ @@ -1179,7 +1179,7 @@ public class ApiAnalysisBuilder extends IncrementalProjectBuilder { /** * Returns is the given classpath entry is optional or not - * + * * @param entry * @return true if the specified {@link IClasspathEntry} is optional, false * otherwise diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BaseApiAnalyzer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BaseApiAnalyzer.java index ba4c4dd3ba..b3d45a204e 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BaseApiAnalyzer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BaseApiAnalyzer.java @@ -111,7 +111,7 @@ import com.ibm.icu.text.MessageFormat; /** * Base implementation of the analyzer used in the {@link ApiAnalysisBuilder} - * + * * @since 1.0.0 */ public class BaseApiAnalyzer implements IApiAnalyzer { @@ -298,7 +298,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { * markers. When running the the API tools analysis task the analyzer should * continue to process the component to produce some results (the task * should warn that the results may not be accurate). - * + * * @param continueOnError whether to continue processing a component if it * has resolution errors */ @@ -313,7 +313,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { * with markers. When running the the API tools analysis task the analyzer * should continue to process the component to produce some results (the * task should warn that the results may not be accurate). - * + * * @return whether this analyzer will continue analyzing a component if it * has resolution errors */ @@ -324,7 +324,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Checks if the setting to scan for invalid references is not set to be * ignored AND there are no descriptions installed - * + * * @param component * @param monitor * @since 1.0.400 @@ -358,7 +358,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Processes the API Use Scan report for the given API Component - * + * * @param apiComponent * @param bcontext * @param monitor @@ -472,7 +472,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates an {@link IApiProblem} for the broken external dependency - * + * * @param problems * @param dependency * @param referenceType @@ -558,7 +558,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Checks the compatibility of each type. - * + * * @param changedtypes type names, may have <code>null</code> entries * @param reference API component in the reference baseline * @param component API component being checked for compatibility @@ -577,7 +577,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Checks for unused API problem filters - * + * * @param context the current build context * @param reference * @param monitor @@ -644,7 +644,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { * Removes the given set of {@link IApiProblemFilter}s from the given * {@link IApiFilterStore} using a workspace runnable to avoid resource * notifications - * + * * @param store the store to remove from * @param filterlist list of filters to batch remove * @param monitor @@ -660,7 +660,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates a new unused {@link IApiProblemFilter} problem - * + * * @param filters the filters to create the problems for * @return a new {@link IApiProblem} for unused problem filters or * <code>null</code> @@ -728,7 +728,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Check the version changes of re-exported bundles to make sure that the * given component version is modified accordingly. - * + * * @param reference the given reference API component * @param component the given component */ @@ -788,7 +788,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates and AST for the given {@link ITypeRoot} at the given offset - * + * * @param root * @param offset * @return @@ -831,7 +831,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Returns an {@link IApiTypeContainer} given the component and type names * context - * + * * @param component * @param types * @return a new {@link IApiTypeContainer} for the component and type names @@ -851,7 +851,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Returns a listing of {@link IReferenceTypeDescriptor}s given the listing * of type names - * + * * @param typenames * @return */ @@ -939,7 +939,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { * Whether to ignore since tag checks. If <code>null</code> is passed in we * are asking if all since tag checks should be ignored, if a pref is * specified we only want to know if that kind should be ignored - * + * * @param pref * @return */ @@ -998,7 +998,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * @return if the invalid annotation check should be ignored - * + * * @since 1.0.600 */ private boolean ignoreInvalidAnnotationCheck() { @@ -1020,7 +1020,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Checks the validation of tags for the given {@link IApiComponent} - * + * * @param context * @param component * @param monitor @@ -1072,7 +1072,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Recursively finds all source in the given project and scans it for * invalid tags - * + * * @param element * @param monitor * @throws JavaModelException @@ -1109,7 +1109,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Processes the given type name for invalid Javadoc tags - * + * * @param typename */ private void processType(String typename, boolean tags, boolean annotations) { @@ -1130,7 +1130,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Processes the given {@link ICompilationUnit} for invalid tags - * + * * @param cunit */ private void processType(ICompilationUnit cunit, boolean tags, boolean annotations) { @@ -1149,7 +1149,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Checks for illegal API usage in the specified component, creating problem * markers as required. - * + * * @param context the current build context * @param component component being built * @param monitor progress monitor @@ -1199,7 +1199,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Returns the collection of type names to be built - * + * * @param context * @return the complete listing of type names to build or an empty array, * never <code>null</code> @@ -1237,7 +1237,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Compares the given type between the two API components - * + * * @param typeName the type to check in each component * @param reference * @param component @@ -1391,7 +1391,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Compares the two given components and generates an {@link IDelta} - * + * * @param jproject * @param reference * @param component @@ -1447,7 +1447,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { * Processes delta to determine if it needs an @since tag. If it does and * one is not present or the version of the tag is incorrect, a marker is * created - * + * * @param jproject * @param delta * @param component @@ -1587,7 +1587,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates a marker to denote a problem with the since tag (existence or * correctness) for a member and returns it, or <code>null</code> - * + * * @param kind * @param messageargs * @param compilationUnit @@ -1660,7 +1660,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates an {@link IApiProblem} for the given compatibility delta - * + * * @param delta * @param jproject * @param reference @@ -1729,7 +1729,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates an {@link IApiProblem} for the given API component - * + * * @param component * @return a new API component resolution problem or <code>null</code> */ @@ -1742,7 +1742,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Processes a delta to know if we need to check for since tag or version * numbering problems - * + * * @param jproject * @param delta * @param reference @@ -1885,7 +1885,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Checks the version number of the API component and creates a problem * markers as needed - * + * * @param reference * @param component */ @@ -2064,7 +2064,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Collects details from the given delta listing for version problems - * + * * @param deltas * @return a {@link String} of the details why the version number should be * changed @@ -2090,7 +2090,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Creates a marker on a manifest file for a version numbering problem and * returns it or <code>null</code> - * + * * @param kind * @param messageargs * @param version @@ -2198,7 +2198,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Returns the Java project associated with the given API component, or * <code>null</code> if none. - * + * * @param component API component * @return Java project or <code>null</code> */ @@ -2213,7 +2213,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Adds the problem to the list of problems iff it is not <code>null</code> * and not filtered - * + * * @param problem * @return */ @@ -2227,7 +2227,7 @@ public class BaseApiAnalyzer implements IApiAnalyzer { /** * Returns if the given {@link IApiProblem} should be filtered from having a * problem marker created for it - * + * * @param problem the problem that may or may not be filtered * @return true if the {@link IApiProblem} should not have a marker created, * false otherwise diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildContext.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildContext.java index 7289335beb..33b557310f 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildContext.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildContext.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.provisional.builder.IBuildContext; /** * Default implementation of an {@link IBuildContext} - * + * * @since 1.0.1 */ public class BuildContext implements IBuildContext { @@ -82,7 +82,7 @@ public class BuildContext implements IBuildContext { /** * Adds the given type name to the collection of structurally changed types. * Does nothing if <code>null</code> is passed in as the type name. - * + * * @param typename */ public void recordStructuralChange(String typename) { @@ -98,7 +98,7 @@ public class BuildContext implements IBuildContext { /** * Adds the given type name to the collection of removed types. Does nothing * if <code>null</code> is passed in as the type name. - * + * * @param typename */ public void recordRemovedType(String typename) { @@ -114,7 +114,7 @@ public class BuildContext implements IBuildContext { /** * Adds the given type name to the collection of types that have had an API * description change. Does nothing if <code>null</code> is passed in. - * + * * @param typename the type that has an API description change or * <code>null</code> */ @@ -130,7 +130,7 @@ public class BuildContext implements IBuildContext { /** * Adds the given type name to the collection of dependent type names. Does * nothing if <code>null</code> is passed in as the type name. - * + * * @param typename the type to add a dependent of */ public void recordDescriptionDependent(String typename) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildStamps.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildStamps.java index 319e6f116c..897793c0f4 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildStamps.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildStamps.java @@ -24,7 +24,7 @@ public class BuildStamps { /** * Returns the current build time stamp for the given project. - * + * * @param project project * @return relative build time stamp */ @@ -39,7 +39,7 @@ public class BuildStamps { /** * Increments the build time stamp for the given project. Only to be called * by the builder. - * + * * @param project project being built */ public static synchronized void incBuildStamp(IProject project) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildState.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildState.java index 2a95801dd7..2dc32c9111 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildState.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/BuildState.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -51,7 +51,7 @@ import org.eclipse.pde.core.build.IBuildModel; /** * The API tools build state - * + * * @since 1.0.1 */ public class BuildState { @@ -63,13 +63,13 @@ public class BuildState { private Map<String, Set<IDelta>> breakingChanges; /** * Map of the last saved state of the manifest file - * + * * @since 1.0.3 */ private Map<String, String> manifestChanges; /** * Map of the last saved state of the build.properties file - * + * * @since 1.0.3 */ private Map<String, String> buildPropChanges; @@ -89,7 +89,7 @@ public class BuildState { /** * Reads the build state from an input stream - * + * * @param in * @return the {@link BuildState} from the given input stream * @throws IOException @@ -163,7 +163,7 @@ public class BuildState { /** * Writes the given {@link BuildState} to the given output stream - * + * * @param state * @param out * @throws IOException @@ -218,7 +218,7 @@ public class BuildState { /** * Read the {@link IDelta} from the build state (input stream) - * + * * @param in the input stream to read the {@link IDelta} from * @return a reconstructed {@link IDelta} from the build state * @throws IOException @@ -259,7 +259,7 @@ public class BuildState { /** * Writes a given {@link IDelta} to the build state (the output stream) - * + * * @param delta the delta to write * @param out the stream to write to * @throws IOException @@ -293,7 +293,7 @@ public class BuildState { /** * Adds an {@link IDelta} for a compatible compatibility change to the * current state - * + * * @param delta the {@link IDelta} to add to the state */ public void addCompatibleChange(IDelta delta) { @@ -311,7 +311,7 @@ public class BuildState { /** * Add an {@link IDelta} for an incompatible compatibility change to the * current state - * + * * @param delta the {@link IDelta} to add to the state */ public void addBreakingChange(IDelta delta) { @@ -370,7 +370,7 @@ public class BuildState { /** * Remove all entries for the given type name. - * + * * @param typeName the given type name */ public void cleanup(String typeName) { @@ -382,7 +382,7 @@ public class BuildState { /** * Sets the current list if re-exported {@link IApiComponent}s for this * build state - * + * * @param components */ public void setReexportedComponents(IApiComponent[] components) { @@ -401,7 +401,7 @@ public class BuildState { /** * Adds a dependent project to the listing of dependent projects - * + * * @param projectName */ public void addApiToolingDependentProject(String projectName) { @@ -422,7 +422,7 @@ public class BuildState { * Allows the last built state of the manifest to be saved. This method will * perform compaction of the manifest, removing headers that we not need to * care about. - * + * * @param state the last built state of the manifest * @since 1.0.3 */ @@ -445,7 +445,7 @@ public class BuildState { /** * Returns the last saved state of the manifest or an empty {@link Map}, * never <code>null</code> - * + * * @return the last built state of the manifest or an empty {@link Map}, * never <code>null</code> * @since 1.0.3 @@ -465,7 +465,7 @@ public class BuildState { * <li>names that start with: {@link IBuildEntry#JAR_PREFIX}</li> * <li>names that start with: <code>extra.</code></li> * </ul> - * + * * @param model the {@link IBuildModel} to save * @since 1.0.3 */ @@ -491,7 +491,7 @@ public class BuildState { /** * Allows the map to be reset to the given map, passing in <code>null</code> * clears the current mapping. - * + * * @param map the map to set * @since 1.0.3 */ @@ -506,7 +506,7 @@ public class BuildState { /** * Returns the last built state of the build.properties file or an empty * {@link Map}, never <code>null</code> - * + * * @return the last built state of the build.properties file or an empty * {@link Map}, never <code>null</code> * @since 1.0.3 @@ -517,7 +517,7 @@ public class BuildState { /** * Returns a CRC32 code of the project's build path or -1 if unknown. - * + * * @return CRC32 code of the project's build path or -1 */ public long getBuildPathCRC() { @@ -526,7 +526,7 @@ public class BuildState { /** * Sets the build path CRC for this project's resolved build path. - * + * * @param crc32 crc32 code */ public void setBuildPathCRC(long crc32) { @@ -546,7 +546,7 @@ public class BuildState { /** * Reads the build state for the relevant project. - * + * * @return the current {@link BuildState} for the given project or * <code>null</code> if there is not one */ @@ -579,7 +579,7 @@ public class BuildState { /** * Sets the last built state for the given project, or null to reset it. - * + * * @param project the project to set a state for * @param state the {@link BuildState} to set as the last state */ @@ -604,7 +604,7 @@ public class BuildState { /** * Returns the {@link File} to use for saving and restoring the last built * state for the given project. - * + * * @param project gets the saved state file for the given project * @return the {@link File} to use for saving and restoring the last built * state for the given project. @@ -619,7 +619,7 @@ public class BuildState { /** * Saves the current build state - * + * * @param project * @param state * @throws CoreException @@ -667,7 +667,7 @@ public class BuildState { /** * Computes and returns a CRC of the projects resolved build path, or -1 if * unknown. - * + * * @param project project * @return build path CRC or -1 */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalAnnotationReferenceDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalAnnotationReferenceDetector.java index 7f42df2552..104b68bb4e 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalAnnotationReferenceDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalAnnotationReferenceDetector.java @@ -30,7 +30,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; /** * Detector for illegally referenced annotations - * + * * @since 1.0.600 */ public class IllegalAnnotationReferenceDetector extends AbstractIllegalTypeReference { @@ -91,7 +91,7 @@ public class IllegalAnnotationReferenceDetector extends AbstractIllegalTypeRefer * <code>null</code> and not the enclosing {@link IAnnotatable} (if there is * one). That way we can fetch the default illegal type reference message * location - * + * * @param type * @param member * @param reference diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalExtendsProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalExtendsProblemDetector.java index 9d0c17e271..9c55e1a9ba 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalExtendsProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalExtendsProblemDetector.java @@ -16,7 +16,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects when a type illegally extends another type. - * + * * @since 1.1 */ public class IllegalExtendsProblemDetector extends AbstractIllegalTypeReference { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalFieldReferenceDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalFieldReferenceDetector.java index 3f66c2efd3..2d2287eeab 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalFieldReferenceDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalFieldReferenceDetector.java @@ -30,7 +30,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects references to 'no reference' fields. - * + * * @since 1.1 */ public class IllegalFieldReferenceDetector extends AbstractProblemDetector { @@ -52,7 +52,7 @@ public class IllegalFieldReferenceDetector extends AbstractProblemDetector { /** * Adds the given field as not to be referenced - * + * * @param field a field that is marked no reference * @param componentId the component the type is located in */ @@ -63,10 +63,10 @@ public class IllegalFieldReferenceDetector extends AbstractProblemDetector { /** * Adds an {@link IReferenceTypeDescriptor} that is reference-restricted - * + * * @param type the {@link IReferenceTypeDescriptor} that is restricted * @param componentid the id of the API the reference type comes from - * + * * @since 1.0.400 */ void addIllegalType(IReferenceTypeDescriptor type, String componentid) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalImplementsProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalImplementsProblemDetector.java index 2b72c44169..1663aabab3 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalImplementsProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalImplementsProblemDetector.java @@ -27,7 +27,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects when a type illegally implements another type. - * + * * @since 1.1 */ public class IllegalImplementsProblemDetector extends AbstractIllegalTypeReference { @@ -149,7 +149,7 @@ public class IllegalImplementsProblemDetector extends AbstractIllegalTypeReferen /** * Returns if the given type implements any of the given interfaces anywhere * in its lineage - * + * * @param type * @param iname * @return true if all of the interfaces are implemented, false otherwise @@ -168,7 +168,7 @@ public class IllegalImplementsProblemDetector extends AbstractIllegalTypeReferen /** * Inspects the hierarchy of super-interfaces to determine if an interface * with the given name is implemented or not - * + * * @param iname the name of the interface to find * @param interfaces the collection of interfaces to inspect * @return true if the interface is implemented, false otherwise @@ -192,7 +192,7 @@ public class IllegalImplementsProblemDetector extends AbstractIllegalTypeReferen /** * Finds all of the implements restricted interfaces in the hierarchy of * this given type - * + * * @param originalcomponent the original {@link IApiComponent} * @param entryinterface the name of the interface we originally entered the * recursion with diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalInstantiateProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalInstantiateProblemDetector.java index 8070fd02ab..515b177a31 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalInstantiateProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalInstantiateProblemDetector.java @@ -21,7 +21,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects when a type illegally extends another type. - * + * * @since 1.1 */ public class IllegalInstantiateProblemDetector extends AbstractIllegalTypeReference { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalMethodReferenceDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalMethodReferenceDetector.java index 3e31e3a9d7..30a718aa81 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalMethodReferenceDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalMethodReferenceDetector.java @@ -28,7 +28,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; /** * Detects when a 'no reference' method is called. - * + * * @since 1.1 */ public class IllegalMethodReferenceDetector extends AbstractIllegalMethodReference { @@ -37,7 +37,7 @@ public class IllegalMethodReferenceDetector extends AbstractIllegalMethodReferen /** * Adds an {@link IReferenceTypeDescriptor} that is reference-restricted - * + * * @param type the qualified name of the {@link IReferenceTypeDescriptor} * that is restricted * @param componentid the id of the component that the type is from diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalOverrideProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalOverrideProblemDetector.java index d927c4ef5e..b8851207c2 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalOverrideProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IllegalOverrideProblemDetector.java @@ -24,7 +24,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; /** * Detects when a method illegally overrides another method. - * + * * @since 1.1 */ public class IllegalOverrideProblemDetector extends AbstractIllegalMethodReference { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IncrementalApiBuilder.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IncrementalApiBuilder.java index dfc532fbae..ac138698e0 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IncrementalApiBuilder.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/IncrementalApiBuilder.java @@ -47,7 +47,7 @@ import org.eclipse.pde.core.plugin.IPluginModelBase; /** * Used to incrementally build changed Java types - * + * * @since 3.5 */ public class IncrementalApiBuilder { @@ -70,7 +70,7 @@ public class IncrementalApiBuilder { /** * Creates a change of the specified kinds. - * + * * @param kind bit mask of STUCTURAL | DESCRIPTION * @param deltaKind resource delta kind * @param resource file that changed @@ -89,7 +89,7 @@ public class IncrementalApiBuilder { /** * IF the given {@link IProject} is the same as the project context, or * is contained in the listing of interesting projects - * + * * @param lproject * @param others * @return <code>true</code> if the project is the same or in the @@ -110,7 +110,7 @@ public class IncrementalApiBuilder { /** * Constructs a new visitor, noting whether the build path of the * project has changed since the last build. - * + * * @param pathChanged */ ResourceDeltaVisitor(boolean pathChanged) { @@ -192,7 +192,7 @@ public class IncrementalApiBuilder { /** * Constructor - * + * * @param project the current project context being built * @param delta the {@link IResourceDelta} from the build framework * @param buildstate the current build state from the @@ -206,7 +206,7 @@ public class IncrementalApiBuilder { * Incrementally builds using the * {@link org.eclipse.pde.api.tools.internal.provisional.builder.IApiAnalyzer} * from the given {@link ApiAnalysisBuilder} - * + * * @param baseline the baseline to compare with * @param wbaseline the workspace baseline * @param deltas the deltas to be built @@ -264,7 +264,7 @@ public class IncrementalApiBuilder { /** * Builds an API delta using the default baseline (from the workspace * settings and the current - * + * * @param project * @param baseline the baseline to compare to * @param wbaseline the current workspace baseline @@ -304,7 +304,7 @@ public class IncrementalApiBuilder { /** * Records the type name from the given IFile as a dependent type in the * given build context - * + * * @param file * @param kind mask of STRUCTURAL and/or DESCRIPTION */ @@ -330,7 +330,7 @@ public class IncrementalApiBuilder { /** * Collects the inner types from the compilation unit - * + * * @param file * @param mask of STRUCTURAL and/or DESCRIPTION */ @@ -355,7 +355,7 @@ public class IncrementalApiBuilder { /** * Collects the inner types from the compilation unit - * + * * @param file * @param mask of STRUCTURAL and/or DESCRIPTION */ @@ -386,7 +386,7 @@ public class IncrementalApiBuilder { /** * Constructs a build context based on the current JDT build state and known * changes. - * + * * @param project the current project being built * @param state the current JDT build state * @param list of changes @@ -469,7 +469,7 @@ public class IncrementalApiBuilder { * Adds the dependent files from the current build context based on the * current JDT build state to either the structural or description * dependents. - * + * * @param project the current project being built * @param state the current JDT build state * @param types dot and $ qualified names of base types that changed @@ -520,7 +520,7 @@ public class IncrementalApiBuilder { /** * Adds a type to search for dependents of in considered projects for an * incremental build - * + * * @param path */ void splitName(String typename, StringSet packages, StringSet simpleTypes) { @@ -541,7 +541,7 @@ public class IncrementalApiBuilder { /** * Returns an array of type names, and cleans up markers for the specified * resource - * + * * @param project the project being built * @param state the current build state for the given project * @param monitor @@ -588,7 +588,7 @@ public class IncrementalApiBuilder { /** * Resolves the java path from the given resource - * + * * @param resource * @param kind CLASS_FILE, JAVA_FILE, or UNKNOWN * @return the resolved path or <code>null</code> if the resource is not diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakExtendsProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakExtendsProblemDetector.java index 8e182963b0..021880f47b 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakExtendsProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakExtendsProblemDetector.java @@ -33,7 +33,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects leaked super types. - * + * * @since 1.1 */ public class LeakExtendsProblemDetector extends AbstractTypeLeakDetector { @@ -140,7 +140,7 @@ public class LeakExtendsProblemDetector extends AbstractTypeLeakDetector { /** * Adds all visible methods to the given set in the specified type. - * + * * @param type type to analyze * @param members set to add methods to * @param modifiers visibilities to consider @@ -158,7 +158,7 @@ public class LeakExtendsProblemDetector extends AbstractTypeLeakDetector { /** * Returns whether the given type has any visible fields base on the given * visibility flags to consider. A field is visible signals a definite leak. - * + * * @param type type to analyze * @param modifiers visibilities to consider * @return whether there are any visible fields @@ -177,7 +177,7 @@ public class LeakExtendsProblemDetector extends AbstractTypeLeakDetector { /** * Adds all API super types of the given type to the given list in top down * order. - * + * * @param superTypes list to add to * @param type type being processed */ @@ -201,7 +201,7 @@ public class LeakExtendsProblemDetector extends AbstractTypeLeakDetector { /** * Returns whether the given type has API visibility. - * + * * @param type type * @return whether the given type has API visibility */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakFieldProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakFieldProblemDetector.java index da4fdfccf1..189105a759 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakFieldProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakFieldProblemDetector.java @@ -33,7 +33,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects leaked field declarations (declared type). - * + * * @since 1.1 */ public class LeakFieldProblemDetector extends AbstractTypeLeakDetector { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakImplementsProblemDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakImplementsProblemDetector.java index 5357df7394..d4d146007b 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakImplementsProblemDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakImplementsProblemDetector.java @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects leaked implemented interfaces. - * + * * @since 1.1 */ public class LeakImplementsProblemDetector extends AbstractTypeLeakDetector { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakParameterTypeDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakParameterTypeDetector.java index 995455fc93..2ae76f984a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakParameterTypeDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakParameterTypeDetector.java @@ -19,7 +19,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects leaks in method parameter types - * + * * @since 1.1 */ public class LeakParameterTypeDetector extends MethodLeakDetector { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakReturnTypeDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakReturnTypeDetector.java index 9bcc667722..265b04f18a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakReturnTypeDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/LeakReturnTypeDetector.java @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Detects leaks in method return types - * + * * @since 1.1 */ public class LeakReturnTypeDetector extends MethodLeakDetector { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/MethodLeakDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/MethodLeakDetector.java index 556acce464..d59c28f911 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/MethodLeakDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/MethodLeakDetector.java @@ -39,7 +39,7 @@ import com.ibm.icu.text.MessageFormat; /** * Detects leaks in method return types and parameters - * + * * @since 1.1 * @noextend This class is not intended to be sub-classed by clients. */ @@ -145,7 +145,7 @@ public abstract class MethodLeakDetector extends AbstractLeakProblemDetector { /** * Returns if the source API restrictions for the given member matches the * restrictions in the parent API description - * + * * @param member * @return true if it matches, false otherwise */ @@ -186,7 +186,7 @@ public abstract class MethodLeakDetector extends AbstractLeakProblemDetector { /** * Returns if the source modifiers for the given member match the ones * specified in the detector - * + * * @param member * @return true if the modifiers match, false otherwise */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ProblemDetectorBuilder.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ProblemDetectorBuilder.java index cf53c75465..98e256dae4 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ProblemDetectorBuilder.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ProblemDetectorBuilder.java @@ -34,7 +34,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemTypes; /** * Builds problem detectors for reference analysis. - * + * * @since 1.1 */ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { @@ -94,14 +94,14 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Stack containing all of the types tagged @noreference - * + * * @since 1.0.400 */ Set<IElementDescriptor> fRestrictedTypes = new HashSet<>(); /** * Build problem detectors for a component. - * + * * @param component * @param kinds the integer mask of the kinds of detectors to create */ @@ -181,7 +181,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Sets the owning component of this builder - * + * * @param component */ public void setOwningComponent(IApiComponent component) { @@ -221,7 +221,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Returns whether the given problem kind should be ignored. - * + * * @param problemKey * @return whether the given problem kind should be ignored */ @@ -233,7 +233,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Returns a set of all non-API package names that are in prerequisite * components. - * + * * @return */ Set<String> getNonApiPackageNames() { @@ -242,7 +242,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Adds additional non-API package descriptors to the detector builder. - * + * * @param packagee * @return true if the descriptor did not exist in the current collection * and was added, false otherwise @@ -256,7 +256,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Returns a list of problem detectors to be used. - * + * * @return problem detectors */ public List<IApiProblemDetector> getProblemDetectors() { @@ -265,7 +265,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Adds the system detector to the given listing - * + * * @param detectors * @param project */ @@ -287,7 +287,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { /** * Adds the use detectors to the listing - * + * * @param detectors * @param project */ @@ -340,7 +340,7 @@ public class ProblemDetectorBuilder extends ApiDescriptionVisitor { * Adds any leak detectors to the listing. If a project context is available * we filter out disabled detectors based on project / workspace preference * settings - * + * * @param detectors * @param project */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Reference.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Reference.java index ab5d18cd26..ee38528930 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Reference.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Reference.java @@ -38,7 +38,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Implementation of a reference from one member to another. - * + * * @since 1.0.0 */ public class Reference implements IReference { @@ -55,7 +55,7 @@ public class Reference implements IReference { /** * One of the valid reference kinds - * + * * @see IReference */ private int fKind = 0; @@ -104,7 +104,7 @@ public class Reference implements IReference { * Adds the given collection of * {@link org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem} * s to the backing listing. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type where virtual method lookup * begins @@ -127,7 +127,7 @@ public class Reference implements IReference { /** * Creates and returns a method reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type where virtual method lookup * begins @@ -141,7 +141,7 @@ public class Reference implements IReference { /** * Creates and returns a method reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type where virtual method lookup * begins @@ -165,7 +165,7 @@ public class Reference implements IReference { /** * Creates and returns a field reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type where field lookup begins * @param fieldName name of the referenced field @@ -177,13 +177,13 @@ public class Reference implements IReference { /** * Creates and returns a field reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type where field lookup begins * @param fieldName name of the referenced field * @param kind kind of field reference * @param flags flags for the reference - * + * * @since 1.0.600 */ public static Reference fieldReference(IApiMember origin, String typeName, String fieldName, int kind, int flags) { @@ -199,7 +199,7 @@ public class Reference implements IReference { /** * Creates and returns a type reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type * @param kind kind of reference @@ -210,7 +210,7 @@ public class Reference implements IReference { /** * Creates and returns a type reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type * @param signature extra type signature information @@ -222,13 +222,13 @@ public class Reference implements IReference { /** * Creates and returns a type reference. - * + * * @param origin where the reference occurred from * @param typeName name of the referenced type * @param signature extra type signature information * @param kind kind of reference * @param flags flags for the reference - * + * * @since 1.0.600 */ public static Reference typeReference(IApiMember origin, String typeName, String signature, int kind, int flags) { @@ -264,7 +264,7 @@ public class Reference implements IReference { /** * OR's the given set of new flags with the current set of flags - * + * * @param newflags */ public void setFlags(int newflags) { @@ -298,7 +298,7 @@ public class Reference implements IReference { /** * Sets the line number - used by the reference extractor. - * + * * @param line line number */ void setLineNumber(int line) { @@ -307,7 +307,7 @@ public class Reference implements IReference { /** * Resolves this reference - * + * * @throws CoreException */ public void resolve() throws CoreException { @@ -371,7 +371,7 @@ public class Reference implements IReference { /** * Resolves the field in the parent class hierarchy - * + * * @param type the initial type to search * @param fieldame the name of the field * @return true if the field resolved @@ -395,7 +395,7 @@ public class Reference implements IReference { * Resolves a virtual method and returns whether the method lookup was * successful. We need to resolve the actual type that implements the method * - i.e. do the virtual method lookup. - * + * * @param callSiteComponent the component where the method call site was * located * @param typeName referenced type name @@ -425,7 +425,7 @@ public class Reference implements IReference { * Sets the resolved value for the invokevirtual or invokeinterface * reference. If the method is not null and successfully updates the * reference true is returned - * + * * @param method * @return * @throws CoreException @@ -451,7 +451,7 @@ public class Reference implements IReference { /** * Resolves a given method in the super type hierarchy, returns true if it * is resolved - * + * * @param type * @param methodName * @param methodSignature @@ -472,13 +472,13 @@ public class Reference implements IReference { /** * Try to find the method in the interface hierarchy - * + * * @param type * @param methodName * @param methodSignature * @return * @throws CoreException - * + * * @since 1.0.600 */ boolean resolveInterfaceMethod(IApiType type, String methodName, String methodSignature) throws CoreException { @@ -500,7 +500,7 @@ public class Reference implements IReference { * Resolves a method and returns whether the method lookup was successful. * We need to resolve the actual type that implements the method - i.e. do * the virtual method lookup. - * + * * @param callSiteComponent the component where the method call site was * located * @param typeName referenced type name @@ -600,7 +600,7 @@ public class Reference implements IReference { /** * Used by the search engine when resolving multiple references. - * + * * @param resolution resolved reference */ public void setResolution(IApiMember resolution) { @@ -641,7 +641,7 @@ public class Reference implements IReference { /** * Returns the string representation for the given reference kind or * <code>UKNOWN_KIND</code> if the kind cannot be determined. - * + * * @param kind the kid(s) to get the display text for * @return the string for the reference kind * @since 1.0.1 @@ -839,7 +839,7 @@ public class Reference implements IReference { /** * Builds a reference descriptor from this reference or <code>null</code>. - * + * * @return corresponding reference descriptor or <code>null</code> if * unresolved * @throws CoreException if unable to resolve visibility diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceAnalyzer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceAnalyzer.java index 536f3e1308..8f01470f87 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceAnalyzer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceAnalyzer.java @@ -37,7 +37,7 @@ import com.ibm.icu.text.MessageFormat; /** * The reference analyzer - * + * * @since 1.1 */ public class ReferenceAnalyzer { @@ -146,7 +146,7 @@ public class ReferenceAnalyzer { * {@link org.eclipse.pde.api.tools.internal.provisional.search.ReferenceModifiers#REF_INSTANTIATE} * will be in the 26th index (0x1 << 27, which is 2 ^ 26). Also initializes * the bit mask of all interesting reference kinds. - * + * * @param detectors problem detectors */ void indexProblemDetectors(IApiProblemDetector[] detectors) { @@ -175,7 +175,7 @@ public class ReferenceAnalyzer { /** * log 2 (x) = ln(x) / ln(2) - * + * * @param bitConstant a single bit constant (0x1 << n) * @return log base 2 of the constant (the power of 2 the constant is equal * to) @@ -188,7 +188,7 @@ public class ReferenceAnalyzer { /** * Scans the given scope extracting all reference information. - * + * * @param scope scope to scan * @param monitor progress monitor * @exception CoreException if the scan fails @@ -218,7 +218,7 @@ public class ReferenceAnalyzer { * Analyzes the given {@link IApiComponent} within the given * {@link IApiTypeContainer} (scope) and returns a collection of detected * {@link IApiProblem}s or an empty collection, never <code>null</code> - * + * * @param component * @param scope * @param monitor @@ -271,7 +271,7 @@ public class ReferenceAnalyzer { /** * Returns the collection of problem detectors for the given reference kind - * + * * @param referencekind * @return */ @@ -291,12 +291,12 @@ public class ReferenceAnalyzer { /** * Builds problem detectors to use when analyzing the given component. - * + * * @param component component to be analyzed * @param kindmask the kinds of detectors to build. See * {@link ProblemDetectorBuilder} for kinds * @param monitor - * + * * @return problem detectors */ public IApiProblemDetector[] buildProblemDetectors(IApiComponent component, int kindmask, IProgressMonitor monitor) { 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 74344c2573..b2e2a1290a 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 @@ -52,14 +52,14 @@ import org.objectweb.asm.tree.ClassNode; /** * Extracts references from a class file - * + * * @since 1.0.0 */ public class ReferenceExtractor extends ClassVisitor { /** * A visitor for visiting java 5+ signatures - * + * * ClassSignature = (visitFormalTypeParameter visitClassBound? * visitInterfaceBound* )* (visitSuperClass visitInterface* ) * MethodSignature = (visitFormalTypeParameter visitClassBound? @@ -103,7 +103,7 @@ public class ReferenceExtractor extends ClassVisitor { * context. The kind flag is set to a parameterized type as subsequent * calls to this method without visiting other nodes only occurs when we * are processing parameterized types of generic declarations - * + * * @param name the name of the type */ protected void processType(String name) { @@ -240,7 +240,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Constructor - * + * * @param mv */ public ClassFileMethodVisitor(MethodVisitor mv, String name, int argumentcount) { @@ -488,7 +488,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Creates a type from a type description. Works around bugs creating * types from array type signatures in ASM. - * + * * @param desc signature * @return Type */ @@ -624,7 +624,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * {@link FieldVisitor} to track use of types in annotations - * + * * @since 1.0.600 */ class ClassFileFieldVisitor extends FieldVisitor { @@ -666,7 +666,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Add a field to be tracked - * + * * @param field */ public void addField(Reference ref) { @@ -677,7 +677,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Add an accessor to be tracked - * + * * @param accessor */ public void addAccessor(Reference ref) { @@ -943,14 +943,14 @@ public class ReferenceExtractor extends ClassVisitor { /** * Track synthetic field / accessor - * + * * @since 1.1 */ FieldTracker fieldtracker = null; /** * The version for the class being visited - * + * * @since 1.0.600 */ private int fVersion; @@ -975,14 +975,14 @@ public class ReferenceExtractor extends ClassVisitor { /** * {@link FieldVisitor} used to track and collect references to annotation * types - * + * * @since 1.0.600 */ private ClassFileFieldVisitor fieldvisitor = new ClassFileFieldVisitor(); /** * Constructor - * + * * @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 @@ -999,7 +999,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Constructor - * + * * @param type * @param collector * @param referenceKinds @@ -1031,7 +1031,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Returns whether to consider a reference to the specified type. Configured * by setting to include references within the same class file. - * + * * @param owner * @return true if considered, false otherwise */ @@ -1046,7 +1046,7 @@ public class ReferenceExtractor extends ClassVisitor { * Returns whether the specified reference should be considered when * extracting references. Configured by setting on whether to include * references within the same class file. - * + * * @param ref reference * @return whether to include the reference */ @@ -1076,7 +1076,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Returns the full internal name (if available) from the given simple name. * The returned name has been modified to be '.' separated - * + * * @param name * @return */ @@ -1093,7 +1093,7 @@ public class ReferenceExtractor extends ClassVisitor { * Adds a reference to the given type from the current member. Discards the * reference if the type corresponds to the class file being scanned or if * the type is a primitive type. - * + * * @param type referenced type * @param linenumber line number where referenced * @param kind kind of reference @@ -1110,7 +1110,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Adds a reference to the given field from the current member. Discards the * reference if the field is defined in the class file being scanned. - * + * * @param declaringType type declaring the field being referenced * @param name of the field being referenced * @param linenumber line number where referenced @@ -1128,7 +1128,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Adds a reference to the given method from the current member. Discards * the reference if the method is defined in the class file being scanned. - * + * * @param declaringType type declaring the method (but could be a virtual * lookup) * @param name of the method being referenced @@ -1151,7 +1151,7 @@ public class ReferenceExtractor extends ClassVisitor { * the class file being scanned. If the target member is contained in the * class file being scanned it is discarded based on the setting to include * local references. - * + * * @param target reference * @param reference added, or <code>null</code> if none */ @@ -1167,12 +1167,12 @@ public class ReferenceExtractor extends ClassVisitor { * Processes the member signature from the specified type with the given * signature and kind. A member can be either a type, method, field or local * variable - * + * * @param name the name of the member to process * @param signature the signature of the member to process * @param kind the kind * @param type the type of member wanting to use the visitor - * + * * @return the collection of references created for this signature */ protected List<Reference> processSignature(String name, String signature, int kind, int type) { @@ -1200,7 +1200,7 @@ public class ReferenceExtractor extends ClassVisitor { * type descriptions as a parameter, all else will throw an exception from * the ASM framework If the description is an array, the underlying type of * the array is returned. - * + * * @param desc * @return the {@link Type} of the description or <code>null</code> */ @@ -1337,7 +1337,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Processes the dependent inner class - * + * * @param type * @param refkinds * @return @@ -1437,7 +1437,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Called when a member is entered. Pushes the member onto the member stack. - * + * * @param member current member */ protected void enterMember(IApiMember member) { @@ -1453,7 +1453,7 @@ public class ReferenceExtractor extends ClassVisitor { /** * Returns the member currently being visited. - * + * * @return current member */ protected IApiMember getMember() { @@ -1464,7 +1464,7 @@ public class ReferenceExtractor extends ClassVisitor { * Find out if the method declaration is a default method and return the * type defining it. Uses the JLS specified order of lookup between * superclasses and superinterfaces. - * + * * @param type the type used as a starting point for the search, will not be * searched if <code>isOverride</code> is <code>true</code> * @param name name of the method @@ -1501,7 +1501,7 @@ public class ReferenceExtractor extends ClassVisitor { } return null; } - - + + } diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceResolver.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceResolver.java index 4f44eccc54..13b694fa57 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceResolver.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/ReferenceResolver.java @@ -23,7 +23,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiMember; /** * Utility class used to resolve {@link IReference}s - * + * * @since 1.0.0 * @noinstantiate This class is not intended to be instantiated by clients. */ @@ -37,7 +37,7 @@ public final class ReferenceResolver { /** * Resolves retained references. - * + * * @param references list of {@link IReference} to resolve * @param progress monitor * @throws CoreException if something goes wrong @@ -91,7 +91,7 @@ public final class ReferenceResolver { /** * Resolves the collect sets of references. - * + * * @param map the mapping of keys to sets of {@link IReference}s * @throws CoreException if something bad happens */ @@ -115,11 +115,11 @@ public final class ReferenceResolver { /** * Creates a unique string key for a given reference. The key is of the form * "component X references type/member" - * + * * <pre> * [component_id]#[type_name](#[member_name]#[member_signature]) * </pre> - * + * * @param reference reference * @return a string key for the given reference. */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SinceTagChecker.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SinceTagChecker.java index 6bdc717203..10cdf13dc1 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SinceTagChecker.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SinceTagChecker.java @@ -33,7 +33,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * An AST visitor used to find missing or incorrect @since tags - * + * * @since 1.0.0 */ public class SinceTagChecker extends ASTVisitor { @@ -49,7 +49,7 @@ public class SinceTagChecker extends ASTVisitor { /** * Constructor - * + * * @param nameStart */ public SinceTagChecker(int nameStart) { @@ -150,7 +150,7 @@ public class SinceTagChecker extends ASTVisitor { /** * Processes a javadoc tag - * + * * @param bodyDeclaration */ private void processJavadoc(BodyDeclaration bodyDeclaration) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SystemApiDetector.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SystemApiDetector.java index 09de0fef56..73f9409376 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SystemApiDetector.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/SystemApiDetector.java @@ -45,7 +45,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Detects references to fields, methods and types that are not available for a * specific EE. - * + * * @since 1.1 */ public class SystemApiDetector extends AbstractProblemDetector { @@ -114,7 +114,7 @@ public class SystemApiDetector extends AbstractProblemDetector { /** * Returns the signature to display for found problems - * + * * @param member the member to get the signature from * @param qualified if the returned signature should be type-qualified or * not 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 a5c6250290..06167ad8ed 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 @@ -45,9 +45,9 @@ import org.eclipse.pde.api.tools.internal.util.Util; * <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 - * + * * @since 1.0.0 */ public class TagValidator extends Validator { @@ -68,7 +68,7 @@ public class TagValidator extends Validator { /** * Constructor - * + * * @param parent * @param tags * @param annotations @@ -125,7 +125,7 @@ public class TagValidator extends Validator { /** * Validates the set of tags for the given parent node and the given listing * of {@link TagElement}s - * + * * @param node * @param tags */ @@ -218,7 +218,7 @@ public class TagValidator extends Validator { /** * Process the tags for the given {@link TypeDeclaration} node - * + * * @param type * @param tags * @since 1.0.400 @@ -264,7 +264,7 @@ public class TagValidator extends Validator { /** * Processes all of the tags for the given {@link FieldDeclaration} - * + * * @param field * @param tags * @since 1.0.400 @@ -331,7 +331,7 @@ public class TagValidator extends Validator { /** * Processes all of the tags for the given {@link MethodDeclaration} - * + * * @param method * @param tags * @since 1.0.400 @@ -417,7 +417,7 @@ public class TagValidator extends Validator { /** * Returns the complete listing of supported tags for the given type and * member - * + * * @param type * @param member * @return the list of supported tag names or the @@ -439,7 +439,7 @@ public class TagValidator extends Validator { /** * Creates a new {@link IApiProblem} for the given tag and adds it to the * cache - * + * * @param tag * @param element * @param context @@ -513,7 +513,7 @@ public class TagValidator extends Validator { /** * Checks the annotation that appears on the given parent - * + * * @param node the annotation * @param type the parent */ @@ -553,7 +553,7 @@ public class TagValidator extends Validator { /** * Checks the annotation that appears on the given parent - * + * * @param node the annotation * @param type the parent */ @@ -575,7 +575,7 @@ public class TagValidator extends Validator { /** * Checks the annotation that appears on the given parent - * + * * @param node the annotation * @param type the parent */ @@ -596,7 +596,7 @@ public class TagValidator extends Validator { /** * Checks the annotation that appears on the given parent - * + * * @param node the annotation * @param parent the parent */ @@ -656,7 +656,7 @@ public class TagValidator extends Validator { /** * Checks the given annotation - * + * * @param node the annotation */ void checkMethod(MarkerAnnotation node, MethodDeclaration parent) { @@ -733,7 +733,7 @@ public class TagValidator extends Validator { /** * Creates a new problem - * + * * @param typeName * @param node * @param element diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TypeScope.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TypeScope.java index fc44f98210..a8a9446d59 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TypeScope.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/TypeScope.java @@ -30,7 +30,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot; /** * A search scope containing only types from one component. More efficient than * a general purpose scope. - * + * * @since 1.0 */ public class TypeScope extends ApiElement implements IApiTypeContainer { @@ -47,7 +47,7 @@ public class TypeScope extends ApiElement implements IApiTypeContainer { /** * Constructs a new class file container/search scope on the given types. - * + * * @param component API component * @param types types within the component */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Validator.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Validator.java index 5814a56084..a869a18ede 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Validator.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/builder/Validator.java @@ -28,7 +28,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem; /** * Base class for validators - * + * * @since 1.0.600 */ public abstract class Validator extends ASTVisitor { @@ -128,7 +128,7 @@ public abstract class Validator extends ASTVisitor { /** * Returns the next item on the tip of the stack - * + * * @return the next {@link Item} */ protected Item getItem() { @@ -137,7 +137,7 @@ public abstract class Validator extends ASTVisitor { /** * Returns the fully qualified name of the enclosing type for the given node - * + * * @param node * @return the fully qualified name of the enclosing type */ @@ -147,7 +147,7 @@ public abstract class Validator extends ASTVisitor { /** * Constructs the qualified name of the enclosing parent type - * + * * @param node the node to get the parent name for * @param buffer the buffer to write the name into * @return the fully qualified name of the parent @@ -182,7 +182,7 @@ public abstract class Validator extends ASTVisitor { * Returns the {@link IApiJavadocTag} kind of the parent {@link ASTNode} for * the given node or -1 if the parent is not found or not a * {@link TypeDeclaration} - * + * * @param node * @return the {@link IApiJavadocTag} kind of the parent or -1 */ @@ -203,7 +203,7 @@ public abstract class Validator extends ASTVisitor { /** * Returns the modifiers from the smallest enclosing type containing the * given node - * + * * @param node * @return the modifiers for the smallest enclosing type or 0 */ @@ -220,7 +220,7 @@ public abstract class Validator extends ASTVisitor { /** * Adds a found problem to the listing - * + * * @param problem */ protected void addProblem(IApiProblem problem) { @@ -233,7 +233,7 @@ public abstract class Validator extends ASTVisitor { /** * Returns the complete listing of API annotation problems found during the * scan or an empty array, never <code>null</code> - * + * * @return the complete listing of API annotation problems found */ public IApiProblem[] getProblems() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ClassFileComparator.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ClassFileComparator.java index 57ae9dc2ee..7685bc89c2 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ClassFileComparator.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ClassFileComparator.java @@ -50,7 +50,7 @@ import com.ibm.icu.text.MessageFormat; /** * Compares class files from the workspace to those in the default * {@link IApiBaseline} - * + * * @since 1.0.0 */ public class ClassFileComparator { @@ -113,7 +113,7 @@ public class ClassFileComparator { /** * Constructor - * + * * @param classFile the class file from the workspace to compare * @param classFile2 the class file from the baseline to compare to * @param component the API component from the workspace @@ -136,7 +136,7 @@ public class ClassFileComparator { /** * Constructor - * + * * @param type the {@link IApiType} from the workspace to compare * @param classFile2 the class file from the baseline to compare to * @param component the API component from the workspace @@ -222,7 +222,7 @@ public class ClassFileComparator { /** * reports problem status to the comparators' complete status - * + * * @param newstatus */ protected void reportStatus(IStatus newstatus) { @@ -235,7 +235,7 @@ public class ClassFileComparator { /** * Report problem to the comparators' status - * + * * @param e */ private void reportStatus(CoreException e) { @@ -718,7 +718,7 @@ public class ClassFileComparator { /** * Recursively collects all of the super-interfaces of the given type * descriptor within the scope of the given API component - * + * * @param type * @param set */ @@ -789,7 +789,7 @@ public class ClassFileComparator { /** * Returns a new {@link Delta} to use, and resets the status of creating a * delta - * + * * @return */ private Delta createDelta() { @@ -799,7 +799,7 @@ public class ClassFileComparator { /** * Returns the change(s) between the type descriptor and its equivalent in * the current baseline. - * + * * @return the changes in the type descriptor or <code>null</code> */ public IDelta getDelta(IProgressMonitor monitor) { @@ -1836,7 +1836,7 @@ public class ClassFileComparator { /** * Returns the complete super-interface set for the given type descriptor or * null, if it could not be computed - * + * * @param type * @return the complete super-interface set for the given descriptor, or * <code>null</code> @@ -2207,7 +2207,7 @@ public class ClassFileComparator { /** * Returns the delta element type code for the given type. Translates a type * to interface, class, emum or annotation. - * + * * @param type * @return delta element type */ @@ -2227,7 +2227,7 @@ public class ClassFileComparator { /** * Returns the delta element type code for the given method. Translates a * method to constructor or method. - * + * * @param method * @return delta element type */ @@ -2241,7 +2241,7 @@ public class ClassFileComparator { /** * Returns the delta type code for the given method when it is the target of * a remove/add. Translates a method to constructor or method. - * + * * @param method * @return delta type */ @@ -2254,7 +2254,7 @@ public class ClassFileComparator { /** * Translates a member to its delta element type code. - * + * * @param member * @return delta element type code */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ComparatorMessages.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ComparatorMessages.java index f5c33c5c3e..a5a5f79573 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ComparatorMessages.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/ComparatorMessages.java @@ -13,7 +13,7 @@ package org.eclipse.pde.api.tools.internal.comparator; import org.eclipse.osgi.util.NLS; /** - * + * */ public class ComparatorMessages extends NLS { private static final String BUNDLE_NAME = "org.eclipse.pde.api.tools.internal.comparator.comparatormessages"; //$NON-NLS-1$ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Delta.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Delta.java index 00fc50fd3c..707c2e5eaf 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Delta.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Delta.java @@ -32,7 +32,7 @@ public class Delta implements IDelta { /** * Writes the delta to the given {@link PrintWriter} - * + * * @param delta * @param writer */ @@ -101,7 +101,7 @@ public class Delta implements IDelta { /** * Constructor - * + * * @param elementType * @param kind * @param flags @@ -129,7 +129,7 @@ public class Delta implements IDelta { /** * Constructor - * + * * @param elementType * @param kind * @param flags @@ -157,7 +157,7 @@ public class Delta implements IDelta { /** * Adds a child delta to this delta. If the specified delta is * <code>null</code> no work is done. - * + * * @param delta the new child delta */ public void add(IDelta delta) { 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 bc62376ae8..61dd200046 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 @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,7 +22,7 @@ import org.w3c.dom.Element; /** * Delta visitor that generates XML for the delta. - * + * * @since 1.0.0 */ public class DeltaXmlVisitor extends DeltaVisitor { @@ -38,7 +38,7 @@ public class DeltaXmlVisitor extends DeltaVisitor { /** * Constructs a new visitor for the given component. - * + * * @param component API component * @throws CoreException if unable to construct the visitor */ @@ -99,7 +99,7 @@ public class DeltaXmlVisitor extends DeltaVisitor { /** * Returns the settings as a UTF-8 string containing XML. - * + * * @return XML * @throws CoreException if something goes wrong */ @@ -110,7 +110,7 @@ public class DeltaXmlVisitor extends DeltaVisitor { /** * Return the xml dom document this visitor generates. Use {@link #getXML()} * to get the serialized xml string. - * + * * @return xml dom document */ public Document getDocument() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Messages.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Messages.java index d80d2916d6..5959638d77 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Messages.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/comparator/Messages.java @@ -45,7 +45,7 @@ public class Messages extends NLS { /** * This method initializes the MessageTemplates class variable according to * the current Locale. - * + * * @param loc Locale * @return HashtableOfInt */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ComponentDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ComponentDescriptorImpl.java index cfe785e833..2548e56eee 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ComponentDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ComponentDescriptorImpl.java @@ -15,9 +15,9 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri /** * Base implementation of {@link IComponentDescriptor} - * + * * @since 1.0.1 - * + * * @noextend This class is not intended to be sub-classed by clients. * @noinstantiate This class is not intended to be instantiated by clients. */ @@ -28,7 +28,7 @@ public class ComponentDescriptorImpl extends NamedElementDescriptorImpl implemen /** * Constructor - * + * * @param componentid */ public ComponentDescriptorImpl(String componentid, String version) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ElementDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ElementDescriptorImpl.java index b6307a8312..9685e37fab 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ElementDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ElementDescriptorImpl.java @@ -17,7 +17,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri /** * Common base class for element descriptors. - * + * * @since 1.0.0 */ public abstract class ElementDescriptorImpl implements IElementDescriptor, Comparable<IElementDescriptor> { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/FieldDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/FieldDescriptorImpl.java index dedf8d866b..0255c0e8d5 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/FieldDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/FieldDescriptorImpl.java @@ -16,7 +16,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IReferenceType /** * Description of a field. - * + * * @since 1.0.0 */ public class FieldDescriptorImpl extends MemberDescriptorImpl implements IFieldDescriptor { @@ -24,7 +24,7 @@ public class FieldDescriptorImpl extends MemberDescriptorImpl implements IFieldD /** * Constructs a field descriptor with the given name, declared by the given * type. - * + * * @param name field name * @param parent type containing the field declaration */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MemberDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MemberDescriptorImpl.java index c0a343a8f0..46e65d12c7 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MemberDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MemberDescriptorImpl.java @@ -17,7 +17,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IReferenceType /** * Description of a field. - * + * * @since 1.0.0 */ public abstract class MemberDescriptorImpl extends NamedElementDescriptorImpl implements IMemberDescriptor { @@ -29,7 +29,7 @@ public abstract class MemberDescriptorImpl extends NamedElementDescriptorImpl im /** * Constructs a member with the given name and parent - * + * * @param name field name * @param parent type containing the field declaration or package containing * the type diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MethodDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MethodDescriptorImpl.java index a59c8b77c0..71e7102ad8 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MethodDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/MethodDescriptorImpl.java @@ -17,7 +17,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IReferenceType /** * Description of a method. - * + * * @since 1.0.0 */ public class MethodDescriptorImpl extends MemberDescriptorImpl implements IMethodDescriptor { @@ -29,7 +29,7 @@ public class MethodDescriptorImpl extends MemberDescriptorImpl implements IMetho /** * Constructs a method descriptor. - * + * * @param name method name * @param enclosingType enclosing type * @param signature method signature diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/NamedElementDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/NamedElementDescriptorImpl.java index 8820f5fb11..0063740f01 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/NamedElementDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/NamedElementDescriptorImpl.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri /** * Common base class for element descriptors with names. - * + * * @since 1.0.0 */ public abstract class NamedElementDescriptorImpl extends ElementDescriptorImpl { @@ -27,7 +27,7 @@ public abstract class NamedElementDescriptorImpl extends ElementDescriptorImpl { /** * Constructs an element descriptor with the given name and parent. - * + * * @param name element name */ NamedElementDescriptorImpl(String name) { @@ -36,7 +36,7 @@ public abstract class NamedElementDescriptorImpl extends ElementDescriptorImpl { /** * Returns this element's simple name. - * + * * @return element name */ public String getName() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/PackageDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/PackageDescriptorImpl.java index 909d59834e..6ec4048ce1 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/PackageDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/PackageDescriptorImpl.java @@ -16,14 +16,14 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IReferenceType /** * Package description. - * + * * @since 1.0.0 */ public class PackageDescriptorImpl extends NamedElementDescriptorImpl implements IPackageDescriptor { /** * Constructs a package description - * + * * @param name dot qualified package name, empty string for default package */ public PackageDescriptorImpl(String name) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ReferenceTypeDescriptorImpl.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ReferenceTypeDescriptorImpl.java index ab329e7c1f..f81736aedb 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ReferenceTypeDescriptorImpl.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/descriptors/ReferenceTypeDescriptorImpl.java @@ -21,7 +21,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IReferenceType /** * Reference type descriptor. - * + * * @since 1.0.0 */ public class ReferenceTypeDescriptorImpl extends MemberDescriptorImpl implements IReferenceTypeDescriptor { @@ -43,7 +43,7 @@ public class ReferenceTypeDescriptorImpl extends MemberDescriptorImpl implements /** * Constructs a type descriptor with the given name and parent. - * + * * @param name simple type name * @param parent package or enclosing type */ @@ -54,7 +54,7 @@ public class ReferenceTypeDescriptorImpl extends MemberDescriptorImpl implements /** * Constructs a type descriptor with the given name and parent. - * + * * @param name simple type name * @param parent package or enclosing type * @param genericSignature generic signature info or <code>null</code> 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 e6e902f5ac..47ec20ece5 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 @@ -27,7 +27,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot; /** * Common implementation of an {@link IApiTypeContainer} - * + * * @since 1.0.0 */ public abstract class AbstractApiTypeContainer extends ApiElement implements IApiTypeContainer { @@ -39,7 +39,7 @@ public abstract class AbstractApiTypeContainer extends ApiElement implements IAp /** * Constructor - * + * * @param parent the parent {@link IApiElement} or <code>null</code> if * none. * @param type the type of the container @@ -153,7 +153,7 @@ public abstract class AbstractApiTypeContainer extends ApiElement implements IAp /** * Returns the {@link IApiTypeContainer}s in this container. Creates the * containers if they are not yet created. - * + * * @return the {@link IApiTypeContainer}s */ protected synchronized IApiTypeContainer[] getApiTypeContainers() throws CoreException { @@ -166,7 +166,7 @@ public abstract class AbstractApiTypeContainer extends ApiElement implements IAp /** * Returns the {@link IApiTypeContainer}s in this container. Creates the * containers if they are not yet created. - * + * * @param id the given id * @return the {@link IApiTypeContainer}s */ @@ -190,14 +190,14 @@ public abstract class AbstractApiTypeContainer extends ApiElement implements IAp /** * Creates and returns the {@link IApiTypeContainer}s for this component. * Subclasses must override. - * + * * @return list of {@link IApiTypeContainer}s for this component */ protected abstract List<IApiTypeContainer> createApiTypeContainers() throws CoreException; /** * Sets the {@link IApiTypeContainer}s in this container. - * + * * @param containers the {@link IApiTypeContainer}s to set */ protected synchronized void setApiTypeContainers(IApiTypeContainer[] containers) { 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 e6e070c63f..090e0eeb8c 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 @@ -19,14 +19,14 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeRoot; /** * Common implementation for {@link IApiTypeRoot} - * + * * @since 1.0.0 */ public abstract class AbstractApiTypeRoot extends ApiElement implements IApiTypeRoot { /** * Constructor - * + * * @param parent the parent {@link IApiElement} or <code>null</code> if none * @param name the name of the type root */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiElement.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiElement.java index fbc18b6f71..6551fb9b97 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiElement.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiElement.java @@ -21,7 +21,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement; * Abstract description of an API element. Each {@link IApiElement} has a * specific type, name and parent. <br> * API elements cannot be re-parented. - * + * * @since 1.0.0 */ public abstract class ApiElement implements IApiElement { @@ -32,7 +32,7 @@ public abstract class ApiElement implements IApiElement { /** * Constructor - * + * * @param parent the parent {@link IApiElement} for this element, may be * <code>null</code> * @param type the type of this element. See {@link IApiElement} for values. @@ -83,7 +83,7 @@ public abstract class ApiElement implements IApiElement { /** * Sets the name of this {@link ApiElement} to the new name, iff the new * name is not <code>null</code>, otherwise no change is made. - * + * * @param newname */ protected void setName(String newname) { @@ -94,7 +94,7 @@ public abstract class ApiElement implements IApiElement { /** * Throws a core exception. - * + * * @param message message * @param e underlying exception or <code>null</code> * @throws CoreException diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiField.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiField.java index 01805b867d..f027b7ed6f 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiField.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiField.java @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Base implementation of {@link IApiField} - * + * * @since 1.0.0 * @noextend This class is not intended to be subclassed by clients. * @noinstantiate This class is not intended to be instantiated by clients. @@ -38,7 +38,7 @@ public class ApiField extends ApiMember implements IApiField { /** * Constructor - * + * * @param parent the enclosing type of the field * @param name the name of the field * @param signature the signature for the field diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMember.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMember.java index 821a865c8c..0cc1dece71 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMember.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMember.java @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiType; /** * Base implementation of {@link IApiMember} - * + * * @since 1.0.0 * @noextend This class is not intended to be subclassed by clients. */ @@ -31,7 +31,7 @@ public abstract class ApiMember extends ApiElement implements IApiMember { /** * Constructs a member enclosed by the given type with the specified name, * type constant, and flags (modifiers). - * + * * @param parent the parent {@link IApiElement} for this type * @param name member name * @param signature signature (type or method) @@ -47,7 +47,7 @@ public abstract class ApiMember extends ApiElement implements IApiMember { /** * Returns this member's signature. - * + * * @return signature */ @Override @@ -57,7 +57,7 @@ public abstract class ApiMember extends ApiElement implements IApiMember { /** * Returns generic signature or <code>null</code> if none. - * + * * @return */ @Override @@ -107,7 +107,7 @@ public abstract class ApiMember extends ApiElement implements IApiMember { * Returns if the immediate enclosing {@link IApiType}s of the two members * are equal: where both enclosing type being <code>null</code> is * considered equal - * + * * @param e1 * @param e2 * @return true if both immediate enclosing type are equal @@ -129,7 +129,7 @@ public abstract class ApiMember extends ApiElement implements IApiMember { /** * Used when building a member type. - * + * * @param access modifiers */ public void setModifiers(int access) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMethod.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMethod.java index df15b538c9..78d89d05bf 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMethod.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiMethod.java @@ -22,7 +22,7 @@ import org.objectweb.asm.Opcodes; /** * Base implementation of {@link IApiMethod} - * + * * @since 1.0.0 * @noextend This class is not intended to be subclassed by clients. * @noinstantiate This class is not intended to be instantiated by clients. @@ -36,7 +36,7 @@ public class ApiMethod extends ApiMember implements IApiMethod { public static final int Polymorphic = 0x200000; private static final String INIT = "<init>"; //$NON-NLS-1$ - private static final String CLINIT = "<clinit>"; //$NON-NLS-1$ + private static final String CLINIT = "<clinit>"; //$NON-NLS-1$ private String[] fExceptions; private String fDefaultValue; @@ -45,7 +45,7 @@ public class ApiMethod extends ApiMember implements IApiMethod { /** * Constructor - * + * * @param enclosing enclosing type * @param name method name * @param signature method signature @@ -99,7 +99,7 @@ public class ApiMethod extends ApiMember implements IApiMethod { /** * Used when building a type structure. - * + * * @param value default value */ public void setDefaultValue(String value) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelCache.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelCache.java index 335469f564..9c7ccc67bb 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelCache.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelCache.java @@ -19,7 +19,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement; /** * Manages the caches of {@link IApiElement}s - * + * * @since 1.0.2 */ public final class ApiModelCache { @@ -31,7 +31,7 @@ public final class ApiModelCache { /** * Constructor - * + * * @param size * @param overflow */ @@ -51,7 +51,7 @@ public final class ApiModelCache { /** * Returns if the cache has any elements in it or not - * + * * @return true if the cache has no entries, false otherwise */ public boolean isEmpty() { @@ -74,7 +74,7 @@ public final class ApiModelCache { /** * Returns the singleton instance of this cache - * + * * @return the cache */ public static synchronized ApiModelCache getCache() { @@ -87,7 +87,7 @@ public final class ApiModelCache { /** * Returns the key to use in a cache. The key is of the form: * <code>[baselineid].[componentid].[typename]</code><br> - * + * * @param baseline * @param component * @param typename @@ -102,7 +102,7 @@ public final class ApiModelCache { /** * Caches the given {@link IApiElement} in the correct cache based on its * type. - * + * * @param element the element to cache * @throws CoreException if there is a problem accessing any of the * {@link IApiElement} info in order to cache it - pass the @@ -172,7 +172,7 @@ public final class ApiModelCache { /** * Returns the root type name assuming that the '$' char is a member type * boundary - * + * * @param typename * @return the pruned name or the original name */ @@ -186,7 +186,7 @@ public final class ApiModelCache { /** * Method to see if the type boundary char appears in the type name - * + * * @param typename * @return true if the type name contains '$' false otherwise */ @@ -197,7 +197,7 @@ public final class ApiModelCache { /** * Returns the {@link IApiElement} infos for the element referenced by the * given identifier and of the given type. - * + * * @param baselineid the id of the baseline the component + element belongs * to * @param componentid the id of the {@link IApiComponent} the element @@ -205,7 +205,7 @@ public final class ApiModelCache { * @param identifier for example the qualified name of the type or the id of * an API component * @param type the kind of the element to look for info for - * + * * @return the cached {@link IApiElement} or <code>null</code> if no such * element is cached */ @@ -244,11 +244,11 @@ public final class ApiModelCache { /** * Removes the {@link IApiElement} from the given component (given its id) * with the given identifier and of the given type. - * + * * @param componentid the id of the component the element resides in * @param identifier the id (name) of the element to remove * @param type the type of the element (TYPE, METHOD, FIELD, etc) - * + * * @return true if the element was removed, false otherwise */ public boolean removeElementInfo(String baselineid, String componentid, String identifier, int type) { @@ -322,7 +322,7 @@ public final class ApiModelCache { /** * Removes the given {@link IApiElement} info from the cache and returns it * if present - * + * * @param element * @return true if the {@link IApiElement} was removed false otherwise * @throws CoreException if there is a problem accessing any of the @@ -383,7 +383,7 @@ public final class ApiModelCache { /** * Returns if the cache has any elements in it or not - * + * * @return true if the cache has no entries, false otherwise */ public boolean isEmpty() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelFactory.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelFactory.java index 17f4115fef..26e25a43d3 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelFactory.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiModelFactory.java @@ -47,7 +47,7 @@ import org.eclipse.pde.internal.core.target.WorkspaceFileTargetHandle; * Utility class for creating new * {@link org.eclipse.pde.api.tools.internal.provisional.model.IApiElement}s and * for performing common tasks on them - * + * * @since 1.0.0 */ public class ApiModelFactory { @@ -64,7 +64,7 @@ public class ApiModelFactory { /** * {@link FilenameFilter} for CVS files - * + * * @since 1.0.1 */ static class CVSNameFilter implements FilenameFilter { @@ -93,7 +93,7 @@ public class ApiModelFactory { * specified location or <code>null</code> if the location specified does * not contain a valid API component. The component is not added to the * baseline. - * + * * @param location absolute path in the local file system to the API * component * @return API component or <code>null</code> if the location specified does @@ -113,7 +113,7 @@ public class ApiModelFactory { * given model or <code>null</code> if the given model cannot be resolved or * does not contain a valid API component. The component is not added to the * baseline. - * + * * @param baseline * @param model the given model * @return API component or <code>null</code> if the given model cannot be @@ -148,7 +148,7 @@ public class ApiModelFactory { * API nature), as we still need them to make a complete API baseline * without resolution errors. * </p> - * + * * @param location * @return true if the location is an imported binary project, false * otherwise @@ -170,7 +170,7 @@ public class ApiModelFactory { * non-OSGi environment must have its execution environment specified at * creation time. * </p> - * + * * @param name baseline name * @return a new empty {@link IApiBaseline} */ @@ -188,7 +188,7 @@ public class ApiModelFactory { * <code>http://wiki.eclipse.org/index.php/Execution_Environment_Descriptions</code> * . * </p> - * + * * @param name baseline name * @param eeDescription execution environment description file * @return a new {@link IApiBaseline} @@ -209,7 +209,7 @@ public class ApiModelFactory { * non-OSGi environment must have its execution environment specified at * creation time. * </p> - * + * * @param name baseline name * @param location the given baseline's location * @return a new empty {@link IApiBaseline} @@ -230,7 +230,7 @@ public class ApiModelFactory { * <code>http://wiki.eclipse.org/index.php/Execution_Environment_Descriptions</code> * . * </p> - * + * * @param name baseline name * @param eeDescription execution environment description file * @param location the given baseline's location @@ -246,7 +246,7 @@ public class ApiModelFactory { * Collects API components for the bundles part of the specified * installation and adds them to the baseline. The components that were * added to the baseline are returned. - * + * * @param baseline The baseline to add the components to * @param installLocation location of an installation that components are * collected from @@ -356,7 +356,7 @@ public class ApiModelFactory { * <code>target:/targetSeq/definitionLocation</code>. A location must be * compatible with * {@link org.eclipse.core.runtime.Path#fromPortableString(String)}. - * + * * @param definition the target platform definition * @return an encoded location * @see #isDerivedFromTarget @@ -375,7 +375,7 @@ public class ApiModelFactory { /** * Return a stable identifier for the provided definition. - * + * * @param definition * @return a stable identifier, in portable OS format as per * {@link org.eclipse.core.runtime.Path#fromPortableString(String)}. @@ -402,7 +402,7 @@ public class ApiModelFactory { * Return true if the provided profile seems to have been derived from the * given target definition. The target definition may have evolved since * originally created. - * + * * @param profile the API profile * @param definition the target definition * @return true if the profile was derived from the given definition @@ -430,7 +430,7 @@ public class ApiModelFactory { /** * Return true if the provided profile is up-to-date with the given target * definition - * + * * @param profile the API profile * @param definition the target definition * @return true if the profile is up-to-date diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiType.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiType.java index 88ae4d466b..cbea89a8bc 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiType.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ApiType.java @@ -43,7 +43,7 @@ import com.ibm.icu.text.MessageFormat; /** * Base implementation of {@link IApiType} - * + * * @since 1.0.0 * @noextend This class is not intended to be sub-classed by clients. * @noinstantiate This class is not intended to be instantiated by clients. @@ -139,7 +139,7 @@ public class ApiType extends ApiMember implements IApiType { * Creates an API type. Note that if an API component is not specified, then * some operations will not be available (navigating super types, member * types, etc). - * + * * @param parent the parent {@link IApiElement} or <code>null</code> if none * @param name the name of the type * @param signature the signature of the type @@ -186,7 +186,7 @@ public class ApiType extends ApiMember implements IApiType { /** * Used when building a type structure. - * + * * @param name method name * @param signature method signature * @param genericSig @@ -204,7 +204,7 @@ public class ApiType extends ApiMember implements IApiType { /** * Used when building a type structure. - * + * * @param name field name * @param signature field signature * @param genericSig @@ -284,7 +284,7 @@ public class ApiType extends ApiMember implements IApiType { /** * Resolves and returns the specified fully qualified type name or * <code>null</code> if none. - * + * * @param qName qualified name * @return type or <code>null</code> * @throws CoreException if unable to resolve @@ -306,7 +306,7 @@ public class ApiType extends ApiMember implements IApiType { * Throws an exception due to the fact an API component was not provided * when this type was created and is now required to perform navigation or * resolution. - * + * * @throws CoreException */ private void requiresApiComponent() throws CoreException { @@ -369,7 +369,7 @@ public class ApiType extends ApiMember implements IApiType { /** * Sets the signature of the method that encloses this local type - * + * * @param signature the signature of the method. * @see org.eclipse.jdt.core.Signature for more information */ @@ -462,7 +462,7 @@ public class ApiType extends ApiMember implements IApiType { /** * Used when building a type structure. - * + * * @param name member type name * @param modifiers */ 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 7a15a35d08..92abe0799f 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 @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -34,7 +34,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * {@link IApiTypeContainer} container for an archive (jar or zip) file. - * + * * @since 1.0.0 */ public class ArchiveApiTypeContainer extends ApiElement implements IApiTypeContainer { @@ -48,7 +48,7 @@ public class ArchiveApiTypeContainer extends ApiElement implements IApiTypeConta /** * Constructs a new handle to an {@link IApiTypeRoot} in the archive. - * + * * @param container archive * @param entryName zip entry name */ @@ -158,7 +158,7 @@ public class ArchiveApiTypeContainer extends ApiElement implements IApiTypeConta /** * Constructs an {@link IApiTypeContainer} container for the given jar or * zip file at the specified location. - * + * * @param parent the parent {@link IApiElement} or <code>null</code> if none * @param path location of the file in the local file system */ @@ -253,7 +253,7 @@ public class ArchiveApiTypeContainer extends ApiElement implements IApiTypeConta /** * Initializes cache of packages and types. - * + * * @throws CoreException */ private synchronized void init() 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 25900aa686..7866dafeec 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 @@ -82,7 +82,7 @@ import org.xml.sax.SAXException; /** * Implementation of an API component based on a bundle in the file system. - * + * * @since 1.0.0 */ public class BundleComponent extends Component { @@ -149,7 +149,7 @@ public class BundleComponent extends Component { /** * Constructs a new API component from the specified location in the file * system in the given baseline. - * + * * @param baseline owning API baseline * @param location directory or jar file * @param bundleid @@ -178,7 +178,7 @@ public class BundleComponent extends Component { /** * Returns this bundle's manifest as a dictionary or <code>null</code> if no * manifest was found. - * + * * @return manifest dictionary or <code>null</code> * @exception CoreException if something goes terribly wrong */ @@ -230,7 +230,7 @@ public class BundleComponent extends Component { /** * Returns if the bundle at the specified location is a valid bundle or not. * Validity is determined via the existence of a readable manifest file - * + * * @param location * @return true if the bundle at the given location is valid false otherwise * @throws IOException @@ -256,7 +256,7 @@ public class BundleComponent extends Component { /** * Initializes the component - * + * * @throws CoreException on failure */ protected synchronized void init() { @@ -287,7 +287,7 @@ public class BundleComponent extends Component { /** * Returns if this component is a a binary bundle in the workspace i.e. an * imported binary bundle - * + * * @return true if the component is a binary bundle in the workspace, false * otherwise */ @@ -297,7 +297,7 @@ public class BundleComponent extends Component { /** * Returns the {@link State} from the backing baseline - * + * * @return the state from the backing {@link ApiBaseline} */ protected State getState() { @@ -307,7 +307,7 @@ public class BundleComponent extends Component { /** * Returns the {@link BundleDescription} for the given manifest + state or * throws an exception, never returns <code>null</code> - * + * * @param manifest * @param location * @param id @@ -330,7 +330,7 @@ public class BundleComponent extends Component { /** * Tries to look up the bundle described by the given manifest in the given * state - * + * * @param manifest * @return the bundle for the given manifest, <code>null</code> otherwise * @throws BundleException @@ -354,7 +354,7 @@ public class BundleComponent extends Component { /** * Returns whether this API component represents a binary bundle versus a * project bundle. - * + * * @return whether this API component represents a binary bundle */ protected boolean isBinary() { @@ -388,7 +388,7 @@ public class BundleComponent extends Component { /** * Creates and returns this component's API description based on packages * supplied by this component, exported packages, and associated directives. - * + * * @return API description * @throws CoreException if unable to initialize */ @@ -411,7 +411,7 @@ public class BundleComponent extends Component { /** * Returns the names of all packages that originate from this bundle. Does * not include packages that originate from fragments or a host. - * + * * @return local package names * @throws CoreException */ @@ -438,7 +438,7 @@ public class BundleComponent extends Component { * for packages that originate from fragments). However, a host's API * description will be represented by a proxy that delegates to the host and * all of its fragments to provide a complete description of the host. - * + * * @param apiDesc API description to initialize * @param bundle the bundle to load from * @param packages the complete set of packages names originating from the @@ -475,7 +475,7 @@ public class BundleComponent extends Component { /** * Adds package exports to the given list if the associated package * originates from this bundle. - * + * * @param packages names of packages supplied by this bundle * @param supplied list to append package exports to * @param exportPackages package exports to consider @@ -496,7 +496,7 @@ public class BundleComponent extends Component { /** * Annotates the API description with exported packages. - * + * * @param apiDesc description to annotate * @param exportedPackages packages that are exported */ @@ -611,7 +611,7 @@ public class BundleComponent extends Component { /** * Returns whether this API component is enabled for API analysis by the API * builder. - * + * * @return whether this API component is enabled for API analysis by the API * builder. */ @@ -621,7 +621,7 @@ public class BundleComponent extends Component { /** * Returns classpath entries defined in the given manifest. - * + * * @param manifest * @return classpath entries as bundle relative paths * @throws BundleException @@ -646,7 +646,7 @@ public class BundleComponent extends Component { * this bundle, or <code>null</code> if the {@link IApiTypeContainer} does * not exist. The path is the name (path) of entries specified by the * <code>Bundle-ClassPath:</code> header. - * + * * @param path relative path to a class file container in this bundle * @return {@link IApiTypeContainer} or <code>null</code> * @throws IOException @@ -723,7 +723,7 @@ public class BundleComponent extends Component { * Extracts a directory from the archive given a path prefix for entries to * retrieve. <code>null</code> can be passed in as a prefix, causing all * entries to be be extracted from the archive. - * + * * @param zip the {@link ZipFile} to extract from * @param pathprefix the prefix'ing path to include for extraction * @param parent the parent directory to extract to @@ -751,7 +751,7 @@ public class BundleComponent extends Component { /** * Extracts a non-directory entry from a zip file and returns the File * handle - * + * * @param zip the zip to extract from * @param entry the entry to extract * @param parent the parent directory to add the extracted entry to @@ -817,7 +817,7 @@ public class BundleComponent extends Component { /** * Reads and returns the file contents corresponding to the given file name. * The bundle may be in a jar or in a directory at the specified location. - * + * * @param xmlFileName the given file name * @param bundleLocation the root location of the bundle * @return the file contents or <code>null</code> if not present @@ -854,7 +854,7 @@ public class BundleComponent extends Component { /** * Parses a bundle's .api_description XML into a string. The file may be in * a jar or in a directory at the specified location. - * + * * @param bundleLocation root location of the bundle * @return API description XML as a string or <code>null</code> if none * @throws IOException if unable to parse @@ -892,7 +892,7 @@ public class BundleComponent extends Component { /** * Returns a URL describing a file inside a bundle. - * + * * @param bundleLocation root location of the bundle. May be a directory or * a file (jar) * @param filePath bundle relative path to desired file @@ -961,7 +961,7 @@ public class BundleComponent extends Component { /** * Returns this component's bundle description. - * + * * @return bundle description */ public synchronized BundleDescription getBundleDescription() throws CoreException { @@ -1044,7 +1044,7 @@ public class BundleComponent extends Component { /** * Check if the given source contains an source extension point. - * + * * @param pluginXMLContents the given file contents * @return true if it contains a source extension point, false otherwise */ @@ -1111,7 +1111,7 @@ public class BundleComponent extends Component { /** * Sets whether this bundle has an underlying API description file. - * + * * @param hasApiDescription whether this bundle has an underlying API * description file */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/Component.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/Component.java index ace0b87265..fe65bafa60 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/Component.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/Component.java @@ -27,7 +27,7 @@ import org.eclipse.pde.api.tools.internal.search.UseScanReferences; /** * Common implementation of an API component as a composite class file * container. - * + * * @since 1.0.0 */ public abstract class Component extends AbstractApiTypeContainer implements IApiComponent { @@ -48,7 +48,7 @@ public abstract class Component extends AbstractApiTypeContainer implements IApi /** * Constructs an API component in the given {@link IApiBaseline}. - * + * * @param baseline the parent {@link IApiBaseline} */ public Component(IApiBaseline baseline) { @@ -101,7 +101,7 @@ public abstract class Component extends AbstractApiTypeContainer implements IApi /** * Returns whether this component has created an API description. - * + * * @return whether this component has created an API description */ protected synchronized boolean isApiDescriptionInitialized() { @@ -110,7 +110,7 @@ public abstract class Component extends AbstractApiTypeContainer implements IApi /** * Returns if this component has created an API filter store - * + * * @return true if a store has been created, false other wise */ protected synchronized boolean hasApiFilterStore() { @@ -133,7 +133,7 @@ public abstract class Component extends AbstractApiTypeContainer implements IApi /** * Creates and returns the API description for this component. - * + * * @return newly created API description for this component */ protected abstract IApiDescription createApiDescription() throws CoreException; @@ -158,7 +158,7 @@ public abstract class Component extends AbstractApiTypeContainer implements IApi /** * Lazily creates a new {@link IApiFilterStore} when it is requested - * + * * @return the current {@link IApiFilterStore} for this component * @throws CoreException */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/CompositeApiTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/CompositeApiTypeContainer.java index 67659d58cd..93a9bee7bf 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/CompositeApiTypeContainer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/CompositeApiTypeContainer.java @@ -19,7 +19,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer; /** * A collection of class file containers. - * + * * @since 1.0 */ public class CompositeApiTypeContainer extends AbstractApiTypeContainer { @@ -28,7 +28,7 @@ public class CompositeApiTypeContainer extends AbstractApiTypeContainer { /** * Constructs a composite container on the given list of containers. - * + * * @param containers list of containers */ public CompositeApiTypeContainer(IApiElement parent, List<IApiTypeContainer> containers) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/DirectoryApiTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/DirectoryApiTypeContainer.java index a3d88de0bd..54c2afe39a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/DirectoryApiTypeContainer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/DirectoryApiTypeContainer.java @@ -34,7 +34,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * An {@link IApiTypeContainer} rooted at a directory in the file system. - * + * * @since 1.0.0 */ public class DirectoryApiTypeContainer extends ApiElement implements IApiTypeContainer { @@ -48,7 +48,7 @@ public class DirectoryApiTypeContainer extends ApiElement implements IApiTypeCon /** * Constructs a class file on the given file - * + * * @param directory the parent {@link IApiElement} directory * @param location * @param qualified type name @@ -118,7 +118,7 @@ public class DirectoryApiTypeContainer extends ApiElement implements IApiTypeCon /** * Constructs an {@link IApiTypeContainer} rooted at the specified path. - * + * * @param parent the parent {@link IApiElement} or <code>null</code> if none * @param location absolute path in the local file system */ @@ -231,7 +231,7 @@ public class DirectoryApiTypeContainer extends ApiElement implements IApiTypeCon /** * Traverses a directory to determine if it has class files and then visits * sub-directories. - * + * * @param packageName package name of directory being visited * @param dir directory being visited */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/MethodKey.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/MethodKey.java index 269118e455..36bea3501c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/MethodKey.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/MethodKey.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.model; /** * A key for a method - name & signature based. - * + * * @since 1.1 */ public class MethodKey { @@ -23,7 +23,7 @@ public class MethodKey { /** * Constructs a new method key - * + * * @param typename the name (fully qualified or otherwise) of the type the * method is from * @param name method name the name of the method @@ -60,7 +60,7 @@ public class MethodKey { * <li>both are equal</li> * <li>both are <code>null</code></li> * </ul> - * + * * @param sig1 * @param sig2 * @return <code>true</code> if the signatures are equal <code>false</code> diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectComponent.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectComponent.java index 0f3ebd556a..3ee5e0c585 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectComponent.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectComponent.java @@ -51,14 +51,14 @@ import org.osgi.framework.BundleException; * <p> * Note: this class requires a running workspace to be instantiated. * </p> - * + * * @since 1.0.0 */ public class ProjectComponent extends BundleComponent { /** * Constant used to describe the custom build.properties entry - * + * * @since 1.0.3 */ public static final String ENTRY_CUSTOM = "custom"; //$NON-NLS-1$ @@ -66,7 +66,7 @@ public class ProjectComponent extends BundleComponent { /** * Constant used to describe build.properties that start with * <code>extra.</code> - * + * * @since 1.0.3 */ public static final String EXTRA_PREFIX = "extra."; //$NON-NLS-1$ @@ -94,7 +94,7 @@ public class ProjectComponent extends BundleComponent { /** * Constructs an API component for the given Java project in the specified * baseline. - * + * * @param baseline the owning API baseline * @param location the given location of the component * @param model the given model @@ -135,7 +135,7 @@ public class ProjectComponent extends BundleComponent { /** * Returns the {@link IPluginModelBase} backing this component - * + * * @return the {@link IPluginModelBase} or throws and exception, never * retruns <code>null</code> * @throws CoreException @@ -341,7 +341,7 @@ public class ProjectComponent extends BundleComponent { /** * Finds and returns an existing {@link IApiTypeContainer} at the specified * location in this project, or <code>null</code> if none. - * + * * @param location project relative path to the class file container * @return {@link IApiTypeContainer} or <code>null</code> */ @@ -362,7 +362,7 @@ public class ProjectComponent extends BundleComponent { * folder, or <code>null</code> if it does not exist. If the source folder * shares an output location with a previous source folder, the output * location is shared (a new one is not created). - * + * * @param location project relative path to the source folder * @return {@link IApiTypeContainer} or <code>null</code> */ @@ -413,7 +413,7 @@ public class ProjectComponent extends BundleComponent { /** * Returns the Java project associated with this component. - * + * * @return associated Java project */ public IJavaProject getJavaProject() { @@ -426,7 +426,7 @@ public class ProjectComponent extends BundleComponent { * a SOURCE package fragment - this method is only used by the project API * description to obtain a class file corresponding to a compilation unit * when tag scanning (to resolve signatures). - * + * * @param root source package fragment root * @return API type container associated with the package fragment root, or * <code>null</code> if none diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectTypeContainer.java index a6935c4627..24de438b4d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectTypeContainer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ProjectTypeContainer.java @@ -32,14 +32,14 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * An {@link IApiTypeRoot} rooted at a project output container in the * workspace. - * + * * @since 1.0.0 */ public class ProjectTypeContainer extends ApiElement implements IApiTypeContainer { /** * Proxy visitor for collecting package names, etc for our type containers - * + * * @since 1.1 */ class ContainerVisitor implements IResourceProxyVisitor { @@ -49,7 +49,7 @@ public class ProjectTypeContainer extends ApiElement implements IApiTypeContaine /** * Constructor - * + * * @param collector * @param root */ @@ -76,7 +76,7 @@ public class ProjectTypeContainer extends ApiElement implements IApiTypeContaine /** * Constructs an {@link IApiTypeContainer} rooted at the location. - * + * * @param parent the {@link IApiElement} parent for this container * @param container folder in the workspace */ @@ -116,7 +116,7 @@ public class ProjectTypeContainer extends ApiElement implements IApiTypeContaine /** * Visits the given {@link IContainer} - * + * * @param container * @param pkgName * @param visitor @@ -205,7 +205,7 @@ public class ProjectTypeContainer extends ApiElement implements IApiTypeContaine /** * Traverses a directory to determine if it has {@link IApiTypeRoot}s and * then visits sub-directories. - * + * * @param packageName package name of directory being visited * @param dir directory being visited */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ResourceApiTypeRoot.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ResourceApiTypeRoot.java index 87f486fa9b..1777708ca5 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ResourceApiTypeRoot.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/ResourceApiTypeRoot.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * A class file corresponding to a resource in the workspace. - * + * * @since 1.0 */ public class ResourceApiTypeRoot extends AbstractApiTypeRoot { @@ -34,7 +34,7 @@ public class ResourceApiTypeRoot extends AbstractApiTypeRoot { /** * Constructs an {@link IApiTypeRoot} on the underlying file. - * + * * @param parent the {@link IApiElement} parent or <code>null</code> if none * @param file underlying resource * @param component API component the class file originates from diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubApiComponent.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubApiComponent.java index 898f3577e2..7f40afcdbe 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubApiComponent.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubApiComponent.java @@ -36,7 +36,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer; /** * An API component for a system library. - * + * * @since 1.0.0 */ public class StubApiComponent extends SystemLibraryApiComponent { @@ -102,7 +102,7 @@ public class StubApiComponent extends SystemLibraryApiComponent { /** * Returns a listing of all of the installed meta-data or an empty array, * never <code>null</code> - * + * * @return list of installed meta-data or an empty list, never * <code>null</code> */ @@ -141,7 +141,7 @@ public class StubApiComponent extends SystemLibraryApiComponent { /** * Constructs a system library from the given execution environment * description file. - * + * * @param baseline owning baseline * @param fileName the file name that corresponds to the stub file for the * corresponding profile diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubArchiveApiTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubArchiveApiTypeContainer.java index b4fd27842d..dbab92ac17 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubArchiveApiTypeContainer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/StubArchiveApiTypeContainer.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -35,7 +35,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * {@link IApiTypeContainer} container for an archive (jar or zip) file. - * + * * @since 1.0.0 */ public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeContainer { @@ -54,7 +54,7 @@ public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeC /** * Constructs a new handle to an {@link IApiTypeRoot} in the archive. - * + * * @param container archive * @param entryName zip entry name */ @@ -150,7 +150,7 @@ public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeC /** * Constructs an {@link IApiTypeContainer} container for the given jar or * zip file at the specified location. - * + * * @param parent the parent {@link IApiElement} or <code>null</code> if none * @param path location of the file in the local file system */ @@ -253,7 +253,7 @@ public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeC /** * Initializes cache of packages and types. - * + * * @throws CoreException */ private synchronized void init() throws CoreException { @@ -281,7 +281,7 @@ public class StubArchiveApiTypeContainer extends ApiElement implements IApiTypeC /** * Returns an open zip file for this archive. - * + * * @return zip file * @throws IOException if unable to open the archive */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/SystemLibraryApiComponent.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/SystemLibraryApiComponent.java index 4d513377fc..d1d986b8c6 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/SystemLibraryApiComponent.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/SystemLibraryApiComponent.java @@ -29,7 +29,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer; /** * An API component for a system library. - * + * * @since 1.0.0 */ public class SystemLibraryApiComponent extends Component { @@ -61,7 +61,7 @@ public class SystemLibraryApiComponent extends Component { /** * Constructs a system library. - * + * * @param baseline owning baseline */ protected SystemLibraryApiComponent(IApiBaseline baseline) { @@ -71,7 +71,7 @@ public class SystemLibraryApiComponent extends Component { /** * Constructs a system library from the given execution environment * description file. - * + * * @param baseline owning baseline * @param description EE file * @param systemPackages exported system packages @@ -145,7 +145,7 @@ public class SystemLibraryApiComponent extends Component { /** * Initializes properties from the EE file. - * + * * @param description EE file */ private void init(ExecutionEnvironmentDescription description) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/TypeStructureBuilder.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/TypeStructureBuilder.java index 448b9ec3ae..abf971e004 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/TypeStructureBuilder.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/TypeStructureBuilder.java @@ -48,7 +48,7 @@ public class TypeStructureBuilder extends ClassVisitor { * Builds a type structure for a class file. Note that if an API component * is not specified, then some operations on the resulting {@link IApiType} * will not be available (navigating super types, member types, etc). - * + * * @param cv class file visitor * @param component originating API component or <code>null</code> if * unknown @@ -247,7 +247,7 @@ public class TypeStructureBuilder extends ClassVisitor { /** * Builds a type structure with the given .class file bytes in the specified * API component. - * + * * @param bytes class file bytes * @param component originating API component * @param file associated class file @@ -271,7 +271,7 @@ public class TypeStructureBuilder extends ClassVisitor { /** * Builds a type structure with the given .class file bytes in the specified * API component. - * + * * @param bytes class file bytes * @param component originating API component * @param file associated class file diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/WorkspaceBaseline.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/WorkspaceBaseline.java index 6c0ba8e6f6..f734034a9c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/WorkspaceBaseline.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/model/WorkspaceBaseline.java @@ -21,7 +21,7 @@ import org.eclipse.pde.internal.core.PDECore; /** * Describes the workspace baseline. Tracks the PDE model for the workspace - * + * * @since 1.1 */ public class WorkspaceBaseline extends ApiBaseline { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/natures/ApiToolProjectNature.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/natures/ApiToolProjectNature.java index c4500c19a9..d0115a63f6 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/natures/ApiToolProjectNature.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/natures/ApiToolProjectNature.java @@ -39,7 +39,7 @@ public class ApiToolProjectNature implements IProjectNature { /** * Retrieve the current project - * + * * @return the current project */ @Override diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblem.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblem.java index 1ec1e0637e..6130238e1c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblem.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblem.java @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * A description of an API problem - * + * * @since 1.0.0 */ public class ApiProblem implements IApiProblem { @@ -83,7 +83,7 @@ public class ApiProblem implements IApiProblem { /** * Constructor - * + * * @param resource the resource this problem occurs on / in * @param typeName the qualified type name this problem occurs on / in * @param messageargs arguments to be passed into a localized message for @@ -237,7 +237,7 @@ public class ApiProblem implements IApiProblem { /** * Compares the complete list of message arguments - * + * * @param arguments * @return true if all of the arguments are equal, false otherwise */ @@ -258,7 +258,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the deep hash code of the complete listing of message arguments - * + * * @param arguments * @return the hash code of the message arguments */ @@ -308,7 +308,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of an element descriptor type or * <code>null</code> if the kind is unknown - * + * * @param kind * @return the string of the kind or <code>null</code> */ @@ -337,7 +337,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the kind of since tab api problem - * + * * @param kind * @return the string for the since tag api problem kind */ @@ -357,7 +357,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the kind of usage problem for an * {@link IApiProblem} kind - * + * * @param kind * @return the string for the usage API problem kind */ @@ -390,7 +390,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the version problem kind. - * + * * @param kind * @return the string of the version API problem kind */ @@ -415,7 +415,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the API component problem kind - * + * * @param kind * @return the string of the API component problem kind */ @@ -431,7 +431,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the API baseline problem kind - * + * * @param kind * @return the string of the API baseline problem kind */ @@ -448,7 +448,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the API Use Scan breakage problem * kind - * + * * @param kind * @return */ @@ -459,7 +459,7 @@ public class ApiProblem implements IApiProblem { case IApiProblem.API_USE_SCAN_METHOD_PROBLEM: return "API_USE_SCAN_METHOD_PROBLEM"; //$NON-NLS-1$ case IApiProblem.API_USE_SCAN_FIELD_PROBLEM: - return "API_USE_SCAN_FIELD_PROBLEM"; //$NON-NLS-1$ + return "API_USE_SCAN_FIELD_PROBLEM"; //$NON-NLS-1$ default: return Util.UNKNOWN_KIND; } @@ -469,7 +469,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the kind of an {@link IApiProblem}, * given its category - * + * * @param category * @param kind * @return the string of the {@link IApiProblem} kind @@ -497,7 +497,7 @@ public class ApiProblem implements IApiProblem { /** * Return the string representation of the flags for a problem - * + * * @param category * @param flags * @return the string for the problem flags @@ -556,7 +556,7 @@ public class ApiProblem implements IApiProblem { /** * Returns the string representation of the element kind of an * {@link IApiProblem}, given its category - * + * * @param category * @param kind * @return the string of the {@link IApiProblem} element kind @@ -584,7 +584,7 @@ public class ApiProblem implements IApiProblem { /** * Returns a string representation of the category of an API problem - * + * * @param category * @return the string of the API problem category */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFactory.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFactory.java index 8293b7670d..6b38a7ae44 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFactory.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFactory.java @@ -34,7 +34,7 @@ import com.ibm.icu.text.MessageFormat; /** * Factory for creating {@link IApiProblem}s - * + * * @since 1.0.0 */ public class ApiProblemFactory { @@ -48,7 +48,7 @@ public class ApiProblemFactory { /** * Creates a new {@link IApiProblemFilter} - * + * * @param componentid * @param problem * @param comment @@ -62,7 +62,7 @@ public class ApiProblemFactory { /** * Computes an {@link IApiProblem} hashcode from the given filter handle. If * the handle is <code>null</code> this method returns <code>-1</code>. - * + * * @param filterhandle the problem handle * @return a new hashcode for the {@link IApiProblem} described in the * filter or <code>-1</code> @@ -98,7 +98,7 @@ public class ApiProblemFactory { /** * Returns the deep hash code of the complete listing of message arguments - * + * * @param arguments * @return the hash code of the message arguments */ @@ -174,7 +174,7 @@ public class ApiProblemFactory { /** * Creates a new {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -200,7 +200,7 @@ public class ApiProblemFactory { /** * Creates a new {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -220,7 +220,7 @@ public class ApiProblemFactory { /** * Creates a new API usage {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -242,7 +242,7 @@ public class ApiProblemFactory { /** * Creates a new API usage {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -265,7 +265,7 @@ public class ApiProblemFactory { /** * Creates a new API baseline {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * The arguments are passed into the string in the order they * appear in the array. @@ -282,7 +282,7 @@ public class ApiProblemFactory { /** * Creates a new API component resolution {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param messageargs listing of arguments to pass in to the localized * message. The arguments are passed into the string in the order @@ -300,7 +300,7 @@ public class ApiProblemFactory { /** * Creates a new fatal {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param messageargs listing of arguments to pass in to the localized * message. The arguments are passed into the string in the order @@ -315,7 +315,7 @@ public class ApiProblemFactory { /** * Creates a new since tag {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -337,7 +337,7 @@ public class ApiProblemFactory { /** * Creates a new version number {@link IApiProblem} - * + * * @param resourcepath the path to the resource this problem was found in * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -359,7 +359,7 @@ public class ApiProblemFactory { /** * Creates a new API Use Scan breakage {@link IApiProblem} - * + * * @param resourcePath path of the resource associated with the problem * @param typeName the type name this problem was found in * @param messageargs listing of arguments to pass in to the localized @@ -385,12 +385,12 @@ public class ApiProblemFactory { /** * Returns the localized message for the given {@link IApiProblem}. Returns * <code>null</code> if no localized message cannot be created. - * + * * @param problemid the id of the problem to create a message for * @param arguments the arguments to pass into the localized string. The * arguments are passed in to the string in the order they appear * in the array. - * + * * @return a localized message for the given {@link IApiProblem} or * <code>null</code> */ @@ -402,7 +402,7 @@ public class ApiProblemFactory { * Returns the localized message for the given problem id and message * arguments. Returns a not found message if no localized message cannot be * created. - * + * * @param messageid * @param messageargs * @return a localized message for the given arguments or a 'not found' @@ -441,7 +441,7 @@ public class ApiProblemFactory { /** * This method initializes the MessageTemplates class variable according to * the current Locale. - * + * * @param loc Locale * @return HashtableOfInt */ @@ -473,7 +473,7 @@ public class ApiProblemFactory { /** * Creates a problem id from the composite members of a problem id. - * + * * @param category * @param element * @param kind @@ -488,7 +488,7 @@ public class ApiProblemFactory { * Returns the {@link IApiProblem} id from the given marker or * <code>-1</code> if the marker is <code>null</code> or the marker does not * contain the {@link IApiMarkerConstants#MARKER_ATTR_PROBLEM_ID} attribute - * + * * @param marker * @return the {@link IApiProblem} id or <code>-1</code> * @since 1.0.400 @@ -503,10 +503,10 @@ public class ApiProblemFactory { /** * Returns the kind of the problem from the given problem id. The returned * kind is not checked to see if it is correct or existing. - * + * * @see IApiProblem#getKind() * @see IDelta#getKind() - * + * * @param problemid * @return the kind from the given problem id */ @@ -517,10 +517,10 @@ public class ApiProblemFactory { /** * Returns the kind of element from the given problem id. The returned * element kind is not checked to see if it is correct or existing. - * + * * @see IElementDescriptor#getElementType() * @see IDelta#getElementType() - * + * * @param problemid * @return the element kind from the given problem id */ @@ -531,9 +531,9 @@ public class ApiProblemFactory { /** * Returns the flags from the given problem id. The returned flags are not * checked to see if they are correct or existing. - * + * * @see IDelta#getFlags() - * + * * @param problemid * @return the flags from the given problem id */ @@ -544,9 +544,9 @@ public class ApiProblemFactory { /** * Returns the category of the given problem id. The returned category is * not checked to see if it is correct or existing. - * + * * @see IApiProblem#getCategory() - * + * * @param problemid * @return the category of this problem id */ @@ -556,7 +556,7 @@ public class ApiProblemFactory { /** * Convenience method to get the message id from a problem id - * + * * @param problemid * @return the message id to use for the given problem id */ @@ -566,7 +566,7 @@ public class ApiProblemFactory { /** * Returns the problem message id for the given problem parameters. - * + * * @param category * @param element * @param kind @@ -967,7 +967,7 @@ public class ApiProblemFactory { /** * Returns the problem severity id for the given problem parameters. - * + * * @param category * @param element * @param kind diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFilter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFilter.java index 9b22c7da67..43f5c17e32 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFilter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/problems/ApiProblemFilter.java @@ -16,7 +16,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemFilter /** * Base implementation of {@link IApiProblemFilter} - * + * * @since 1.0.0 */ public class ApiProblemFilter implements IApiProblemFilter, Cloneable { @@ -30,7 +30,7 @@ public class ApiProblemFilter implements IApiProblemFilter, Cloneable { /** * Constructor - * + * * @param componentid * @param problem * @param comment @@ -49,7 +49,7 @@ public class ApiProblemFilter implements IApiProblemFilter, Cloneable { /** * Sets the comment for this filter. - * + * * @param comment the comment or <code>null</code> to remove the existing * comment * @since 1.1 @@ -86,7 +86,7 @@ public class ApiProblemFilter implements IApiProblemFilter, Cloneable { * <li>they are both null</li> * <li>they are equal via the default .equals() method</li> * </ol> - * + * * @param s1 * @param s2 * @return true if the objects are equal, false otherwise diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiDescriptionVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiDescriptionVisitor.java index dc1a237b90..c0aa9709be 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiDescriptionVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ApiDescriptionVisitor.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri * </p> * <p> * Specific visit ordering: - * + * * <pre> * ComponentDescription := [visitElement[PackageDescription] endVisitElement[PackageDescription]]* * PackageDescription := [visitElement[TypeDescription] endVisitElement[TypeDescription]]* @@ -30,11 +30,11 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri * MemberDescription := MethodDescription | FieldDescription * OverrideDescription := PackageDescription | TypeDescription | MethodDescription | FieldDescription * </pre> - * + * * MemberDescriptions are visited in the order they are keyed for the backing * {@link HashMap} * </p> - * + * * @since 1.0.0 */ public abstract class ApiDescriptionVisitor { @@ -46,7 +46,7 @@ public abstract class ApiDescriptionVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param element element being visited * @param description description of the element visited * @return whether child elements should be visited @@ -60,7 +60,7 @@ public abstract class ApiDescriptionVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param element element being end-visited * @param description description of the element end-visited */ 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 f33548ba81..d6c0d20bb7 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 @@ -54,7 +54,7 @@ import org.osgi.service.prefs.BackingStoreException; /** * API Tools core plug-in. API tools can be run with or without an OSGi * framework. - * + * * @since 1.0.0 */ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsListener { @@ -383,7 +383,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Logs the specified status with this plug-in's log. - * + * * @param status status to log */ public static void log(IStatus status) { @@ -436,7 +436,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Logs the specified throwable with this plug-in's log. - * + * * @param t throwable to log */ public static void log(Throwable t) { @@ -445,19 +445,19 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Logs an internal error with the specified message. - * + * * @param message the error message to log */ public static void logErrorMessage(String message) { // this message is intentionally not internationalized, as an exception // may // be due to the resource bundle itself - log(newErrorStatus("Internal message logged from API Tools Core: " + message, null)); //$NON-NLS-1$ + log(newErrorStatus("Internal message logged from API Tools Core: " + message, null)); //$NON-NLS-1$ } /** * Returns a new error status for this plug-in with the given message - * + * * @param message the message to be included in the status * @param exception the exception to be included in the status or * <code>null</code> if none @@ -469,7 +469,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Returns whether the API tools bundle is running inside an OSGi framework. - * + * * @return whether the API tools bundle is running inside an OSGi framework */ public static boolean isRunningInFramework() { @@ -481,7 +481,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL * and search for * {@link org.eclipse.pde.api.tools.internal.provisional.model.IApiBaseline} * s stored in the manager. - * + * * @return the singleton instance of the {@link IApiProfileManager} */ public IApiBaselineManager getApiBaselineManager() { @@ -502,7 +502,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL * Adds the given save participant to the listing of participants to be * notified when the workbench saving life-cycle occurs. If the specified * participant is <code>null</code> no changes are made. - * + * * @param participant */ public void addSaveParticipant(ISaveParticipant participant) { @@ -514,7 +514,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Removes the given save participant from the current listing. If the * specified participant is <code>null</code> no changes are made. - * + * * @param participant */ public void removeSaveParticipant(ISaveParticipant participant) { @@ -699,7 +699,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL * . If the project does not have project specific settings, the workspace * preference is returned. If <code>null</code> is passed in as the project * the workspace preferences are consulted. - * + * * @param prefkey the given preference key * @param project the given project or <code>null</code> * @return the severity level for the given pref key @@ -733,7 +733,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL * <li>the given array of contexts are <code>null</code></li> * <li>if no nodes could be determined from the given contexts</li> * </ul> - * + * * @param context * @return the array of {@link IEclipsePreferences} to look in or * <code>null</code>. @@ -758,7 +758,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Returns if the given project has project-specific settings. - * + * * @param project * @return true if the project has specific settings, false otherwise * @since 1.1 @@ -788,7 +788,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL * {@link IProject}. If the project does not have project specific settings, * the workspace preference is returned. If <code>null</code> is passed in * as the project the workspace preferences are consulted. - * + * * @param prefkey the given preference key * @param project the given project or <code>null</code> * @return the enable state @@ -810,7 +810,7 @@ public class ApiPlugin extends Plugin implements ISaveParticipant, DebugOptionsL /** * Returns a service with the specified name or <code>null</code> if none. - * + * * @param serviceName name of service * @return service object or <code>null</code> if none */ 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 aec2a9f74e..30de5c212f 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 @@ -38,7 +38,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; /** * Factory to create API model objects. - * + * * @since 1.0 */ public class Factory { @@ -48,7 +48,7 @@ public class Factory { * given id and an undefined version. The given id does not have to be the * id of a component that actually exists: no resolution or lookup of any * kind is done with the descriptor. - * + * * @param componentid * @return a new component descriptor */ @@ -61,7 +61,7 @@ public class Factory { * given id and version. The given id does not have to be the id of a * component that actually exists: no resolution or lookup of any kind is * done with the descriptor. - * + * * @param componentid * @param version version descriptor or <code>null</code> if none * @return a new component descriptor @@ -74,7 +74,7 @@ public class Factory { * Returns a package descriptor for the package with the given name. An * empty string indicates the default package. Package names are dot * qualified. - * + * * @param packageName package name * @return an {@link IPackageDescriptor} for the package */ @@ -86,7 +86,7 @@ public class Factory { * Utility method to create a type descriptor for a type with the given * fully qualified name. Package names are dot qualified and type names are * '$'-qualified. - * + * * @param fullyQualifiedName * @return an {@link ITypeDescriptor} for the type */ @@ -99,7 +99,7 @@ public class Factory { /** * Utility method to create a type descriptor for a method contained within * the given type - * + * * @param typename the name of the enclosing type for the method * @param name the name of the method * @param signaturethe signature of the method @@ -113,7 +113,7 @@ public class Factory { /** * Utility method to create a type descriptor for a field contained within * the given type - * + * * @param typename the name of the enclosing type for the field * @param name the name of the field * @return an {@link IFieldDescriptor} for the field @@ -125,7 +125,7 @@ public class Factory { /** * Creates a new {@link IReferenceDescriptor} object - * + * * @param origincomponent the component where the reference comes from * @param originmember the member where the reference comes from * @param line the line number of the reference or -1 if unknown @@ -151,7 +151,7 @@ public class Factory { /** * Returns a scope containing all elements in the given components. - * + * * @param components API components * @return search scope * @throws CoreException if the baseline of the given components is disposed @@ -168,7 +168,7 @@ public class Factory { /** * Returns a new scope containing the specified types in the given * component. - * + * * @param component API component * @param types reference types * @return search scope @@ -180,7 +180,7 @@ public class Factory { /** * Returns a method descriptor with a resolved signature for the given * method descriptor with an unresolved signature. - * + * * @param descriptor method to resolve * @return resolved method descriptor or the same method descriptor if * unable to resolve diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAccess.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAccess.java index 8ba858de27..87d5dcc5a5 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAccess.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAccess.java @@ -14,7 +14,7 @@ package org.eclipse.pde.api.tools.internal.provisional; * This interface describes a type of access to packages in a bundle. <br> * An example type of access would be friend access to an internal package or * SPI access to an API package. - * + * * @since 1.0.1 * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. @@ -36,7 +36,7 @@ public interface IApiAccess { /** * Returns the access level. Will be one of the constants defined in * {@link IApiAccess}. - * + * * @return the access level */ public int getAccessLevel(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAnnotations.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAnnotations.java index 252643b998..2330375275 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAnnotations.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiAnnotations.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -13,21 +13,21 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Describes API usage restrictions, visibility and profiles information of an * element contained in an API component. - * + * * @since 1.0.0 */ public interface IApiAnnotations { /** * Returns the visibility modifiers annotation. - * + * * @return a visibility constant defined by {@link VisibilityModifiers} */ public int getVisibility(); /** * Returns the restriction modifiers annotation. - * + * * @return restriction constant defined by {@link RestrictionModifiers} */ public int getRestrictions(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiBaselineManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiBaselineManager.java index 60987a5c8f..4ea6a43158 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiBaselineManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiBaselineManager.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent; /** * Interface describing the {@link IApiBaselineManager} - * + * * @noimplement This interface is not intended to be implemented by clients. * @since 1.0.0 */ @@ -27,7 +27,7 @@ public interface IApiBaselineManager { * already exists an {@link IApiBaseline} entry it will be replaced with the * new baseline provided. If <code>null</code> is passed in as a new * baseline no work is done. - * + * * @param newbaseline the new baseline to add to the manager */ public void addApiBaseline(IApiBaseline newbaseline); @@ -35,7 +35,7 @@ public interface IApiBaselineManager { /** * Returns the complete listing of {@link IApiBaseline}s contained in the * manager or an empty array, never <code>null</code>. - * + * * @return the complete listing of {@link IApiBaseline}s or an empty array */ public IApiBaseline[] getApiBaselines(); @@ -43,7 +43,7 @@ public interface IApiBaselineManager { /** * Returns the {@link IApiBaseline} object with the given id, or * <code>null</code> if there is no profile with the given id. - * + * * @param name the name of the profile to fetch * @return the {@link IApiBaseline} with the given id or <code>null</code> */ @@ -53,7 +53,7 @@ public interface IApiBaselineManager { * Removes the {@link IApiBaseline} with the given id from the manager, * which propagates to the file-system to remove the underlying stored * baseline (if it exists). - * + * * @param name the unique name of the baseline to remove from the manager * @return true if the removal was successful false otherwise. A successful * removal constitutes the associated baseline being removed from @@ -66,7 +66,7 @@ public interface IApiBaselineManager { * Allows the {@link IApiBaseline} with the specified id to be set as the * default baseline. This method will accept <code>null</code>, which will * remove a default {@link IApiBaseline} setting. - * + * * @param name the name of the {@link IApiBaseline} to be the default */ public void setDefaultApiBaseline(String name); @@ -75,7 +75,7 @@ public interface IApiBaselineManager { * Returns the {@link IApiBaseline} that is the current default, or * <code>null</code> if one has not been set, or the currently specified id * for the default baseline no longer exists. - * + * * @return the default {@link IApiBaseline} or <code>null</code> */ public IApiBaseline getDefaultApiBaseline(); @@ -90,7 +90,7 @@ public interface IApiBaselineManager { * change (for example, modification of MANIFEST.MF, build.properties, or * project build paths). * </p> - * + * * @return the workspace baseline or <code>null</code> */ public IApiBaseline getWorkspaceBaseline(); @@ -98,7 +98,7 @@ public interface IApiBaselineManager { /** * Returns the API component the workspace baseline with the given symbolic * name or <code>null</code> if none. - * + * * @param symbolicName bundle symbolic name * @return API component from the workspace baseline or <code>null</code> */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiDescription.java index 4e0ce903a5..702802011f 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiDescription.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -18,9 +18,9 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IPackageDescri /** * Describes the API of an API component. Annotates types as public API, for * private use, etc. - * + * * @noimplement This interface is not to be implemented by clients - * + * * @since 1.0 */ public interface IApiDescription { @@ -35,11 +35,11 @@ public interface IApiDescription { * Sets the visibility for the specified element in the context of the * specified component and returns a status describing whether the operation * succeeded. - * + * * @param element the element the visibility applies to * @param visibility element visibility. See * {@linkplain VisibilityModifiers} for supported modifiers - * + * * @return status of the operation */ public IStatus setVisibility(IElementDescriptor element, int visibility); @@ -47,11 +47,11 @@ public interface IApiDescription { /** * Sets the restrictions for the specified element and returns a status * describing whether the operation succeeded. - * + * * @param element the element the restrictions apply to * @param restrictions the restrictions to place on the element. See * {@linkplain RestrictionModifiers} for supported modifiers - * + * * @return status of the operation */ public IStatus setRestrictions(IElementDescriptor element, int restrictions); @@ -59,10 +59,10 @@ public interface IApiDescription { /** * Sets the superclass for the specified element and returns a status * describing whether the operation succeeded. - * + * * @param element the element the restrictions apply to * @param superclass the superclass name of the element - * + * * @return status of the operation */ public IStatus setSuperclass(IElementDescriptor element, String superclass); @@ -70,10 +70,10 @@ public interface IApiDescription { /** * Sets the superclass for the specified element and returns a status * describing whether the operation succeeded. - * + * * @param element the element the restrictions apply to * @param superclass the superclass name of the element - * + * * @return status of the operation */ public IStatus setSuperinterfaces(IElementDescriptor element, String superinterfaces); @@ -81,10 +81,10 @@ public interface IApiDescription { /** * Sets the interface flag for the specified element and returns a status * describing whether the operation succeeded. - * + * * @param element the element the restrictions apply to * @param interfaceFlag the interface flag of the element - * + * * @return status of the operation */ public IStatus setInterface(IElementDescriptor element, boolean interfaceFlag); @@ -93,11 +93,11 @@ public interface IApiDescription { * Sets the visibility for the specified element in the context of the * specified component and returns a status describing whether the operation * succeeded. - * + * * @param element the element the visibility applies to * @param visibility element visibility. See * {@linkplain VisibilityModifiers} for supported modifiers - * + * * @return status of the operation */ public IStatus setAddedProfile(IElementDescriptor element, int addedProfile); @@ -105,11 +105,11 @@ public interface IApiDescription { /** * Sets the restrictions for the specified element and returns a status * describing whether the operation succeeded. - * + * * @param element the element the restrictions apply to * @param restrictions the restrictions to place on the element. See * {@linkplain RestrictionModifiers} for supported modifiers - * + * * @return status of the operation */ public IStatus setRemovedProfile(IElementDescriptor element, int removedProfile); @@ -127,9 +127,9 @@ public interface IApiDescription { * If there is no component specific API for the specified element, the * general annotations for the element are returned. * </p> - * + * * @param element element to resolve API description for - * + * * @return API annotations or <code>null</code> */ public IApiAnnotations resolveAnnotations(IElementDescriptor element); @@ -138,10 +138,10 @@ public interface IApiDescription { * Returns the access level the given element has for the given package. If * there is no special access for the given element <code>null</code> is * returned. - * + * * @param element the element to resolve access for * @param pelement the package being accessed by the given element - * + * * @return API access the given element has to the given package or * <code>null</code> if no special access has been defined */ @@ -149,7 +149,7 @@ public interface IApiDescription { /** * Sets the access level that the given element has to the given package - * + * * @param element the element that has access to the given package * @param pelement the package that the given element will have the given * access to @@ -160,7 +160,7 @@ public interface IApiDescription { /** * Traverses this description with the given visitor. - * + * * @param visitor description visitor * @param monitor */ @@ -168,7 +168,7 @@ public interface IApiDescription { /** * Traverses this given element contained in this description, if present. - * + * * @param visitor visitor * @param element element to visit * @param monitor progress monitor or <code>null</code> diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiFilterStore.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiFilterStore.java index 7a2d34075b..bb4fe79885 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiFilterStore.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiFilterStore.java @@ -16,7 +16,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblemFilter /** * Stores API problem filters for an API component. - * + * * @since 1.0.0 */ public interface IApiFilterStore { @@ -24,7 +24,7 @@ public interface IApiFilterStore { /** * Adds the given filter to this filter store. If the filter to add is * <code>null</code> or already exists in the store no work is done. - * + * * @param filters filters to add to this store */ public void addFilters(IApiProblemFilter[] filters); @@ -34,14 +34,14 @@ public interface IApiFilterStore { * and adds that filter to the store. If the problem creates a filter that * already exists in the store, or the problem is <code>null</code> no work * is done. - * + * * @param problems problems to create a filter for and add to this store */ public void addFiltersFor(IApiProblem[] problems); /** * Returns all filters for the specified project relative resource - * + * * @param resource the project relative resource to get filters for * @return all filters for the given project relative resource or an empty * array, never <code>null</code> @@ -53,16 +53,16 @@ public interface IApiFilterStore { * filter store. If there are no resource paths with filters or the store * has not been initialized yet an empty array is returned, never * <code>null</code>. - * + * * The returned resources are not guaranteed to exist. - * + * * @return the resource paths that have filters */ public IResource[] getResources(); /** * Removes the specified filter from this filter store. - * + * * @param filters the filters to remove * @return true if all of the filters were removed, false otherwise */ @@ -71,7 +71,7 @@ public interface IApiFilterStore { /** * Returns whether a problem contained in the specified element of the given * type and kind is filtered based on all the filters in this store. - * + * * @param problem the problem we want to know is filtered or not * @return whether the problem is filtered */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiJavadocTag.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiJavadocTag.java index 8cb4c3f948..2bd8ee34ac 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiJavadocTag.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiJavadocTag.java @@ -12,9 +12,9 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Describes an API tools Javadoc tag - * + * * @noimplement this interface is not to be implemented by clients - * + * * @since 1.0.0 */ public interface IApiJavadocTag { @@ -96,7 +96,7 @@ public interface IApiJavadocTag { * {@link RestrictionModifiers#NO_RESTRICTIONS} if the restriction cannot be * parsed into an integer. See {@link RestrictionModifiers} for a listing of * platform modifiers. - * + * * @return the restriction modifier for the tag or * {@link RestrictionModifiers#NO_RESTRICTIONS} */ @@ -106,11 +106,11 @@ public interface IApiJavadocTag { * Returns the formatted javadoc tag label. A formatted javadoc tag label * takes the form '@'+'tag name'. <br> * For example: - * + * * <pre> * <code>@noimplement</code> * </pre> - * + * * @return the formatted javadoc tag label */ public String getTagName(); @@ -120,11 +120,11 @@ public interface IApiJavadocTag { * specified kind. A complete javadoc tag takes the form * '@'+'tagname'+'tagcomment' <br> * For example: - * + * * <pre> * <code>@noimplement</code> this interface is not to be implemented by clients * </pre> - * + * * @param type one of <code>CLASS</code> or <code>INTERFACE</code> * @param member one of <code>METHOD</code> or <code>FIELD</code> or * <code>NONE</code> @@ -135,7 +135,7 @@ public interface IApiJavadocTag { /** * Returns whether this tag is applicable to the specified kind of type and * member. - * + * * @param type one of <code>CLASS</code> or <code>INTERFACE</code> * @param member one of <code>METHOD</code> or <code>FIELD</code> or * <code>NONE</code> @@ -146,7 +146,7 @@ public interface IApiJavadocTag { /** * Allows the tag to be set as applicable to the given type and member, with * the given comment. - * + * * @param type the Java type the tag will be applicable to * @param member the Java member the tag will be applicable to * @param comment an optional comment to be displayed after the tag diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiMarkerConstants.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiMarkerConstants.java index 52e502d10e..f0bea1da69 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiMarkerConstants.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IApiMarkerConstants.java @@ -13,9 +13,9 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Interface that defines all the constants used to create the API Tools * markers. - * + * * This interface is not intended to be extended or implemented. - * + * * @since 1.0.0 * @noimplement This interface is not intended to be implemented by clients. */ @@ -68,7 +68,7 @@ public interface IApiMarkerConstants { /** * Constant representing the id for the fatal problem marker. Value is: * <code>org.eclipse.pde.api.tools.fatal_problem</code> - * + * * @since 1.1 */ public static final String FATAL_PROBLEM_MARKER = ApiPlugin.PLUGIN_ID + ".fatal_problem"; //$NON-NLS-1$ @@ -163,7 +163,7 @@ public interface IApiMarkerConstants { * Constant representing the apiMarkerID value for a duplicate annotation <br> * <br> * Value is: <code>10</code> - * + * * @since 1.0.600 */ public static final int DUPLICATE_ANNOTATION_MARKER_ID = 10; @@ -171,7 +171,7 @@ public interface IApiMarkerConstants { * Constant representing the apiMarkerID for unsupported annotation markers. <br> * <br> * Value is: <code>11</code> - * + * * @since 1.0.600 */ public static final int UNSUPPORTED_ANNOTATION_MARKER_ID = 11; diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IRequiredComponentDescription.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IRequiredComponentDescription.java index 750a13d10e..ef8b5a0451 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IRequiredComponentDescription.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IRequiredComponentDescription.java @@ -12,28 +12,28 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Describes an API component required by another component. - * + * * @since 1.0.0 */ public interface IRequiredComponentDescription { /** * Returns the symbolic name of the required component. - * + * * @return symbolic name of the required component */ public String getId(); /** * Returns a range of compatible versions of the required component. - * + * * @return compatible version range */ public IVersionRange getVersionRange(); /** * Returns whether the required component is optional. - * + * * @return whether the required component is optional. */ public boolean isOptional(); @@ -41,7 +41,7 @@ public interface IRequiredComponentDescription { /** * Returns whether the required component is re-exported by the declaring * component. - * + * * @return whether the required component is re-exported by the declaring * component */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionListener.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionListener.java index c628cb6900..f826a97743 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionListener.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionListener.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Listener interface for changes of the session manager. - * + * * @see ISessionManager#addSessionListener(ISessionListener) * @see ISessionManager#removeSessionListener(ISessionListener) */ @@ -20,14 +20,14 @@ public interface ISessionListener { /** * Called when a session has been added. - * + * * @param addedSession the given added session */ public void sessionAdded(ISession addedSession); /** * Called when a session has been removed. - * + * * @param removedSession the given removed session */ public void sessionRemoved(ISession removedSession); @@ -35,7 +35,7 @@ public interface ISessionListener { /** * Called when a new session has been activated or the last session has been * removed. In this case <code>null</code> is passed as a parameter. - * + * * @param session the given activated session or <code>null</code> */ public void sessionActivated(ISession session); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionManager.java index 919f9c02ae..409eaabbd8 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ISessionManager.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * The session manager holds a list of currently available sessions. - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. */ @@ -21,7 +21,7 @@ public interface ISessionManager { /** * Adds the given session to this session manager. If the session is already * part of this session manager, the method has no effect. - * + * * @param session the new session * @param activate if <code>true</code> the session will also be activated, * <code>false</code> otherwise @@ -32,7 +32,7 @@ public interface ISessionManager { /** * Removes the given session. If the session is not in included in this * session manager, this method has no effect. - * + * * @param session the given session to remove */ public void removeSession(ISession session); @@ -44,14 +44,14 @@ public interface ISessionManager { /** * Returns all available sessions registered with this session manager. - * + * * @return list of available sessions */ public ISession[] getSessions(); /** * Adds the given session listener unless it has been added before. - * + * * @param listener the given session listener to add * @throws IllegalArgumentException if the given listener is null */ @@ -60,14 +60,14 @@ public interface ISessionManager { /** * Removes the given session listener. If the listener has not been added * before this method has no effect. - * + * * @param listener the given session listener to remove */ public void removeSessionListener(ISessionListener listener); /** * Returns the active session or <code>null</code> if there is no session. - * + * * @return active session or <code>null</null> */ public ISession getActiveSession(); @@ -75,7 +75,7 @@ public interface ISessionManager { /** * Activates the given session. If the session is not in included in this * session manager this method has no effect. - * + * * @param session the given session or <code>null</code> to remove the * active session. */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IVersionRange.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IVersionRange.java index d38a9bf138..539f7837bb 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IVersionRange.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/IVersionRange.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,42 +12,42 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Describes an interval or range of versions. - * + * * @since 1.0.0 */ public interface IVersionRange { /** * Returns the minimum version in this range. - * + * * @return minimum version */ public String getMinimumVersion(); /** * Returns whether the minimum version is included in the range. - * + * * @return whether the minimum version is included in the range */ public boolean isIncludeMinimum(); /** * Returns the maximum version in this range. - * + * * @return maximum version */ public String getMaximumVersion(); /** * Returns whether the maximum version is included in the range. - * + * * @return whether the maximum version is included in the range */ public boolean isIncludeMaximum(); /** * Returns whether the given version is included in this range. - * + * * @param version version identifier * @return whether included in this version range */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ProfileModifiers.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ProfileModifiers.java index 48d6e81ab8..c7674f41e7 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ProfileModifiers.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/ProfileModifiers.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.provisional; /** * Class containing constants and utility methods for @since values. - * + * * This covers the corresponding profiles: * <ul> * <li>CDC-1.0_Foundation-1.0</li> @@ -29,7 +29,7 @@ package org.eclipse.pde.api.tools.internal.provisional; * <li>OSGi_Minimum-1.1</li> * <li>OSGi_Minimum-1.2</li> * </ul> - * + * * @since 1.0.0 */ public final class ProfileModifiers { @@ -152,7 +152,7 @@ public final class ProfileModifiers { /** * Returns if the CDC_1_0_FOUNDATION_1_0 modifier has been set in the given * modifiers. - * + * * @param modifiers the given modifiers * @return true if the CDC_1_0_FOUNDATION_1_0 modifier has been set in the * specified modifiers, false otherwise @@ -164,7 +164,7 @@ public final class ProfileModifiers { /** * Returns if the CDC_1_1_FOUNDATION_1_1 modifier has been set in the given * modifiers. - * + * * @param modifiers the given modifiers * @return true if the CDC_1_1_FOUNDATION_1_1 modifier has been set in the * specified modifiers, false otherwise @@ -175,7 +175,7 @@ public final class ProfileModifiers { /** * Returns if the J2SE_1_2 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the J2SE_1_2 modifier has been set in the specified * modifiers, false otherwise @@ -186,7 +186,7 @@ public final class ProfileModifiers { /** * Returns if the J2SE_1_3 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the J2SE_1_3 modifier has been set in the specified * modifiers, false otherwise @@ -197,7 +197,7 @@ public final class ProfileModifiers { /** * Returns if the J2SE_1_4 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the J2SE_1_4 modifier has been set in the specified * modifiers, false otherwise @@ -208,7 +208,7 @@ public final class ProfileModifiers { /** * Returns if the J2SE_1_5 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the J2SE_1_5 modifier has been set in the specified * modifiers, false otherwise @@ -219,7 +219,7 @@ public final class ProfileModifiers { /** * Returns if the JAVASE_1_6 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the JAVASE_1_6 modifier has been set in the specified * modifiers, false otherwise @@ -230,7 +230,7 @@ public final class ProfileModifiers { /** * Returns if the JAVASE_1_7 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the JAVASE_1_7 modifier has been set in the specified * modifiers, false otherwise @@ -252,7 +252,7 @@ public final class ProfileModifiers { /** * Returns if the JRE_1_1 modifier has been set in the given modifiers. - * + * * @param modifiers the given modifiers * @return true if the JRE_1_1 modifier has been set in the specified * modifiers, false otherwise @@ -264,7 +264,7 @@ public final class ProfileModifiers { /** * Returns if the OSGI_MINIMUM_1_0 modifier has been set in the given * modifiers. - * + * * @param modifiers the given modifiers * @return true if the OSGI_MINIMUM_1_0 modifier has been set in the * specified modifiers, false otherwise @@ -276,7 +276,7 @@ public final class ProfileModifiers { /** * Returns if the OSGI_MINIMUM_1_1 modifier has been set in the given * modifiers. - * + * * @param modifiers the given modifiers * @return true if the OSGI_MINIMUM_1_1 modifier has been set in the * specified modifiers, false otherwise @@ -288,7 +288,7 @@ public final class ProfileModifiers { /** * Returns if the OSGI_MINIMUM_1_2 modifier has been set in the given * modifiers. - * + * * @param modifiers the given modifiers * @return true if the OSGI_MINIMUM_1_2 modifier has been set in the * specified modifiers, false otherwise diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/RestrictionModifiers.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/RestrictionModifiers.java index 46effd458e..5395f4475d 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/RestrictionModifiers.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/RestrictionModifiers.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -14,7 +14,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Class containing constants and utility methods for restriction modifiers - * + * * @since 1.0.0 */ public final class RestrictionModifiers { @@ -59,7 +59,7 @@ public final class RestrictionModifiers { /** * Returns if the no_implement modifier has been set in the specified * modifiers - * + * * @param modifiers the modifiers to resolve * @return if the no_implement modifier has been set in the specified * modifiers @@ -70,7 +70,7 @@ public final class RestrictionModifiers { /** * Returns if the no_extend modifier has been set in the specified modifiers - * + * * @param modifiers the modifiers to resolve * @return if the no_extend modifier has been set in the specified modifiers */ @@ -81,7 +81,7 @@ public final class RestrictionModifiers { /** * Returns if the no_override modifier has been set in the specified * modifiers - * + * * @param modifiers the modifiers to resolve * @return if the no_override modifier has been set in the specified * modifiers @@ -93,7 +93,7 @@ public final class RestrictionModifiers { /** * Returns if the no_instantiate modifier has been set in the specified * modifiers - * + * * @param modifiers the modifiers to resolve * @return if the no_instantiate modifier has been set in the specified * modifiers @@ -105,7 +105,7 @@ public final class RestrictionModifiers { /** * Returns if the no_reference modifier has been set in the specified * modifiers - * + * * @param modifiers the modifiers to resolve * @return if the no_reference modifier has been set in the specified * modifiers @@ -116,7 +116,7 @@ public final class RestrictionModifiers { /** * Returns if the modifiers indicate no restrictions. - * + * * @param modifiers the modifiers to test * @return if the modifiers indicate no restrictions */ @@ -127,7 +127,7 @@ public final class RestrictionModifiers { /** * Returns the string representation of the specified restriction(s) or * <code>UNKNOWN_KIND</code> if the kind is unknown. - * + * * @param restrictions the restrictions to get the display string for * @return the string representation for the given restrictions or * <code>UNKNOWN_KIND</code> diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/VisibilityModifiers.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/VisibilityModifiers.java index 96429d6690..f2c114cfc4 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/VisibilityModifiers.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/VisibilityModifiers.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Class containing constants and utility methods for visibility modifiers - * + * * @since 1.0.0 */ public final class VisibilityModifiers { @@ -58,7 +58,7 @@ public final class VisibilityModifiers { /** * Returns if the modifier is 'API' - * + * * @param modifiers the modifiers to resolve * @return if the modifier is 'API' */ @@ -68,7 +68,7 @@ public final class VisibilityModifiers { /** * Returns if the modifier is 'SPI' - * + * * @param modifiers the modifiers to resolve * @return if the modifier is 'SPI' */ @@ -78,7 +78,7 @@ public final class VisibilityModifiers { /** * Returns if the modifier is 'Private' - * + * * @param modifiers the modifiers to resolve * @return if the modifier is 'Private' */ @@ -88,7 +88,7 @@ public final class VisibilityModifiers { /** * Returns if the modifier is 'Private Permissible' - * + * * @param modifiers the modifiers to resolve * @return if the modifier is 'Private Permissible' */ @@ -99,7 +99,7 @@ public final class VisibilityModifiers { /** * Returns the string representation of the specified visibility modifier or * <code>UNKNOWN_VISIBILITY</code> if the modifier is unknown. - * + * * @param visibility * @return the string representation of the visibility or * <code>UNKNOWN_VISIBILITY</code> 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 8262f66680..f4247ffc62 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 @@ -23,7 +23,7 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem; /** * Description of an analyzer used by the API builder to find and report * problems with the current API state. - * + * * @see ApiAnalysisBuilder * @see IApiProblem * @since 1.0.0 @@ -44,7 +44,7 @@ public interface IApiAnalyzer { * running. When the platform is running, the references are retrieved using * the preference store. * </p> - * + * * @param buildState the given build state or null if none * @param filterStore the given filter store or null if none * @param preferences the given preferences to be used for the analysis @@ -61,7 +61,7 @@ public interface IApiAnalyzer { /** * Returns the complete set of {@link IApiProblem}s found by this analyzer, * or an empty array. This method must never return <code>null</code> - * + * * @return the complete set of problems found by this analyzer or an empty * array. */ 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 a20d1fecb4..923adfa9f4 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 @@ -16,14 +16,14 @@ import org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem; /** * Detects API use problems and leaks. - * + * * @since 1.1 */ public interface IApiProblemDetector { /** * Returns a bit mask of reference kinds this analyzer is interested in. - * + * * @return bit mask of {@link ReferenceModifiers} constants */ public int getReferenceKinds(); @@ -32,7 +32,7 @@ public interface IApiProblemDetector { * Returns whether the given unresolved reference is a potential problem. * This analyzer should retain the reference if it is a potential problem * for further analysis once references have been resolved. - * + * * @param reference potential problem * @return whether the unresolved reference is a potential problem */ @@ -41,7 +41,7 @@ public interface IApiProblemDetector { /** * Returns a list of any problems detected after analyzing potential * reference problems that are now resolved. - * + * * @return list of * {@link org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem} */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IBuildContext.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IBuildContext.java index 8c7fb8dbe4..82eb75a93a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IBuildContext.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IBuildContext.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.builder.ApiAnalysisBuilder; /** * A context of types reported from the API analysis builder - * + * * @since 1.0.1 */ public interface IBuildContext { @@ -24,7 +24,7 @@ public interface IBuildContext { * Returns the collection of structurally changed types that have been * reported by the {@link ApiAnalysisBuilder}. If no types have been * reported as changed an empty array is returned, never <code>null</code>. - * + * * @return the collection of API visible types that have been changed or an * empty array */ @@ -34,7 +34,7 @@ public interface IBuildContext { * Returns a collection of types that have had an API description change. If * no types have had an API description change, an empty array is returned, * never <code>null</code>. - * + * * @return the collection of API visible types that have had a description * change or an empty array */ @@ -44,7 +44,7 @@ public interface IBuildContext { * Returns the collection of types that have been removed (where an * {@link IResourceDelta#REMOVED} delta was found) If no types have been * reported as removed an empty array is returned, never <code>null</code>. - * + * * @return the collection of removed types or an empty array, never * <code>null</code> */ @@ -56,7 +56,7 @@ public interface IBuildContext { * {@link org.eclipse.pde.api.tools.internal.builder.ApiAnalysisBuilder}. If * no types have been reported as dependent an empty array is returned, * never <code>null</code>. - * + * * @return the complete collection of types dependent on description changes * or an empty array */ @@ -69,17 +69,17 @@ public interface IBuildContext { /** * Returns if the build context has any structurally changed types. - * + * * Has better performance impact than getting the collection of changed type * names to ask for the size. - * + * * @return true if there are changed type names recorded, false otherwise */ public boolean hasStructuralChanges(); /** * Returns if the build context has any recorded API description changes. - * + * * @return whether any types have API description changes */ public boolean hasDescriptionChanges(); @@ -87,7 +87,7 @@ public interface IBuildContext { /** * Returns whether this build context has any type dependent on API * description changes. - * + * * @return <code>true</code> if there are type dependent on API description * changes, otherwise <code>false</code> */ @@ -95,10 +95,10 @@ public interface IBuildContext { /** * Returns if the build context has any recorded removed types. - * + * * Has better performance impact than getting the collection of removed type * names to ask for the size. - * + * * @return true if there are removed type names recorded, false otherwise */ public boolean hasRemovedTypes(); @@ -106,7 +106,7 @@ public interface IBuildContext { /** * Returns if this build context has any recorded types that require * incremental building. - * + * * @return true if there are types to build incrementally, false otherwise */ public boolean hasTypes(); @@ -114,7 +114,7 @@ public interface IBuildContext { /** * Returns if this build context contains the given type name in its * collection of types with API description changes. - * + * * @param typename * @return true if this context contains the given type name, false * otherwise @@ -124,7 +124,7 @@ public interface IBuildContext { /** * Returns if this build context contains the given type name in its * collection of types dependent on API description changes. - * + * * @param typename * @return true if this context contains the given type name, false * otherwise @@ -134,7 +134,7 @@ public interface IBuildContext { /** * Returns if this build context contains the given type name in its changed * types collection. - * + * * @param typename * @return true if this context contains the given type name, false * otherwise @@ -144,7 +144,7 @@ public interface IBuildContext { /** * Returns if this build context contains the given type name in its removed * types collection - * + * * @param typename * @return true if this context contains the given type, false otherwise */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IReference.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IReference.java index bfa622a69e..3fe556733a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IReference.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/builder/IReference.java @@ -14,26 +14,26 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiMember; /** * Describes a reference to a type, field, or method. - * + * * @since 1.1 */ public interface IReference { /** * An {@link IReference} of this type represents a type reference. - * + * * @see #getReferenceType() */ public static final int T_TYPE_REFERENCE = 1; /** * An {@link IReference} of this type represents a field reference. - * + * * @see #getReferenceType() */ public static final int T_FIELD_REFERENCE = 2; /** * An {@link IReference} of this type represents a method reference. - * + * * @see #getReferenceType() */ public static final int T_METHOD_REFERENCE = 3; @@ -42,7 +42,7 @@ public interface IReference { * Flag to indicate the reference is illegal, i.e. a reference made to an * API restricted * {@link org.eclipse.pde.api.tools.internal.provisional.model.IApiElement} - * + * * @since 1.0.400 */ public static final int F_ILLEGAL = 0x1; @@ -50,7 +50,7 @@ public interface IReference { * Constant representing a default method was called <br> * <br> * Value is: <code>2</code> - * + * * @since 1.0.600 */ public static final int F_DEFAULT_METHOD = 0x1 << 1; @@ -58,265 +58,265 @@ public interface IReference { /** * Constant representing the superclass of the class is a class in the * target space. - * + * * Value is <code>2^0</code> - * + * * @see #getReferenceKind() */ public static final int REF_EXTENDS = 0x1; /** * Constant representing the class implements an interface in the target * space. - * + * * Value is <code>2^1</code> - * + * * @see #getReferenceKind() */ public static final int REF_IMPLEMENTS = 0x1 << 1; /** * Constant representing a field is declared of a type in the target space. - * + * * Value is <code>2^2</code> - * + * * @see #getReferenceKind() */ public static final int REF_FIELDDECL = 0x1 << 2; /** * Constant representing the return type of a declared method is in the * target space. - * + * * Value is <code>2^3</code> - * + * * @see #getReferenceKind() */ public static final int REF_RETURNTYPE = 0x1 << 3; /** * Constant representing a parameter of a method is in the target space. - * + * * Value is <code>2^4</code> - * + * * @see #getReferenceKind() */ public static final int REF_PARAMETER = 0x1 << 4; /** * Constant representing an exception in the throws clause of a method is in * the target space. - * + * * Value is <code>2^5</code> - * + * * @see #getReferenceKind() */ public static final int REF_THROWS = 0x1 << 5; /** * Constant representing a constructor method was invoked on a class in the * target space. - * + * * Value is <code>2^6</code> - * + * * @see #getReferenceKind() */ public static final int REF_CONSTRUCTORMETHOD = 0x1 << 6; /** * Constant representing a static method is invoked on a class in the target * space. - * + * * Value is <code>2^7</code> - * + * * @see #getReferenceKind() */ public static final int REF_STATICMETHOD = 0x1 << 7; /** * Constant representing a virtual (instance) method is invoked on a class * in the target space. - * + * * Value is <code>2^8</code> - * + * * @see #getReferenceKind() */ public static final int REF_VIRTUALMETHOD = 0x1 << 8; /** * Constant representing a method on an interface in the target space is * invoked. - * + * * Value is <code>2^9</code> - * + * * @see #getReferenceKind() */ public static final int REF_INTERFACEMETHOD = 0x1 << 9; /** * Constant representing a parameter passed to a method is in the target * space. - * + * * Value is <code>2^10</code> - * + * * @see #getReferenceKind() */ public static final int REF_PASSEDPARAMETER = 0x1 << 10; /** * Constant representing reading a static field from a class in the target * space. - * + * * Value is <code>2^11</code> - * + * * @see #getReferenceKind() */ public static final int REF_GETSTATIC = 0x1 << 11; /** * Constant representing setting a static field from a class in the target * space. - * + * * Value is <code>2^12</code> - * + * * @see #getReferenceKind() */ public static final int REF_PUTSTATIC = 0x1 << 12; /** * Constant representing reading an instance field from a class in the * target space. - * + * * Value is <code>2^13</code> - * + * * @see #getReferenceKind() */ public static final int REF_GETFIELD = 0x1 << 13; /** * Constant representing setting an instance field from a class in the * target space. - * + * * Value is <code>2^14</code> - * + * * @see #getReferenceKind() */ public static final int REF_PUTFIELD = 0x1 << 14; /** * Constant representing an array is created of a type in the target space. - * + * * Value is <code>2^15</code> - * + * * @see #getReferenceKind() */ public static final int REF_ARRAYALLOC = 0x1 << 15; /** * Constant representing a method contains a local variable that is in the * target space. - * + * * Value is <code>2^16</code> - * + * * @see #getReferenceKind() */ public static final int REF_LOCALVARIABLE = 0x1 << 16; /** * Constant representing code in a method catches an exception of a class in * the target space. - * + * * Value is <code>2^17</code> - * + * * @see #getReferenceKind() */ public static final int REF_CATCHEXCEPTION = 0x1 << 17; /** * Constant representing method code contains a cast using a type in the * target space. - * + * * Value is <code>2^18</code> - * + * * @see #getReferenceKind() */ public static final int REF_CHECKCAST = 0x1 << 18; /** * Constant representing method code contains a type in the target space as * the operand of the instanceof operator. - * + * * Value is <code>2^19</code> - * + * * @see #getReferenceKind() */ public static final int REF_INSTANCEOF = 0x1 << 19; /** * Constant representing that the INVOKE_SPECIAL instruction has been used * in the target space. - * + * * Value is <code>2^20</code> - * + * * @see #getReferenceKind() */ public static final int REF_SPECIALMETHOD = 0x1 << 20; /** * Constant representing a parameterized type has been declared in the * target space. Used or Java 5+ support of signatures. - * + * * Value is <code>2^21</code> - * + * * @see #getReferenceKind() */ public static final int REF_PARAMETERIZED_TYPEDECL = 0x1 << 21; /** * Constant representing a parameterized field has been declared in the * target space. Used for Java 5+ support of signatures. - * + * * Value is <code>2^22</code> - * + * * @see #getReferenceKind() */ public static final int REF_PARAMETERIZED_FIELDDECL = 0x1 << 22; /** * Constant representing a parameterized method has been declared in the * target space. Used for Java 5+ support of signatures. - * + * * Value is <code>2^23</code> - * + * * @see #getReferenceKind() */ public static final int REF_PARAMETERIZED_METHODDECL = 0x1 << 23; /** * Constant representing a parameterized type for a local variable is in the * target space. Used for Java 5+ support of signatures. - * + * * Value is <code>2^24</code> - * + * * @see #getReferenceKind() */ public static final int REF_PARAMETERIZED_VARIABLE = 0x1 << 24; /** * Constant representing a local variable is declared in the target space. - * + * * Value is <code>2^25</code> - * + * * @see #getReferenceKind() */ public static final int REF_LOCALVARIABLEDECL = 0x1 << 25; /** * Constant representing a type is read from the constant pool and placed on * the stack - * + * * Value is <code>2^26</code> - * + * * @see #getReferenceKind() */ public static final int REF_CONSTANTPOOL = 0x1 << 26; /** * Constant representing a type has been instantiated via a constructor. * This reference is to the type, rather than the actual constructor method. - * + * * Value is <code>2^27</code> - * + * * @see #getReferenceKind() */ public static final int REF_INSTANTIATE = 0x1 << 27; /** * Constant representing a method overriding a method in a super type. - * + * * Value is <code>2^28</code> - * + * * @see #getReferenceKind() */ public static final int REF_OVERRIDE = 0x1 << 28; /** * Constant representing a constructor method was invoked on a direct * superclass from a constructor. - * + * * Value is <code>2^29</code> - * + * * @see #getReferenceKind() */ public static final int REF_SUPER_CONSTRUCTORMETHOD = 0x1 << 29; @@ -324,41 +324,41 @@ public interface IReference { * Constant representing an annotation member was referenced * <br><br> * Value is: <code>2^30</code> - * + * * @since 1.0.600 */ public static final int REF_ANNOTATION_USE = 0x1 << 30; /** * Bit mask used to indicate all kinds of references. - * + * * @see #getReferenceKind() */ public static final int MASK_REF_ALL = 0x7FFFFFFF; /** * The line number from which the reference was made or -1 if unknown. - * + * * @return source line number or -1 */ public int getLineNumber(); /** * Returns the member where the reference exists. - * + * * @return member where the reference exists */ public IApiMember getMember(); /** * Returns the specific kind of reference that was made. - * + * * @return reference kind - one of the reference modifiers */ public int getReferenceKind(); /** * Returns any flags set on the reference - * + * * @return any flags set on the reference */ public int getReferenceFlags(); @@ -366,14 +366,14 @@ public interface IReference { /** * Returns the type of reference that has been made - one of type, field, or * method. - * + * * @return one of the reference type constants defined in this interface */ public int getReferenceType(); /** * Returns the fully qualified name of the type that has been referenced. - * + * * @return fully qualified name of the type that has been referenced */ public String getReferencedTypeName(); @@ -381,7 +381,7 @@ public interface IReference { /** * Returns the name of the field or method that has been referenced, or * <code>null</code> if this is a {@link #T_TYPE_REFERENCE}. - * + * * @return the name of the field or method that has been referenced, or * <code>null</code> */ @@ -392,7 +392,7 @@ public interface IReference { * referenced, or <code>null</code> if this is not a * {@link #T_METHOD_REFERENCE} or if not available for an * {@link #T_TYPE_REFERENCE}. - * + * * @return the type signature of the method or type that has been * referenced, or <code>null</code> */ @@ -401,7 +401,7 @@ public interface IReference { /** * Returns the resolved member that is referenced or <code>null</code> if * this reference is unresolved. - * + * * @return resolved reference or <code>null</code> */ public IApiMember getResolvedReference(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/ApiComparator.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/ApiComparator.java index cf86ae90c3..ea7e1d4fbb 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/ApiComparator.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/ApiComparator.java @@ -40,7 +40,7 @@ import org.osgi.framework.Version; /** * This class defines a comparator to get a IDelta out of the comparison of two * elements. - * + * * @since 1.0 */ public class ApiComparator { @@ -51,7 +51,7 @@ public class ApiComparator { /** * Returns a delta for a API component version change - * + * * @param apiComponent2 * @param id * @param apiComponentVersion @@ -86,7 +86,7 @@ public class ApiComparator { /** * Returns a delta that corresponds to the difference between the given * baseline and the reference. - * + * * @param referenceBaseline the given API baseline which is used as the * reference * @param baseline the given API baseline to compare with @@ -95,7 +95,7 @@ public class ApiComparator { * @param force a flag to force the comparison of nested API components with * the same versions * @param monitor - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed * @throws IllegalArgumentException if one of the two baselines is null @@ -165,7 +165,7 @@ public class ApiComparator { /** * Returns a delta that corresponds to the difference between the given * component and the reference baseline. - * + * * @param component the given component to compare with the given reference * baseline * @param referenceBaseline the given API baseline which is used as the @@ -175,7 +175,7 @@ public class ApiComparator { * @param force a flag to force the comparison of nested API components with * the same versions * @param monitor - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed * @exception IllegalArgumentException if: @@ -227,7 +227,7 @@ public class ApiComparator { * Returns a delta that corresponds to the comparison of the two given API * components. The two components are compared even if their versions are * identical. - * + * * @param referenceComponent the given API component * @param component2 the given API component to compare with * @param referenceBaseline the given API baseline from which the given @@ -237,7 +237,7 @@ public class ApiComparator { * @param visibilityModifiers the given visibility that triggers what * visibility should be used for the comparison * @param monitor - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed * @exception IllegalArgumentException if: @@ -298,7 +298,7 @@ public class ApiComparator { * Returns a delta that corresponds to the difference between the given * component and the given reference component. The given component cannot * be null. - * + * * @param referenceComponent the given API component that is used as the * reference * @param component the given component to compare with @@ -307,7 +307,7 @@ public class ApiComparator { * @param force a flag to force the comparison of nested API components with * the same versions * @param monitor - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed */ @@ -323,7 +323,7 @@ public class ApiComparator { /** * Returns a delta that corresponds to the comparison of the given class * file with the reference. - * + * * @param typeRoot2 the given class file that comes from the * <code>component2</code> * @param component the given API component from the reference @@ -337,7 +337,7 @@ public class ApiComparator { * @param visibilityModifiers the given visibility that triggers what * visibility should be used for the comparison * @param monitor - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed * @exception IllegalArgumentException if: @@ -446,7 +446,7 @@ public class ApiComparator { /** * Returns a delta that corresponds to the comparison of the given class * file. - * + * * @param typeRoot the given class file * @param typeRoot2 the given class file to compare with * @param component the given API component from which the given class file @@ -459,7 +459,7 @@ public class ApiComparator { * @param visibilityModifiers the given visibility that triggers what * visibility should be used for the comparison * @param monitor - * + * * @return a delta, an empty delta if no difference is found or * <code>null</code> if the delta detection failed * @exception IllegalArgumentException if: @@ -501,7 +501,7 @@ public class ApiComparator { * Equivalent to: compare(baseline, baseline2, visibilityModifiers, false, * false, monitor); * </p> - * + * * @param scope the given scope for the comparison * @param baseline the given API baseline to compare with * @param visibilityModifiers the given visibility that triggers what @@ -509,7 +509,7 @@ public class ApiComparator { * @param force a flag to force the comparison of nested API components with * the same versions * @param monitor the given progress monitor to report progress - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed * @throws IllegalArgumentException if one of the two baselines is null @@ -526,7 +526,7 @@ public class ApiComparator { * <p> * Equivalent to: compare(baseline, baseline2, visibilityModifiers, false); * </p> - * + * * @param scope the given scope for the comparison * @param baseline the given API baseline to compare with * @param visibilityModifiers the given visibility that triggers what @@ -536,7 +536,7 @@ public class ApiComparator { * @param continueOnResolverError if <code>true</code> the comparison will * continue even if a component in the scope has a resolver error * @param monitor the given progress monitor to report progress - * + * * @return a delta, an empty delta if no difference is found or null if the * delta detection failed. If set to continue on resolver error a * delta, possibly empty, will always be returned @@ -599,7 +599,7 @@ public class ApiComparator { /** * Returns true, if the given type descriptor should be skipped, false * otherwise. - * + * * @param visibilityModifiers * @param elementDescription * @param typeDescriptor @@ -624,7 +624,7 @@ public class ApiComparator { /** * Performs the internal compare of the given {@link IApiComponent}s using * their type containers - * + * * @param component * @param component2 * @param referenceBaseline @@ -632,7 +632,7 @@ public class ApiComparator { * @param visibilityModifiers * @param globalDelta * @param monitor - * + * * @return a delta of changed API elements * @throws CoreException */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaProcessor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaProcessor.java index cd6818cc7c..6ac54f9c6b 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaProcessor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaProcessor.java @@ -16,14 +16,14 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Class used to process the delta to find out if they are compatible or not. - * + * * @since 1.0.0 */ public class DeltaProcessor { /** * Return true is the given delta is compatible, false otherwise. - * + * * @param delta the given delta * @return true is the given delta is compatible, false otherwise. */ @@ -57,7 +57,7 @@ public class DeltaProcessor { /** * Returns if the delta is compatible or not - * + * * @param delta * @return true if the delta represents a compatible change or not */ @@ -101,7 +101,7 @@ public class DeltaProcessor { /** * Returns if the API baseline is compatible - * + * * @param delta * @return true if compatible, false otherwise */ @@ -123,7 +123,7 @@ public class DeltaProcessor { /** * Returns if the API component is compatible - * + * * @param delta * @return true if compatible, false otherwise */ @@ -148,7 +148,7 @@ public class DeltaProcessor { /** * Returns if the annotation is compatible or not - * + * * @param delta * @return true if compatible, false otherwise */ @@ -196,7 +196,7 @@ public class DeltaProcessor { /** * Returns if the method is compatible or not - * + * * @param delta * @return true if compatible, false otherwise */ @@ -250,7 +250,7 @@ public class DeltaProcessor { /** * Returns if the field is compatible or not - * + * * @param delta * @return true if compatible, false otherwise */ @@ -327,7 +327,7 @@ public class DeltaProcessor { /** * Returns if the constructor is compatible or not - * + * * @param delta * @return true if compatible, false otherwise */ @@ -374,7 +374,7 @@ public class DeltaProcessor { /** * Returns if the enum is compatible or not - * + * * @param delta * @return true if compatible, false otherwise */ @@ -429,7 +429,7 @@ public class DeltaProcessor { /** * Returns if a class file is compatible - * + * * @param delta * @return true if compatible, false otherwise */ @@ -515,7 +515,7 @@ public class DeltaProcessor { /** * Returns if the interface element is compatible - * + * * @param delta * @return true if compatible, false otherwise */ @@ -556,7 +556,7 @@ public class DeltaProcessor { /** * Returns if the interface element is compatible - * + * * @param delta * @return true if compatible, false otherwise */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaVisitor.java index f737bdd02c..6a082e3050 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/comparator/DeltaVisitor.java @@ -14,7 +14,7 @@ public class DeltaVisitor { /** * Visit the given delta - * + * * @param delta the given delta * @return true if the children of the given delta should also be processed */ @@ -24,7 +24,7 @@ public class DeltaVisitor { /** * Callback called when the delta visitor is exiting the given delta - * + * * @param delta the given delta */ public void endVisit(IDelta delta) { 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 cfabbe7382..23f56fae23 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 @@ -24,7 +24,7 @@ public interface IDelta { /** * Status constant indicating that the element has been changed, as * described by the change flags. - * + * * @see #getFlags() */ public int CHANGED = 2; @@ -37,7 +37,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against an * annotation type declaration. - * + * * @see #getElementType() */ public static final int ANNOTATION_ELEMENT_TYPE = 1; @@ -45,7 +45,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against an * API component. - * + * * @see #getElementType() */ public static final int API_COMPONENT_ELEMENT_TYPE = 2; @@ -53,7 +53,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against an * API baseline. - * + * * @see #getElementType() */ public static final int API_BASELINE_ELEMENT_TYPE = 3; @@ -61,7 +61,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against a * class type declaration. - * + * * @see #getElementType() */ public static final int CLASS_ELEMENT_TYPE = 4; @@ -69,7 +69,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against a * constructor declaration. - * + * * @see #getElementType() */ public static final int CONSTRUCTOR_ELEMENT_TYPE = 5; @@ -77,7 +77,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against an * enum type declaration. - * + * * @see #getElementType() */ public static final int ENUM_ELEMENT_TYPE = 6; @@ -85,7 +85,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against a * field declaration. - * + * * @see #getElementType() */ public static final int FIELD_ELEMENT_TYPE = 7; @@ -93,7 +93,7 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against an * interface type declaration. - * + * * @see #getElementType() */ public static final int INTERFACE_ELEMENT_TYPE = 8; @@ -101,14 +101,14 @@ public interface IDelta { /** * Element type constant indicating that the delta is reported against a * method declaration. - * + * * @see #getElementType() */ public static final int METHOD_ELEMENT_TYPE = 9; /** * Element type constant indicating that the delta is reported against a * type parameter. - * + * * @see #getElementType() */ public static final int TYPE_PARAMETER_ELEMENT_TYPE = 10; @@ -119,7 +119,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int ABSTRACT_TO_NON_ABSTRACT = 1; @@ -131,7 +131,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int ANNOTATION_DEFAULT_VALUE = 2; @@ -142,7 +142,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_COMPONENT = 3; @@ -153,7 +153,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int ARRAY_TO_VARARGS = 4; @@ -164,7 +164,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int CHECKED_EXCEPTION = 5; @@ -176,7 +176,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int CLASS_BOUND = 6; @@ -188,7 +188,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int CLINIT = 7; @@ -199,7 +199,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int CONSTRUCTOR = 8; @@ -210,7 +210,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int CONTRACTED_SUPERINTERFACES_SET = 10; @@ -220,7 +220,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int DECREASE_ACCESS = 11; @@ -231,7 +231,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int ENUM_CONSTANT = 12; @@ -242,7 +242,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int EXECUTION_ENVIRONMENT = 13; @@ -253,7 +253,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int EXPANDED_SUPERINTERFACES_SET = 15; @@ -264,7 +264,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int FIELD = 16; @@ -275,7 +275,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int FIELD_MOVED_UP = 17; @@ -286,7 +286,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int FINAL_TO_NON_FINAL = 18; @@ -297,7 +297,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int FINAL_TO_NON_FINAL_NON_STATIC = 19; @@ -308,7 +308,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int FINAL_TO_NON_FINAL_STATIC_CONSTANT = 20; @@ -319,7 +319,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int FINAL_TO_NON_FINAL_STATIC_NON_CONSTANT = 21; @@ -329,7 +329,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int INCREASE_ACCESS = 22; @@ -341,7 +341,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int INTERFACE_BOUND = 23; @@ -352,7 +352,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int METHOD = 25; @@ -363,7 +363,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int METHOD_MOVED_UP = 26; @@ -375,7 +375,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int METHOD_WITH_DEFAULT_VALUE = 27; @@ -387,7 +387,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int METHOD_WITHOUT_DEFAULT_VALUE = 28; @@ -397,7 +397,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NATIVE_TO_NON_NATIVE = 29; @@ -407,7 +407,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_ABSTRACT_TO_ABSTRACT = 30; @@ -417,7 +417,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_FINAL_TO_FINAL = 31; @@ -427,7 +427,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_NATIVE_TO_NATIVE = 32; @@ -437,7 +437,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_STATIC_TO_STATIC = 33; @@ -447,7 +447,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_SYNCHRONIZED_TO_SYNCHRONIZED = 34; @@ -457,7 +457,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_TRANSIENT_TO_TRANSIENT = 35; @@ -468,7 +468,7 @@ public interface IDelta { * <ul> * <li>{@link #ADDED}</li> * </ul> - * + * * @see #getFlags() */ public static final int OVERRIDEN_METHOD = 36; @@ -479,7 +479,7 @@ public interface IDelta { * <ul> * <li>{@link #ADDED}</li> * </ul> - * + * * @see #getFlags() */ public static final int RESTRICTIONS = 37; @@ -489,7 +489,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int STATIC_TO_NON_STATIC = 38; @@ -500,7 +500,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int SUPERCLASS = 39; @@ -510,7 +510,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int SYNCHRONIZED_TO_NON_SYNCHRONIZED = 40; @@ -521,7 +521,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_CONVERSION = 41; @@ -531,7 +531,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TRANSIENT_TO_NON_TRANSIENT = 45; @@ -543,7 +543,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE = 46; @@ -553,7 +553,7 @@ public interface IDelta { * <ul> * <li>{@link #ADDED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_ARGUMENTS = 47; @@ -565,7 +565,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_MEMBER = 48; @@ -576,7 +576,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_PARAMETER = 49; @@ -586,7 +586,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_PARAMETER_NAME = 50; @@ -597,7 +597,7 @@ public interface IDelta { * <ul> * <li>{@link #ADDED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_PARAMETERS = 51; @@ -607,7 +607,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_VISIBILITY = 52; @@ -619,7 +619,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int UNCHECKED_EXCEPTION = 53; @@ -632,7 +632,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int VALUE = 54; @@ -643,7 +643,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int VARARGS_TO_ARRAY = 55; @@ -655,7 +655,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_TYPE = 56; @@ -665,7 +665,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int NON_VOLATILE_TO_VOLATILE = 57; @@ -675,7 +675,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int VOLATILE_TO_NON_VOLATILE = 58; @@ -685,7 +685,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int MAJOR_VERSION = 59; @@ -695,7 +695,7 @@ public interface IDelta { * <ul> * <li>{@link #CHANGED}</li> * </ul> - * + * * @see #getFlags() */ public static final int MINOR_VERSION = 60; @@ -707,7 +707,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_FIELD = 61; @@ -719,7 +719,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_METHOD = 62; @@ -731,7 +731,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_CONSTRUCTOR = 63; @@ -743,7 +743,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_ENUM_CONSTANT = 64; @@ -755,7 +755,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_METHOD_WITH_DEFAULT_VALUE = 65; @@ -767,7 +767,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int API_METHOD_WITHOUT_DEFAULT_VALUE = 66; @@ -778,7 +778,7 @@ public interface IDelta { * <ul> * <li>{@link #ADDED}</li> * </ul> - * + * * @see #getFlags() */ public static final int METHOD_MOVED_DOWN = 67; @@ -791,7 +791,7 @@ public interface IDelta { * <li>{@link #CHANGED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int TYPE_ARGUMENT = 68; @@ -802,7 +802,7 @@ public interface IDelta { * <ul> * <li>{@link #ADDED}</li> * </ul> - * + * * @see #getFlags() */ public static final int SUPER_INTERFACE_WITH_METHODS = 69; @@ -814,7 +814,7 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int REEXPORTED_TYPE = 70; @@ -826,7 +826,7 @@ public interface IDelta { * <ul> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int REEXPORTED_API_TYPE = 71; @@ -838,35 +838,35 @@ public interface IDelta { * <li>{@link #ADDED}</li> * <li>{@link #REMOVED}</li> * </ul> - * + * * @see #getFlags() */ public static final int DEPRECATION = 72; /** * Return true if the receiver has no children deltas, false otherwise. - * + * * @return true if the receiver has no children deltas, false otherwise. */ public boolean isEmpty(); /** * Returns the key of this delta. - * + * * @return the key of this delta */ public String getKey(); /** * Returns the kind of this delta that describe how an element has changed. - * + * * @return the kind of this delta that describe how an element has changed */ public int getKind(); /** * Returns flags that describe how an element has changed. - * + * * @return flags that describe how an element has changed */ public int getFlags(); @@ -879,28 +879,28 @@ public interface IDelta { * , {@link IDelta#CLASS_ELEMENT_TYPE}, {@link IDelta#FIELD_ELEMENT_TYPE}, * {@link IDelta#API_COMPONENT_ELEMENT_TYPE} and * {@link IDelta#API_PROFILE_ELEMENT_TYPE}. - * + * * @return flags that describe how an element has changed */ public int getElementType(); /** * Returns the children of the receiver. Return an empty list if none - * + * * @return children of the receiver */ public IDelta[] getChildren(); /** * Traverse the given delta and apply the visitor - * + * * @param visitor the given delta visitor */ public void accept(DeltaVisitor visitor); /** * Returns the type name against which the delta is returned. - * + * * @return the type name against which the delta is returned. */ public String getTypeName(); @@ -908,7 +908,7 @@ public interface IDelta { /** * Returns the delta's description. This can be used as an error message. * The message is returned in the current locale. - * + * * @return the delta's description */ public String getMessage(); @@ -916,21 +916,21 @@ public interface IDelta { /** * Returns the set of arguments that can be used to compose NLS'd messages. * These arguments will typically be type, method and field names. - * + * * @return the set of arguments to compose NLS'd messages */ public String[] getArguments(); /** * Returns the delta's current restrictions. - * + * * @return the delta's current restrictions */ public int getCurrentRestrictions(); /** * Returns the delta's previous restrictions. - * + * * @return the delta's previous restrictions */ public int getPreviousRestrictions(); @@ -938,7 +938,7 @@ public interface IDelta { /** * Returns the delta's new modifiers. This corresponds to the new modifiers * of the affected element. by the delta. - * + * * @return the delta's new modifiers */ public int getNewModifiers(); @@ -946,7 +946,7 @@ public interface IDelta { /** * Returns the delta's old modifiers. This corresponds to the old modifiers * of the affected element. by the delta. - * + * * @return the delta's old modifiers */ public int getOldModifiers(); @@ -955,7 +955,7 @@ public interface IDelta { * Returns the component identifier including its version identifier in * which the given delta is reported, or <code>null</code>. Can be * <code>null</code> if the delta is reported against an API profile. - * + * * @return the component id in which the given delta is reported, or * <code>null</code> if none */ @@ -965,7 +965,7 @@ public interface IDelta { * Returns the component identifier without its version identifier in which * the given delta is reported, or <code>null</code>. Can be * <code>null</code> if the delta is reported against an API profile. - * + * * @return the component id in which the given delta is reported, or * <code>null</code> if none */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IComponentDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IComponentDescriptor.java index e4e7e005ee..fd4cc95522 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IComponentDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IComponentDescriptor.java @@ -17,7 +17,7 @@ package org.eclipse.pde.api.tools.internal.provisional.descriptors; * Component descriptors do not have parent components and do not have a path, * therefore both the {@link #getParent()} and {@link #getPath()} method always * yield <code>null</code> - * + * * @since 1.0.1 * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. @@ -26,7 +26,7 @@ public interface IComponentDescriptor extends IElementDescriptor { /** * Returns the component id from the descriptor - * + * * @return the component id */ public String getId(); @@ -34,7 +34,7 @@ public interface IComponentDescriptor extends IElementDescriptor { /** * Returns the version id for this component or <code>null</code> if * unspecified. - * + * * @return */ public String getVersion(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IElementDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IElementDescriptor.java index 4356777fa0..edac17b6e4 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IElementDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IElementDescriptor.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent; /** * Describes an element in an API component. - * + * * @since 1.0.0 */ public interface IElementDescriptor { @@ -52,7 +52,7 @@ public interface IElementDescriptor { /** * Returns the parent of this element or <code>null</code> if none. - * + * * @return */ public IElementDescriptor getParent(); @@ -60,14 +60,14 @@ public interface IElementDescriptor { /** * Returns all parents of this element in a top-down path, including this * element as the last element in the path. - * + * * @return path top-down path to this element */ public IElementDescriptor[] getPath(); /** * Returns one of the element type constants defined by this interface. - * + * * @return element type constant */ public int getElementType(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IFieldDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IFieldDescriptor.java index cd721a564b..6da2f75b23 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IFieldDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IFieldDescriptor.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.provisional.descriptors; /** * Describes a field. - * + * * @since 1.0.0 */ public interface IFieldDescriptor extends IMemberDescriptor { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMemberDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMemberDescriptor.java index 4d92032f69..d33057a71e 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMemberDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMemberDescriptor.java @@ -18,14 +18,14 @@ package org.eclipse.pde.api.tools.internal.provisional.descriptors; * A member has either an enclosing type for a parent. Top level types have a * package for a parent. * </p> - * + * * @since 1.0.0 */ public interface IMemberDescriptor extends IElementDescriptor { /** * Returns the name of this member. - * + * * @return member name */ public String getName(); @@ -33,14 +33,14 @@ public interface IMemberDescriptor extends IElementDescriptor { /** * Returns a descriptor for the type this member is declared in or * <code>null</code> if none. - * + * * @return enclosing type or <code>null</code> */ public IReferenceTypeDescriptor getEnclosingType(); /** * Returns a descriptor for the package this member is contained in. - * + * * @return package descriptor */ public IPackageDescriptor getPackage(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMethodDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMethodDescriptor.java index ac75f28db0..91cb95ccec 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMethodDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IMethodDescriptor.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.provisional.descriptors; /** * Describes a method. - * + * * @since 1.0.0 */ public interface IMethodDescriptor extends IMemberDescriptor { @@ -26,14 +26,14 @@ public interface IMethodDescriptor extends IMemberDescriptor { * <code>public void foo(String text, int length)</code> would return * <code>"(Ljava.lang.String;I)V"</code>. * </p> - * + * * @return the signature of this method */ public String getSignature(); /** * Returns whether this method is a constructor - * + * * @return whether this method is a constructor */ public boolean isConstructor(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IPackageDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IPackageDescriptor.java index 41f71746f5..3a9ea966e6 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IPackageDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IPackageDescriptor.java @@ -15,14 +15,14 @@ package org.eclipse.pde.api.tools.internal.provisional.descriptors; * <p> * A package has no parent. * </p> - * + * * @since 1.0.0 */ public interface IPackageDescriptor extends IElementDescriptor { /** * Returns this package's name. Package names are dot qualified. - * + * * @return package name */ public String getName(); @@ -30,7 +30,7 @@ public interface IPackageDescriptor extends IElementDescriptor { /** * Returns a descriptor for a type in this package with the given name. The * given name is not package qualified. Inner types are '$'-separated. - * + * * @param typeQualifiedName type qualified name * @return type descriptor */ @@ -42,7 +42,7 @@ public interface IPackageDescriptor extends IElementDescriptor { * <p> * Extra type signature information may be provided for generic types. * </p> - * + * * @param typeQualifiedName type qualified name * @param signature type signature information or <code>null</code> * @return type descriptor diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IReferenceTypeDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IReferenceTypeDescriptor.java index 2394eec22a..a3a9b1ec52 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IReferenceTypeDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/descriptors/IReferenceTypeDescriptor.java @@ -18,7 +18,7 @@ package org.eclipse.pde.api.tools.internal.provisional.descriptors; * <p> * Package segments of a type name are dot-separated * </p> - * + * * @since 1.0.0 */ public interface IReferenceTypeDescriptor extends IMemberDescriptor { @@ -26,14 +26,14 @@ public interface IReferenceTypeDescriptor extends IMemberDescriptor { /** * Returns this type's fully qualified name. Package names are dot qualified * and inner types are '$'-separated. - * + * * @return type name */ public String getQualifiedName(); /** * Returns this type's signature. - * + * * @return type signature */ public String getSignature(); @@ -41,14 +41,14 @@ public interface IReferenceTypeDescriptor extends IMemberDescriptor { /** * Returns type signature information about this type or <code>null</code> * if none. May contain extra information for parameterized types. - * + * * @return type signature information for this type or <code>null</code> */ public String getGenericSignature(); /** * Returns a descriptor for the package this type is contained in. - * + * * @return package descriptor */ @Override @@ -56,7 +56,7 @@ public interface IReferenceTypeDescriptor extends IMemberDescriptor { /** * Returns a descriptor for a member type. - * + * * @param simpleName simple type name * @return type descriptor */ @@ -64,17 +64,17 @@ public interface IReferenceTypeDescriptor extends IMemberDescriptor { /** * Returns a descriptor for a field with the given name in this type. - * + * * @param name field name * @return field descriptor - * + * */ public IFieldDescriptor getField(String name); /** * Returns a descriptor for a non-synthetic method with the given name and * signature in this type. - * + * * @param name method name * @param signature method signature * @return method descriptor @@ -83,7 +83,7 @@ public interface IReferenceTypeDescriptor extends IMemberDescriptor { /** * Returns whether this type describes an anonymous inner type. - * + * * @return whether this type describes an anonymous inner type */ public boolean isAnonymous(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiScopeVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiScopeVisitor.java index 8ee546b224..52b0f17fdb 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiScopeVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiScopeVisitor.java @@ -14,7 +14,7 @@ import org.eclipse.core.runtime.CoreException; /** * Visits {@link IApiElement}s in an {@link IApiScope} - * + * * @since 1.0.0 */ public class ApiScopeVisitor { @@ -23,7 +23,7 @@ public class ApiScopeVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param component */ public void endVisit(IApiComponent component) { @@ -35,7 +35,7 @@ public class ApiScopeVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param baseline */ public void endVisit(IApiBaseline baseline) { @@ -47,7 +47,7 @@ public class ApiScopeVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param container */ public void endVisit(IApiTypeContainer container) { @@ -59,7 +59,7 @@ public class ApiScopeVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param typeRoot */ public void endVisit(IApiTypeRoot typeRoot) { @@ -74,7 +74,7 @@ public class ApiScopeVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param component API component being visited * @return whether class files in the component should be visited * @throws CoreException if an exception occurs during the visit @@ -90,7 +90,7 @@ public class ApiScopeVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param baseline API baseline being visited * @return whether API baseline's components should be visited * @throws CoreException if an exception occurs during the visit @@ -106,7 +106,7 @@ public class ApiScopeVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param container the given API type container being visited * @return whether types in the container should be visited * @throws CoreException if an exception occurs during the visit @@ -121,7 +121,7 @@ public class ApiScopeVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param typeRoot the given API type root being visited * @return whether types in the container should be visited * @throws CoreException if an exception occurs during the visit diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiTypeContainerVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiTypeContainerVisitor.java index 28a2f76699..70256caa74 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiTypeContainerVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/ApiTypeContainerVisitor.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.provisional.model; /** * Visits {@link IApiTypeRoot}s in an {@link IApiTypeContainer} - * + * * @since 1.0.0 */ public abstract class ApiTypeContainerVisitor { @@ -25,7 +25,7 @@ public abstract class ApiTypeContainerVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param component API component being visited * @return whether class files in the component should be visited */ @@ -39,7 +39,7 @@ public abstract class ApiTypeContainerVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param component API component */ public void end(IApiComponent component) { @@ -53,7 +53,7 @@ public abstract class ApiTypeContainerVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param container * @return */ @@ -66,7 +66,7 @@ public abstract class ApiTypeContainerVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param container */ public void end(IApiTypeContainer container) { @@ -80,7 +80,7 @@ public abstract class ApiTypeContainerVisitor { * The default implementation does nothing and returns <code>true</code>. * Subclasses may re-implement. * </p> - * + * * @param packageName fully qualified dot separated package name or the * empty string for the default package * @return whether class files in the package should be visited @@ -94,7 +94,7 @@ public abstract class ApiTypeContainerVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param packageName fully qualified dot separated package name or the * empty string for the default package */ @@ -107,7 +107,7 @@ public abstract class ApiTypeContainerVisitor { * <p> * The default implementation does nothing. * </p> - * + * * @param packageName fully qualified dot separated package name or the * empty string for the default package * @param typeroot {@link IApiTypeRoot} to visit @@ -121,7 +121,7 @@ public abstract class ApiTypeContainerVisitor { * <p> * The default implementation does nothing. Subclasses may re-implement. * </p> - * + * * @param packageName fully qualified dot separated package name or the * empty string for the default package * @param typeroot {@link IApiTypeRoot} ending visit on diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiBaseline.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiBaseline.java index 92a452b16a..fc9e1b05b8 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiBaseline.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiBaseline.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -17,7 +17,7 @@ import org.eclipse.core.runtime.IStatus; /** * A collection of related API components that together make up an * {@link IApiBaseline} that can be compared with another {@link IApiBaseline}. - * + * * @since 1.0.0 */ public interface IApiBaseline extends IApiElement { @@ -27,10 +27,10 @@ public interface IApiBaseline extends IApiElement { * in the order that components are searched when performing name lookup for * a type (simulates the order components would be searched when performing * class loading at runtime or name resolution at compile time). - * + * * This is a convenience method for retrieving all children of the baseline * that are {@link IApiComponent}s. - * + * * @return all API components in this baseline */ public IApiComponent[] getApiComponents(); @@ -38,7 +38,7 @@ public interface IApiBaseline extends IApiElement { /** * Allows the name of the baseline to be changed to the new name. If the new * name is <code>null</code>, no changes are made. - * + * * @param name the new name for the baseline */ public void setName(String name); @@ -46,7 +46,7 @@ public interface IApiBaseline extends IApiElement { /** * Adds the given API components to this baseline, excluding all the source * components. - * + * * @param components components to add * @throws CoreException if the baseline is disposed */ @@ -56,7 +56,7 @@ public interface IApiBaseline extends IApiElement { * Returns the API components that provides the specified package when * referenced from the specified source component or an empty array if none, * never <code>null</code>. - * + * * @param sourceComponent component referencing the package * @param packageName name of referenced package * @return API components providing the package or an empty array @@ -67,7 +67,7 @@ public interface IApiBaseline extends IApiElement { /** * Returns the API component in this baseline with the given symbolic name * or <code>null</code> if none. - * + * * @param id component symbolic name * @return API component or <code>null</code> */ @@ -76,7 +76,7 @@ public interface IApiBaseline extends IApiElement { /** * Returns the API component in this baseline for the given project or * <code>null</code> if none. - * + * * @param project the given project * @return API component or <code>null</code> */ @@ -92,7 +92,7 @@ public interface IApiBaseline extends IApiElement { * An execution environment is represented by a unique identifier as defined * by OSGi - for example "J2SE-1.4" or "CDC-1.0/Foundation-1.0". * </p> - * + * * @return execution environment identifier or <code>null</code> */ public String getExecutionEnvironment(); @@ -101,7 +101,7 @@ public interface IApiBaseline extends IApiElement { * Returns a status describing how the execution environment bound to this * API baseline satisfies the requirements of the components in this * baseline. - * + * * @return status describing execution environment bound to this baseline */ public IStatus getExecutionEnvironmentStatus(); @@ -119,7 +119,7 @@ public interface IApiBaseline extends IApiElement { * Closes all components in this baseline. The baseline may still be used * after closing, but clients should close the baseline when they are done * with it to free system resources. - * + * * @throws CoreException if closing fails */ public void close() throws CoreException; @@ -128,7 +128,7 @@ public interface IApiBaseline extends IApiElement { * Returns all components in this baseline depending on the given * components. The returned collection includes the given components and all * dependents. - * + * * @param components the initial set of components * @return an array of components for the given roots and all components in * the state that depend on them @@ -140,7 +140,7 @@ public interface IApiBaseline extends IApiElement { * Returns all the prerequisite components in this baseline for the given * components. The returned collection includes the given components and all * prerequisites. - * + * * @param components the initial set of components * @return an array of components for the given leaves and their * prerequisite components in this baseline @@ -154,14 +154,14 @@ public interface IApiBaseline extends IApiElement { * <p> * This is an absolute path. * </p> - * + * * @return location or <code>null</code> if none. */ public String getLocation(); /** * Allows the location of the baseline to be changed to the new location. - * + * * @param location the new location of the baseline */ public void setLocation(String location); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiComponent.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiComponent.java index c97cc5d56d..90a8c473e1 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiComponent.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiComponent.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.search.IReferenceCollection; * Describes the API of a software component. An API component is composed of a * set of {@link IApiTypeRoot}s owned by the component and a description * (manifest) of the component's API. - * + * * @since 1.0.0 */ public interface IApiComponent extends IApiTypeContainer { @@ -30,14 +30,14 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns this component's symbolic name. This is a handle-only method - * the component may not exist or may be disposed. - * + * * @return component's symbolic name */ public String getSymbolicName(); /** * Returns this component's API description. - * + * * @return API description for this component * @throws CoreException if there was a problem creating the API description * for this component @@ -50,14 +50,14 @@ public interface IApiComponent extends IApiTypeContainer { * a component has no underlying description it will return one from * {@link #getApiDescription()}, but it will be empty. This method allows * clients to know if there was any thing used to populate the description. - * + * * @return whether this component has an underlying API description */ public boolean hasApiDescription(); /** * Returns this component's version identifier. - * + * * @return component version */ public String getVersion(); @@ -68,7 +68,7 @@ public interface IApiComponent extends IApiTypeContainer { * identifier as defined by OSGi - for example "J2SE-1.4" or * "CDC-1.0/Foundation-1.0". Any of the environments will allow this * component to be resolved. - * + * * @return execution environment identifier * @throws CoreException if its baseline is disposed */ @@ -78,7 +78,7 @@ public interface IApiComponent extends IApiTypeContainer { * Returns {@link IApiTypeContainer}s containing the {@link IApiTypeRoot}s * associated with this component in the order they would appear on the * build path or class path. - * + * * @return {@link IApiTypeContainer}s */ public IApiTypeContainer[] getApiTypeContainers() throws CoreException; @@ -87,10 +87,10 @@ public interface IApiComponent extends IApiTypeContainer { * Returns {@link IApiTypeContainer}s containing the {@link IApiTypeRoot}s * associated with this component that comes from the given component id in * the order they would appear on the build path or class path. - * + * * This is used to filter out the {@link IApiTypeContainer}s coming from a * fragment - * + * * @param id the given component id * @return {@link IApiTypeContainer}s * @throws CoreException if its baseline is disposed @@ -100,7 +100,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns a collection of descriptions of components required by this * component or an empty collection if none. - * + * * @return required component descriptions, possibly empty * @throws CoreException if its baseline is disposed */ @@ -108,7 +108,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns the location of this API component. - * + * * @return location */ public String getLocation(); @@ -117,7 +117,7 @@ public interface IApiComponent extends IApiTypeContainer { * Returns if the component is a system component (a JRE definition for * example) or not. System components are not persisted with baselines, as * they are recreated dynamically by the framework - * + * * @return true if the component is a system component, false otherwise */ public boolean isSystemComponent(); @@ -125,7 +125,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns if the component is a source component or not. A source component * is not persisted with profiles, as they don't contain any binaries. - * + * * <p> * A component is a source component if and only if one of the following * conditions is true: @@ -139,7 +139,7 @@ public interface IApiComponent extends IApiTypeContainer { * extension point if the component is a fragment. * <code>org.eclipse.pde.core.source</code></li> * </ul> - * + * * @return true if the component is a source component, false otherwise * @throws CoreException if its baseline is disposed */ @@ -154,7 +154,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns the {@link IApiBaseline} this component is contained in. - * + * * @return the parent {@link IApiBaseline} * @throws CoreException if its baseline is disposed */ @@ -163,7 +163,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns a store of problem filters defined for this component or * <code>null</code> if none. - * + * * @return filter store or <code>null</code> * @throws CoreException if its baseline is disposed */ @@ -171,7 +171,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns whether this API component is a fragment. - * + * * @return whether this API component is a fragment * @throws CoreException if its baseline is disposed */ @@ -180,7 +180,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns the host {@link IApiComponent} for this component iff this * component is a fragment. Otherwise <code>null</code> is returned. - * + * * @return the host {@link IApiComponent} for this component or * <code>null</code>. * @throws CoreException if the baseline is disposed @@ -189,7 +189,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns whether this API component is the host of one or more fragments. - * + * * @return whether this API component is the host of one or more fragments * @throws CoreException if its baseline is disposed */ @@ -200,7 +200,7 @@ public interface IApiComponent extends IApiTypeContainer { * building and running. An execution environment is represented by a unique * identifier as defined by OSGi - for example "J2SE-1.4" or * "CDC-1.0/Foundation-1.0". - * + * * <p> * The result will be more than one execution environment when the * corresponding api component has a mixed of execution environments in the @@ -211,7 +211,7 @@ public interface IApiComponent extends IApiTypeContainer { * Since the latter ones are not exact subsets of the ones from the JREs * family, we need to return all the incompatible ones. * </p> - * + * * @return execution environment identifiers * @throws CoreException if its baseline is disposed */ @@ -219,7 +219,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns the list of errors found during the component resolution. - * + * * @return the list of errors or <code>null</code> if none * @throws CoreException if its baseline is disposed */ @@ -227,7 +227,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns the associated element descriptor for this member. - * + * * @return element descriptor */ public IElementDescriptor getHandle(); @@ -235,7 +235,7 @@ public interface IApiComponent extends IApiTypeContainer { /** * Returns all references to this component as registered by API use scans * with the Use Scan Manager. - * + * * @return the collection of reference descriptors */ public IReferenceCollection getExternalDependencies(); 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 a48d8283e1..8d29ed69c7 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 @@ -12,9 +12,9 @@ package org.eclipse.pde.api.tools.internal.provisional.model; /** * Describes an element that can appear in the API Tools model. - * + * * @since 1.0.0 - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. */ @@ -60,14 +60,14 @@ public interface IApiElement { /** * Returns the name of this element - * + * * @return the element name */ public String getName(); /** * Returns this element's kind encoded as an integer. - * + * * @return the kind of element; one of the constants declared in * <code>IApiElement</code> * @see IApiElement @@ -77,7 +77,7 @@ public interface IApiElement { /** * Returns the immediate parent {@link IApiElement} of this element, or * <code>null</code> if this element has no parent - * + * * @return the immediate parent of this element or <code>null</code> */ public IApiElement getParent(); @@ -85,7 +85,7 @@ public interface IApiElement { /** * Returns the first ancestor of this API element that has the given type. * Returns <code>null</code> if no such ancestor can be found. - * + * * @param ancestorType the given type * @return the first ancestor of this API element that has the given type, * or <code>null</code> if no such an ancestor can be found @@ -95,7 +95,7 @@ public interface IApiElement { /** * Returns the API component this type originated from or <code>null</code> * if unknown. - * + * * @return API component this type originated from or <code>null</code> */ public IApiComponent getApiComponent(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiField.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiField.java index 698fc18a8f..5222abed57 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiField.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiField.java @@ -12,12 +12,12 @@ package org.eclipse.pde.api.tools.internal.provisional.model; /** * A field type member. - * + * * @see IApiType * @see IApiMethod - * + * * @since 1.1 - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. */ @@ -25,14 +25,14 @@ public interface IApiField extends IApiMember { /** * Returns whether this field represents a constant in an enum type. - * + * * @return whether this field represents a constant in an enum type */ public boolean isEnumConstant(); /** * Returns the constant value for this field or <code>null</code> if none. - * + * * @return constant value or <code>null</code> */ public Object getConstantValue(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMember.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMember.java index d0c4cc126e..11ac431f90 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMember.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMember.java @@ -18,13 +18,13 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IMemberDescrip * can appear as a member of another {@link IApiElement}. <br> * <br> * For example a type, field or method. - * + * * @see IApiType * @see IApiMethod * @see IApiField - * + * * @since 1.1 - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. */ @@ -32,7 +32,7 @@ public interface IApiMember extends IApiElement { /** * Returns the type this member is declared in or <code>null</code> if none. - * + * * @return enclosing type or <code>null</code> * @exception CoreException if unable to retrieve enclosing type */ @@ -41,7 +41,7 @@ public interface IApiMember extends IApiElement { /** * Returns the modifier bit mask associated with this member or -1 if * unknown. Modifiers are as defined by {@link org.eclipse.jdt.core.Flags} - * + * * @return modifiers bit mask * @exception CoreException if this element does not exist or there in an * error reading its underlying storage @@ -50,7 +50,7 @@ public interface IApiMember extends IApiElement { /** * Returns the signature of member - * + * * @return member signature */ public String getSignature(); @@ -59,7 +59,7 @@ public interface IApiMember extends IApiElement { * Returns type generic signature information about this member or * <code>null</code> if none. May contain extra information for * parameterized types. - * + * * @return generic type signature information for this type or * <code>null</code> */ @@ -67,14 +67,14 @@ public interface IApiMember extends IApiElement { /** * Returns the name of the package that this member is located in - * + * * @return the name of the enclosing package for this member */ public String getPackageName(); /** * Returns the associated element descriptor for this member. - * + * * @return element descriptor */ public IMemberDescriptor getHandle(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMethod.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMethod.java index 872f065cd1..2039efa8a3 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMethod.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiMethod.java @@ -12,9 +12,9 @@ package org.eclipse.pde.api.tools.internal.provisional.model; /** * A method type member. - * + * * @since 1.1 - * + * * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. */ @@ -29,7 +29,7 @@ public interface IApiMethod extends IApiMember { * <code>public void foo(String text, int length)</code> would return * <code>"(Ljava.lang.String;I)V"</code>. * </p> - * + * * @return the signature of this method */ @Override @@ -37,21 +37,21 @@ public interface IApiMethod extends IApiMember { /** * Returns whether this method is a constructor. - * + * * @return whether this method is a constructor */ public boolean isConstructor(); /** * Returns whether this method is a class initializer. - * + * * @return whether this method is a class initializer */ public boolean isClassInitializer(); /** * Returns whether this method is a default method or not. - * + * * @return whether this method is a default method */ public boolean isDefaultMethod(); @@ -59,7 +59,7 @@ public interface IApiMethod extends IApiMember { /** * Returns names of exceptions thrown by this method, or <code>null</code> * if none - * + * * @return exception names thrown by this method or <code>null</code> */ public String[] getExceptionNames(); @@ -67,21 +67,21 @@ public interface IApiMethod extends IApiMember { /** * Returns the default value for this method or <code>null</code> if none. * Only applies to methods contained in annotations. - * + * * @return default value or <code>null</code> */ public String getDefaultValue(); /** * Returns whether this method is synthetic. - * + * * @return whether this method is synthetic */ public boolean isSynthetic(); /** * Returns whether this method is polymorphic. - * + * * @return whether this method is polymorphic */ public boolean isPolymorphic(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiScope.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiScope.java index ebc170bf9c..87dfabf942 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiScope.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiScope.java @@ -14,28 +14,28 @@ import org.eclipse.core.runtime.CoreException; /** * Describes a set of {@link IApiElement}. - * + * * @since 1.1.0 */ public interface IApiScope { /** * Adds the given {@link IApiElement} to the scope - * + * * @param newelements */ public void addElement(IApiElement newelement); /** * Returns all API elements contained within this scope - * + * * @return all API elements contained within this scope */ IApiElement[] getApiElements(); /** * Visits all {@link IApiElement} in this scope. - * + * * @param visitor class file visitor. * @exception CoreException if unable to visit this scope */ @@ -43,7 +43,7 @@ public interface IApiScope { /** * Returns if this scope encloses the given element - * + * * @param element * @return true if this scope encloses the given element, false otherwise */ 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 5df60342b2..c6ff570688 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 @@ -19,10 +19,10 @@ import org.eclipse.pde.api.tools.internal.provisional.builder.IReference; /** * Provides the structure of a type - for example, a class or interface along * with its methods and fields. - * + * * @see IApiMethod * @see IApiField - * + * * @since 1.1 * @noimplement This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients. @@ -33,7 +33,7 @@ public interface IApiType extends IApiMember { * Returns the {@link IApiMethod} that encloses this type, iff this type is * a local type (class defined in a method body). A call to this method will * load the enclosing type to find the enclosing method. - * + * * @return the {@link IApiMethod} that encloses this type or * <code>null</code> */ @@ -42,7 +42,7 @@ public interface IApiType extends IApiMember { /** * Returns the field with the specified name in this type (for example, * <code>"bar"</code>), or <code>null</code> if none. - * + * * @param name the given name * @return the field with the specified name in this type or * <code>null</code> @@ -51,7 +51,7 @@ public interface IApiType extends IApiMember { /** * Returns the fields declared by this type. - * + * * @return the fields declared by this type */ public IApiField[] getFields(); @@ -61,7 +61,7 @@ public interface IApiType extends IApiMember { * For example, <code>"foo", "(Ljava.lang.String;I)V"</code>, retrieves the * method <code>foo(String, int)</code>. To retrieve a constructor, * <code>"<init>"</code> must specified must be as method name. - * + * * @param name method name * @param parameterTypeSignatures parameter types * @return the method with the specified name and parameter types in this @@ -71,21 +71,21 @@ public interface IApiType extends IApiMember { /** * Returns the methods and constructors declared by this type. - * + * * @return the methods and constructors declared by this type */ public IApiMethod[] getMethods(); /** * Returns whether this type is an anonymous type. - * + * * @return true if this type is an anonymous type, false otherwise */ public boolean isAnonymous(); /** * Returns whether this type is a local type. - * + * * @return whether this type is a local type */ public boolean isLocal(); @@ -96,7 +96,7 @@ public interface IApiType extends IApiMember { * Note that a class can neither be an interface, an enumeration class, nor * an annotation type. * </p> - * + * * @return true if this type represents a class, false otherwise */ public boolean isClass(); @@ -107,7 +107,7 @@ public interface IApiType extends IApiMember { * Note that an enumeration class can neither be a class, an interface, nor * an annotation type. * </p> - * + * * @return true if this type represents an enumeration class, false * otherwise */ @@ -119,7 +119,7 @@ public interface IApiType extends IApiMember { * Note that an interface can also be an annotation type, but it can neither * be a class nor an enumeration class. * </p> - * + * * @return true if this type represents an interface, false otherwise */ public boolean isInterface(); @@ -130,14 +130,14 @@ public interface IApiType extends IApiMember { * Note that an annotation type is also an interface, but it can neither be * a class nor an enumeration class. * </p> - * + * * @return true if this type represents an annotation type, false otherwise */ public boolean isAnnotation(); /** * Returns whether this type is a member type. - * + * * @return whether this type is a member type */ public boolean isMemberType(); @@ -154,7 +154,7 @@ public interface IApiType extends IApiMember { * display purposes, use {@link #getSuperclassTypeSignature()} which returns * a structured type signature string containing more precise information. * </p> - * + * * @return the name of this type's superclass or <code>null</code> */ public String getSuperclassName(); @@ -162,7 +162,7 @@ public interface IApiType extends IApiMember { /** * Returns the superclass of this class or <code>null</code> if none. For * interfaces, java.lang.Object is returned. - * + * * @return superclass or <code>null</code> * @throws CoreException if unable to retrieve the superclass */ @@ -176,7 +176,7 @@ public interface IApiType extends IApiMember { * interfaces, this gives the interfaces that this interface extends. Null * is returned if this type does not implement or extend any interfaces. * </p> - * + * * @return the names of interfaces that this type implements or extends, or * <code>null</code> if none */ @@ -185,7 +185,7 @@ public interface IApiType extends IApiMember { /** * Returns the resolved super interfaces that this type implements or * extends, or an empty collection if none. - * + * * @return resolved super interfaces * @throws CoreException if unable to retrieve super interfaces */ @@ -193,7 +193,7 @@ public interface IApiType extends IApiMember { /** * Returns member types contained in this type. - * + * * @return member types, possibly an empty array * @exception CoreException if unable to retrieve member types */ @@ -202,7 +202,7 @@ public interface IApiType extends IApiMember { /** * Returns the member type with the given simple name or <code>null</code> * if none. - * + * * @param simpleName simple name * @return member type or <code>null</code> * @exception CoreException if unable to retrieve the type @@ -211,14 +211,14 @@ public interface IApiType extends IApiMember { /** * Returns the simple (unqualified) name for this type. - * + * * @return unqualified name */ public String getSimpleName(); /** * Returns the {@link IApiTypeRoot} that this type is defined in - * + * * @return the {@link IApiTypeRoot} this type is defined in */ public IApiTypeRoot getTypeRoot(); @@ -226,7 +226,7 @@ public interface IApiType extends IApiMember { /** * Extracts and returns all references made from this type of the specified * 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} diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeContainer.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeContainer.java index 9309372de8..25528e129f 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeContainer.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeContainer.java @@ -14,7 +14,7 @@ import org.eclipse.core.runtime.CoreException; /** * A container which can contain a set of source or class files. - * + * * @since 1.0.0 */ public interface IApiTypeContainer extends IApiElement { @@ -39,7 +39,7 @@ public interface IApiTypeContainer extends IApiElement { /** * Returns the names of all packages in this container in dot separated * format. Does not include empty packages. - * + * * @return names of all packages in this container * @exception if unable to retrieve package names */ @@ -48,7 +48,7 @@ public interface IApiTypeContainer extends IApiElement { /** * Returns the {@link IApiTypeRoot} with the given fully qualified name or * <code>null</code> if none. - * + * * @param qualifiedName fully qualified type name. Package names are dot * separated and type names are '$'-separated. * @return {@link IApiTypeRoot} or <code>null</code> @@ -59,7 +59,7 @@ public interface IApiTypeContainer extends IApiElement { /** * Returns the {@link IApiTypeRoot} with the given fully qualified name * coming from the component with the given id or <code>null</code> if none. - * + * * @param qualifiedName fully qualified type name. Package names are dot * separated and type names are '$'-separated. * @param id the API component id to consider @@ -70,7 +70,7 @@ public interface IApiTypeContainer extends IApiElement { /** * Visits all {@link IApiTypeRoot} in this container. - * + * * @param visitor class file visitor. * @exception CoreException if unable to visit this container */ @@ -80,7 +80,7 @@ public interface IApiTypeContainer extends IApiElement { * Closes this {@link IApiTypeContainer}. The container may still be used * after closing, but clients should close the container when they are done * with it to free system resources. - * + * * @throws CoreException if closing fails */ public void close() throws CoreException; @@ -93,7 +93,7 @@ public interface IApiTypeContainer extends IApiElement { * <li>{@link #FOLDER}</li> * <li>{@link #STUB}</li> * </ul> - * + * * @return the type of container this is */ public int getContainerType(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeRoot.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeRoot.java index d62c18d947..4c715c1345 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeRoot.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/model/IApiTypeRoot.java @@ -14,7 +14,7 @@ import org.eclipse.core.runtime.CoreException; /** * Handle to the structure of a class, interface, annotation, or enum. - * + * * @since 1.0.0 */ public interface IApiTypeRoot extends IApiElement { @@ -22,7 +22,7 @@ public interface IApiTypeRoot extends IApiElement { /** * Returns the fully qualified name of the type this storage represents. * Package names are dot separated and type names are '$'-separated. - * + * * @return fully qualified type name */ public String getTypeName(); @@ -30,7 +30,7 @@ public interface IApiTypeRoot extends IApiElement { /** * Returns the structure contained in this type storage. I.e. access to the * methods, fields, and member types in the associated type. - * + * * @return structure of associated type or <code>null</code> if a problem * occurs creating the new type * @exception CoreException if unable to retrieve the structure @@ -42,7 +42,7 @@ public interface IApiTypeRoot extends IApiElement { * <code>null</code> if unknown. Note that the component will only be * <code>null</code> in the case that a class file container was created * without an owning component. - * + * * @return API component or <code>null</code> if unknown */ @Override 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 544b8b0991..4b4cf44edf 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 @@ -16,7 +16,7 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IElementDescri /** * Describes a given API problem. - * + * * @since 1.0.0 * @noimplement This interface is not intended to be implemented by clients. */ @@ -54,7 +54,7 @@ public interface IApiProblem { /** * Constant representing a fatal problem i.e. a fatal JDT problem has been * detected - * + * * @since 1.1 */ public static final int CATEGORY_FATAL_PROBLEM = 0x70000000; @@ -102,7 +102,7 @@ public interface IApiProblem { * Constant representing the value of the invalid @since tag * {@link IApiProblem} kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_SINCETAGS */ @@ -112,7 +112,7 @@ public interface IApiProblem { * Constant representing the value of the malformed @since tag * {@link IApiProblem} kind. <br> * Value is: <code>2</code> - * + * * @see #getKind() * @see #CATEGORY_SINCETAGS */ @@ -122,7 +122,7 @@ public interface IApiProblem { * Constant representing the value of the missing @since tag * {@link IApiProblem} kind. <br> * Value is: <code>3</code> - * + * * @see #getKind() * @see #CATEGORY_SINCETAGS */ @@ -132,7 +132,7 @@ public interface IApiProblem { * Constant representing the value of the major version change * {@link IApiProblem} kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_VERSION */ @@ -142,7 +142,7 @@ public interface IApiProblem { * Constant representing the value of the minor version change * {@link IApiProblem} kind. <br> * Value is: <code>2</code> - * + * * @see #getKind() * @see #CATEGORY_VERSION */ @@ -152,7 +152,7 @@ public interface IApiProblem { * Constant representing the value of the major version change (no API * breakage) {@link IApiProblem} kind. <br> * Value is: <code>3</code> - * + * * @see #getKind() * @see #CATEGORY_VERSION */ @@ -162,7 +162,7 @@ public interface IApiProblem { * Constant representing the value of the minor version change (no new API) * {@link IApiProblem} kind. <br> * Value is: <code>4</code> - * + * * @see #getKind() * @see #CATEGORY_VERSION */ @@ -173,7 +173,7 @@ public interface IApiProblem { * {@link IApiProblem} kind as a consequence of a major version change in a * re-exported bundle. <br> * Value is: <code>5</code> - * + * * @see #getKind() * @see #CATEGORY_VERSION */ @@ -184,7 +184,7 @@ public interface IApiProblem { * {@link IApiProblem} kind as a consequence of a minor version change in a * re-exported bundle.. <br> * Value is: <code>6</code> - * + * * @see #getKind() * @see #CATEGORY_VERSION */ @@ -194,7 +194,7 @@ public interface IApiProblem { * Constant representing the value of an illegal extend {@link IApiProblem} * kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -204,7 +204,7 @@ public interface IApiProblem { * Constant representing the value of an illegal instantiate * {@link IApiProblem} kind. <br> * Value is: <code>2</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -214,7 +214,7 @@ public interface IApiProblem { * Constant representing the value of an illegal reference * {@link IApiProblem} kind. <br> * Value is: <code>3</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -224,7 +224,7 @@ public interface IApiProblem { * Constant representing the value of an illegal implement * {@link IApiProblem} kind. <br> * Value is: <code>4</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -234,7 +234,7 @@ public interface IApiProblem { * Constant representing the value of an illegal override * {@link IApiProblem} kind. <br> * Value is: <code>5</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -243,7 +243,7 @@ public interface IApiProblem { /** * Constant representing the value of an API leak {@link IApiProblem} kind. <br> * Value is: <code>6</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -253,7 +253,7 @@ public interface IApiProblem { * Constant representing the value of an invalid API javadoc tag use * {@link IApiProblem} kind <br> * Value is: <code>7</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -263,7 +263,7 @@ public interface IApiProblem { * Constant representing the value of a duplicate API Javadoc tag use * {@link IApiProblem} kind <br> * Value is: <code>8</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -273,7 +273,7 @@ public interface IApiProblem { * Constant representing the value of an illegal reference inside system * libraries use {@link IApiProblem} kind <br> * Value is: <code>9</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -282,7 +282,7 @@ public interface IApiProblem { * Constant representing the value of an unused API problem filter * {@link IApiProblem} kind <br> * Value is:<code>10</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE */ @@ -292,7 +292,7 @@ public interface IApiProblem { * preferences are configured to perform the system library scans * {@link IApiProblem} kind <br> * Value is:<code>11</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE * @since 1.0.400 @@ -302,7 +302,7 @@ public interface IApiProblem { * Constant representing the value of a duplicate annotation in use <br> * <br> * Value is: <code>12</code> - * + * * @see #getKind() * @see #CATEGORY_USAGE * @since 1.0.600 @@ -312,14 +312,14 @@ public interface IApiProblem { * COnstant representing the value of an unsupported annotation in use <br> * <br> * Value is: <code>13</code> - * + * * @since 1.0.600 */ public static final int UNSUPPORTED_ANNOTATION_USE = 13; /** * Flags to indicate a leak from extending a non-API type. <br> * Value is: <code>1</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -328,7 +328,7 @@ public interface IApiProblem { /** * Flags to indicate a leak from implementing a non-API type. <br> * Value is: <code>2</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -337,7 +337,7 @@ public interface IApiProblem { /** * Flags to indicate a leak from a field declaration. <br> * Value is: <code>3</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -346,7 +346,7 @@ public interface IApiProblem { /** * Flags to indicate a leak from a return type. <br> * Value is: <code>4</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -355,7 +355,7 @@ public interface IApiProblem { /** * Flags to indicate a leak from a method parameter <br> * Value is: <code>5</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -364,7 +364,7 @@ public interface IApiProblem { /** * Flags to indicate a leak from a constructor parameter <br> * Value is: <code>6</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -373,7 +373,7 @@ public interface IApiProblem { /** * Flags to indicate a constructor method <br> * Value is: <code>7</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -382,7 +382,7 @@ public interface IApiProblem { /** * Flags to indicate a 'normal' method <br> * Value is: <code>8</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -391,7 +391,7 @@ public interface IApiProblem { /** * Flags to indicate a field <br> * Value is: <code>9</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -400,7 +400,7 @@ public interface IApiProblem { /** * Flags to indicate a local type (a class defined in a method) <br> * Value is: <code>10</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -409,7 +409,7 @@ public interface IApiProblem { /** * Flags to indicate an anonymous type <br> * Value is: <code>11</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -418,7 +418,7 @@ public interface IApiProblem { /** * Flags to indicate an indirect reference <br> * Value is: <code>12</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -427,7 +427,7 @@ public interface IApiProblem { /** * Flags to indicate an indirect reference from a local type <br> * Value is: <code>13</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE */ @@ -436,10 +436,10 @@ public interface IApiProblem { * Flags to indicate a reference to an annotation <br> * <br> * Values is: <code>14</code> - * + * * @see #getFlags() * @see #CATEGORY_USAGE - * + * * @since 1.0.600 */ public static final int ANNOTATION = 14; @@ -448,7 +448,7 @@ public interface IApiProblem { * Constant representing the value of a default API profile * {@link IApiProblem} kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_API_BASELINE */ @@ -458,7 +458,7 @@ public interface IApiProblem { * Constant representing the value of a API component resolution * {@link IApiProblem} kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_API_COMPONENT_RESOLUTION */ @@ -468,7 +468,7 @@ public interface IApiProblem { * Constant representing the value of a workspace baseline resolution * {@link IApiProblem} kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_FATAL_PROBLEM */ @@ -476,7 +476,7 @@ public interface IApiProblem { /** * Constant representing the value of a type {@link IApiProblem} kind. <br> * Value is: <code>1</code> - * + * * @see #getKind() * @see #CATEGORY_API_USE_SCAN_PROBLEM */ @@ -484,7 +484,7 @@ public interface IApiProblem { /** * Constant representing the value of a method {@link IApiProblem} kind. <br> * Value is: <code>2</code> - * + * * @see #getKind() * @see #CATEGORY_API_USE_SCAN_PROBLEM */ @@ -492,7 +492,7 @@ public interface IApiProblem { /** * Constant representing the value of a field {@link IApiProblem} kind. <br> * Value is: <code>3</code> - * + * * @see #getKind() * @see #CATEGORY_API_USE_SCAN_PROBLEM */ @@ -500,7 +500,7 @@ public interface IApiProblem { /** * Constant indicating a use scan reference cannot be resolved <br> * Value is: <code>1</code> - * + * * @see #getFlags() * @see #CATEGORY_API_USE_SCAN_PROBLEM * @since 1.0.400 @@ -509,7 +509,7 @@ public interface IApiProblem { /** * Constant indicating a use scan reference has been deleted <br> * Value is: <code>2</code> - * + * * @see #getFlags() * @see #CATEGORY_API_USE_SCAN_PROBLEM * @since 1.0.400 @@ -520,7 +520,7 @@ public interface IApiProblem { * Returns the severity of the problem. See the severity constants defined * in {@link org.eclipse.pde.api.tools.internal.provisional.ApiPlugin} * class. - * + * * @return the severity of the problem * @see org.eclipse.pde.api.tools.internal.provisional.ApiPlugin#SEVERITY_ERROR * @see org.eclipse.pde.api.tools.internal.provisional.ApiPlugin#SEVERITY_WARNING @@ -530,17 +530,17 @@ public interface IApiProblem { /** * Returns the kind of element this problem is related to. - * + * * @see IElementDescriptor#getElementType() * @see IDelta#getElementType() - * + * * @return the element kind this problem is related to. */ public int getElementKind(); /** * Returns the id used to lookup the message for this problem. - * + * * @return the message id */ public int getMessageid(); @@ -548,7 +548,7 @@ public interface IApiProblem { /** * Returns the project relative path to the resource this problem was found * in, or <code>null</code> if none. - * + * * @return the project relative path to the resource the problem was found * in, or null if none */ @@ -557,7 +557,7 @@ public interface IApiProblem { /** * Returns the fully qualified type name to the type this problem was found * in, or <code>null</code> if none. - * + * * @return the fully qualified type name to the type this problem , null if * none. was found in */ @@ -566,7 +566,7 @@ public interface IApiProblem { /** * Returns the listing of message arguments passed in to the problem or an * empty array, never <code>null</code> - * + * * @return the message arguments passed to the problem or an empty array */ public String[] getMessageArguments(); @@ -574,7 +574,7 @@ public interface IApiProblem { /** * Returns the start of the character selection to make, or -1 if there is * no character starting position. - * + * * @return the start of the character selection or -1. */ public int getCharStart(); @@ -582,7 +582,7 @@ public interface IApiProblem { /** * Returns the end of the character selection to make, or -1 if there is no * character ending position. - * + * * @return the end of the character selection or -1 */ public int getCharEnd(); @@ -590,7 +590,7 @@ public interface IApiProblem { /** * Returns the number of the line this problem occurred on, or -1 if there * is no line number. - * + * * @return the line number this problem occurred on or -1 */ public int getLineNumber(); @@ -607,7 +607,7 @@ public interface IApiProblem { * <li>{@link #CATEGORY_FATAL_PROBLEM}</li> * <li>{@link #CATEGORY_API_USE_SCAN_PROBLEM}</li> * </ul> - * + * * @return the category for the problem */ public int getCategory(); @@ -615,28 +615,28 @@ public interface IApiProblem { /** * Returns the unique id of the problem. A problem Id is the composition of * the category, kind, flags and severity. - * + * * @return the id of the problem */ public int getId(); /** * Returns a human readable, localized description of the problem - * + * * @return the description of the problem */ public String getMessage(); /** * Returns the kind of this problem. - * + * * @return the kind of this problem */ public int getKind(); /** * Returns the flags for this problem. - * + * * @return the flags for this problem */ public int getFlags(); @@ -665,7 +665,7 @@ public interface IApiProblem { * attributes will be inserted after default ones (as described in * {@link CategorizedProblem#getMarkerType()}, and thus could be used to * override defaults. - * + * * @return the names of the corresponding marker attributes */ public String[] getExtraMarkerAttributeIds(); @@ -677,7 +677,7 @@ public interface IApiProblem { * {@link #getExtraMarkerAttributeIds()}. The values must be eligible for * marker creation, as defined by * <code> IMarker#setAttributes(String[], Object[])}. - * + * * @return the values of the corresponding extra marker attributes */ public Object[] getExtraMarkerAttributeValues(); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemFilter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemFilter.java index 4e66550e0c..7b5d4086f7 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemFilter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemFilter.java @@ -17,7 +17,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent; * <p> * Problem filters are created from an {@link IApiComponent}. * </p> - * + * * @since 1.0.0 */ public interface IApiProblemFilter { @@ -25,14 +25,14 @@ public interface IApiProblemFilter { /** * Returns the identifier of the API component this filter applies to. * Problems contained within this component are potentially filtered. - * + * * @return identifier of the API component this filter applies to */ public String getComponentId(); /** * Returns the underlying {@link IApiProblem} for this filter. - * + * * @return the underlying {@link IApiProblem} for this filter */ public IApiProblem getUnderlyingProblem(); @@ -40,7 +40,7 @@ public interface IApiProblemFilter { /** * Returns the comment associated with this filter or <code>null</code> if a * comment has not been added to the filter. - * + * * @return the comment for the filter or <code>null</code> * @since 1.1 */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemTypes.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemTypes.java index 55a2f22f46..a1587838dc 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemTypes.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/problems/IApiProblemTypes.java @@ -15,7 +15,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * API problem types. - * + * * @since 1.0 * @noimplement This interface is not intended to be implemented by clients. */ @@ -179,7 +179,7 @@ public interface IApiProblemTypes { public static final String INVALID_JAVADOC_TAG = "INVALID_JAVADOC_TAG"; //$NON-NLS-1$ /** * Key for an annotation appearing where it is not supported - * + * * @since 1.0.600 */ public static final String INVALID_ANNOTATION = "INVALID_ANNOTATION"; //$NON-NLS-1$ @@ -194,7 +194,7 @@ public interface IApiProblemTypes { public static final String UNUSED_PROBLEM_FILTERS = "UNUSED_PROBLEM_FILTERS"; //$NON-NLS-1$ /** * Key for the severity of no EE descriptions being installed - * + * * @since 1.0.400 */ public static final String MISSING_EE_DESCRIPTIONS = "MISSING_EE_DESCRIPTIONS"; //$NON-NLS-1$ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/scanner/TagScanner.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/scanner/TagScanner.java index fa86821d45..8f150c29da 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/scanner/TagScanner.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/scanner/TagScanner.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -59,7 +59,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Scans the source of a *.java file for any API javadoc tags - * + * * @since 1.0.0 */ public class TagScanner { @@ -92,7 +92,7 @@ public class TagScanner { /** * Constructor - * + * * @param description API description to annotate * @param container class file container or <code>null</code>, used to * resolve method signatures @@ -104,7 +104,7 @@ public class TagScanner { /** * A type has been entered - update the type being visited. - * + * * @param name name from type node */ private void enterType(SimpleName name) { @@ -161,10 +161,10 @@ public class TagScanner { /** * Checks the annotation name found on the given {@link TypeDeclaration} - * + * * @param name the name of the annotation * @param node the parent {@link TypeDeclaration} - * + * * @since 1.0.600 */ void scanTypeAnnotation(String name, TypeDeclaration node) { @@ -194,7 +194,7 @@ public class TagScanner { /** * Checks the annotation name found on the given * {@link FieldDeclaration} - * + * * @param name the annotation name * @param node the parent {@link FieldDeclaration} */ @@ -213,10 +213,10 @@ public class TagScanner { /** * Checks the annotation name found on the given * {@link MethodDeclaration} - * + * * @param name the name of the annotation * @param node the parent {@link MethodDeclaration} - * + * * @since 1.0.600 */ void scanMethodAnnotation(String name, MethodDeclaration node) { @@ -274,7 +274,7 @@ public class TagScanner { /** * Scans the JavaDoc of a {@link TypeDeclaration} - * + * * @param node the type * @since 1.0.600 */ @@ -346,7 +346,7 @@ public class TagScanner { /** * Scans the JavaDoc of an {@link AnnotationTypeDeclaration} - * + * * @param node the annotation * @since 1.0.600 */ @@ -381,7 +381,7 @@ public class TagScanner { /** * Scans the JavaDoc of an {@link EnumDeclaration} - * + * * @param node the enum * @since 1.0.600 */ @@ -437,7 +437,7 @@ public class TagScanner { /** * Scans the JavaDoc node of a {@link MethodDeclaration} - * + * * @param node the method * @since 1.0.600 */ @@ -506,7 +506,7 @@ public class TagScanner { /** * Scans the JavaDoc nodes of a {@link FieldDeclaration} - * + * * @param node the field * @since 1.0.600 */ @@ -533,7 +533,7 @@ public class TagScanner { /** * Determine if the flags contain private or package default flags - * + * * @param flags * @return <code>true</code> if the flags are private or default, * <code>false</code> otherwise @@ -550,7 +550,7 @@ public class TagScanner { /** * Delegate for getting the singleton instance of the scanner - * + * * @return */ public static final TagScanner newScanner() { @@ -569,7 +569,7 @@ public class TagScanner { /** * Scans the specified {@link ICompilationUnit} for contributed API Javadoc * tags. Tags on methods will have unresolved signatures. - * + * * @param unit the compilation unit source * @param description the API description to annotate with any new tag rules * found @@ -578,7 +578,7 @@ public class TagScanner { * signatures if required (for tags on methods). If not provided * (<code>null</code>), method signatures will be unresolved. * @param monitor - * + * * @throws CoreException if problems were encountered while scanning tags, * the description may still be modified */ @@ -589,7 +589,7 @@ public class TagScanner { /** * Scans the specified source {@linkplain CompilationUnit} for contributed * API javadoc tags. Tags on methods will have unresolved signatures. - * + * * @param source the source file to scan for tags * @param description the API description to annotate with any new tag rules * found @@ -601,7 +601,7 @@ public class TagScanner { * AST to scan or <code>null</code> if default options should be * used * @param monitor - * + * * @throws CoreException if problems were encountered while scanning tags, * the description may still be modified */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/ApiSearchEngine.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/ApiSearchEngine.java index 9df995adb8..648668e626 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/ApiSearchEngine.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/ApiSearchEngine.java @@ -41,7 +41,7 @@ import com.ibm.icu.text.MessageFormat; /** * Engine used to search for API use - * + * * @since 1.0.0 */ public final class ApiSearchEngine { @@ -127,7 +127,7 @@ public final class ApiSearchEngine { /** * Returns the set of resolved references for the given {@link IApiType} - * + * * @param requestor * @param type * @param monitor @@ -150,7 +150,7 @@ public final class ApiSearchEngine { /** * Runs the given list of references through the search requestor to * determine if they should be kept or not - * + * * @param requestor * @param type * @param references @@ -189,7 +189,7 @@ public final class ApiSearchEngine { /** * Searches for all accepted {@link IReference}s from the given * {@link IApiElement} - * + * * @param requestor * @param element * @param reporter search reporter to output xml results as references are @@ -251,7 +251,7 @@ public final class ApiSearchEngine { /** * Searches for all of the use of API or internal code from the given * {@link IApiComponent} within the given {@link IApiBaseline} - * + * * @param baseline the baseline to search within * @param requestor the requestor to use for the search * @param reporter the reporter to use when reporting any search results to @@ -316,7 +316,7 @@ public final class ApiSearchEngine { /** * Computes the process context (label) - * + * * @param requestor * @return the label describing the process for the progress monitor */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchReporter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchReporter.java index a2ed3dd4f9..decfb2bc95 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchReporter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IApiSearchReporter.java @@ -16,14 +16,14 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiElement; /** * Describes a reporter called out to by the {@link ApiSearchEngine} when a * pre-determined set of results have been collected. - * + * * @since 1.0.0 */ public interface IApiSearchReporter { /** * Reports the given results to the user (implementation independent) - * + * * @param element the element that was searched * @param references the raw list of references from the * {@link ApiSearchEngine} @@ -33,7 +33,7 @@ public interface IApiSearchReporter { /** * Reports the current listing of objects that were not searched for * whatever reason. - * + * * @param notsearched array of elements not searched */ public void reportNotSearched(final IApiElement[] elements); @@ -41,7 +41,7 @@ public interface IApiSearchReporter { /** * Reports the given metadata object out to the report directory. Does no * work if the metadata is <code>null</code> - * + * * @param data the data object to write out */ public void reportMetadata(IMetadata data); 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 736f1a4315..fdde47bf4d 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 @@ -18,7 +18,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiTypeContainer; /** * A default search requestor to use for API tools - * + * * @since 1.0.0 */ public interface IApiSearchRequestor { @@ -26,14 +26,14 @@ public interface IApiSearchRequestor { /** * Search mask that will cause the engine to consider API references when * searching - * + * * @see #includesApi() */ public static final int INCLUDE_API = 0x0001; /** * Search mask that will cause the engine to consider internal references * when searching - * + * * @see #includesInternal() */ public static final int INCLUDE_INTERNAL = 0x0002; @@ -45,7 +45,7 @@ public interface IApiSearchRequestor { /** * Returns the {@link IApiScope} to be searched - * + * * @return the {@link IApiScope} to be searched */ public IApiScope getScope(); @@ -54,7 +54,7 @@ public interface IApiSearchRequestor { * Returns whether this requestor cares about the given * {@link IApiComponent} or not. This allows the requestor to direct the * {@link ApiSearchEngine} to ignore certain components. - * + * * @param component the component to examine * @return true if this requestor cares about the given * {@link IApiComponent}, false otherwise. @@ -66,7 +66,7 @@ public interface IApiSearchRequestor { * {@link IApiTypeContainer} or not. This allows the requestor to direct the * {@link ApiSearchEngine} to ignore certain type containers while searching * a component - * + * * @param container * @return true if this requestor cares about the given * {@link IApiTypeContainer} false otherwise. @@ -77,7 +77,7 @@ public interface IApiSearchRequestor { * Returns whether this requestor cares about the given {@link IApiMember} * or not. This allows the requestor to direct the {@link ApiSearchEngine} * to ignore certain members. - * + * * @param member the member to examine * @return true if this requestor cares about the given {@link IApiMember}, * false otherwise @@ -87,7 +87,7 @@ public interface IApiSearchRequestor { /** * Returns whether the given {@link IReference} should be accepted by this * requestor. - * + * * @param reference * @return true if the reference should be accepted, false otherwise */ @@ -95,10 +95,10 @@ 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 - * + * * @return the listing of {@link IReference} kinds to consider during the * search this requestor is used for. */ @@ -107,7 +107,7 @@ public interface IApiSearchRequestor { /** * Returns true if the current search mask includes considering references * to API elements. - * + * * @return true if references to API elements should be considered, false * otherwise */ @@ -116,7 +116,7 @@ public interface IApiSearchRequestor { /** * Returns true if the current search mask includes considering references * to internal elements. - * + * * @return true if reference to internal elements should be considered, * false otherwise */ @@ -125,7 +125,7 @@ public interface IApiSearchRequestor { /** * Returns true if the current search mask includes considering illegal API * use. - * + * * @return true if references to illegal API use should be considered, false * otherwise */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IMetadata.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IMetadata.java index ebdcb4c05c..4a82e4df9c 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IMetadata.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/provisional/search/IMetadata.java @@ -18,14 +18,14 @@ import org.eclipse.core.runtime.CoreException; /** * Object used to hold API use scan metadata that can be written out by an * {@link IApiSearchReporter} - * + * * @since 1.0.1 */ public interface IMetadata { /** * Writes the current snapshot of metadata out to the given file - * + * * @param file the file to write to * @throws IOException * @throws CoreException diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ApiDescriptionModifier.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ApiDescriptionModifier.java index 8d3e436cf4..07c6b1e805 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ApiDescriptionModifier.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ApiDescriptionModifier.java @@ -42,7 +42,7 @@ public class ApiDescriptionModifier extends ApiDescriptionVisitor { /** * Constructs a visitor with the given patterns. - * + * * @param internal regular expressions to match as internal packages or * <code>null</code> * @param api regular expressions to match as API or <code>null</code> @@ -54,7 +54,7 @@ public class ApiDescriptionModifier extends ApiDescriptionVisitor { /** * Sets the description to be modified. - * + * * @param description API description to modify */ public void setApiDescription(IApiDescription description) { @@ -64,7 +64,7 @@ public class ApiDescriptionModifier extends ApiDescriptionVisitor { /** * Sets regular expressions to consider as internal packages. Used to * override visibility settings in an API description. - * + * * @param patterns regular expressions, may be empty or <code>null</code> */ private void setInternalPatterns(String[] patterns) { @@ -81,7 +81,7 @@ public class ApiDescriptionModifier extends ApiDescriptionVisitor { /** * Sets regular expressions to consider as API packages. Used to override * visibility settings in an API description. - * + * * @param patterns regular expressions, may be empty or <code>null</code> */ private void setApiPatterns(String[] patterns) { @@ -120,7 +120,7 @@ public class ApiDescriptionModifier extends ApiDescriptionVisitor { /** * Returns whether the package matches any of the given patterns. - * + * * @param name name to match * @param patterns patterns to match against * @return whether there's a match 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 29170ad3f5..d23c5b9467 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 @@ -42,7 +42,7 @@ import org.eclipse.pde.api.tools.internal.util.Signatures; * Generates an HTML report from an XML use scan. The generated report is * 'consumer based'. It lists the bundles that have references in them (rather * than listing bundles that produce the types being referenced) - * + * * @since 1.0.300 */ public class ConsumerReportConvertor extends UseReportConverter { @@ -83,7 +83,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Use scan visitor that produces the report data for a single consumer * bundle. The visitor collects the report data in a {@link Consumer}. - * + * */ class ConsumerReportVisitor extends UseScanVisitor { Consumer consumer; @@ -101,7 +101,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Constructor - * + * * @param consumerDescriptor the bundle that we are collecting * information on */ @@ -354,7 +354,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Returns if the reference should be reported or not - * + * * @param desc * @return true if the reference should be reported false otherwise */ @@ -372,7 +372,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Returns the enclosing {@link IReferenceTypeDescriptor} for the given * member descriptor - * + * * @param member * @return the enclosing {@link IReferenceTypeDescriptor} or * <code>null</code> @@ -394,7 +394,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Formats the arrays of messages - * + * * @param messages * @return the formatted messages or <code>null</code> */ @@ -434,7 +434,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Constructor - * + * * @param htmlroot the folder root where the HTML reports should be written * @param xmlroot the folder root where the current API use scan output is * located @@ -481,7 +481,7 @@ public class ConsumerReportConvertor extends UseReportConverter { /** * Writes the main index file for the reports - * + * * @param scanResult a list of {@link Consumer} objects returns from the use * scan parser * @param reportsRoot @@ -569,7 +569,7 @@ public class ConsumerReportConvertor extends UseReportConverter { * Writes the HTML report for a specific consumer. It lists all the * producers (bundles that provide the API) that the consumer bundle * references. - * + * * @param consumer consumer to write the report for * @param producers a map of producer name to a {@link Producer} object * @throws Exception @@ -615,7 +615,7 @@ public class ConsumerReportConvertor extends UseReportConverter { buffer.append(CLOSE_TABLE); buffer.append(BR); - buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(SearchMessages.UseReportConverter_back_to_bundle_index).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ + buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(SearchMessages.UseReportConverter_back_to_bundle_index).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ buffer.append(W3C_FOOTER); writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(originhtml), IApiCoreConstants.UTF_8)); @@ -636,7 +636,7 @@ public class ConsumerReportConvertor extends UseReportConverter { * <p> * Called from {@link #writeConsumerReport(Consumer)} * </p> - * + * * @param producer producer to write the report for * @throws Exception */ @@ -691,7 +691,7 @@ public class ConsumerReportConvertor extends UseReportConverter { buffer.append(CLOSE_TABLE); buffer.append(BR); - buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(NLS.bind(SearchMessages.ConsumerReportConvertor_BackLinkToConsumer, parentConsumer.name)).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ + buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(NLS.bind(SearchMessages.ConsumerReportConvertor_BackLinkToConsumer, parentConsumer.name)).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ buffer.append(W3C_FOOTER); writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(originhtml), IApiCoreConstants.UTF_8)); diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/HTMLConvertor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/HTMLConvertor.java index 2e30b5f65e..0ad17960f2 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/HTMLConvertor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/HTMLConvertor.java @@ -12,7 +12,7 @@ package org.eclipse.pde.api.tools.internal.search; /** * Contains strings and methods for writing HTML markup - * + * * @since 1.0.1 */ public abstract class HTMLConvertor { @@ -104,7 +104,7 @@ public abstract class HTMLConvertor { /** * Closing p tag: <code></p></code> */ - public static final String CLOSE_P = "</p>\n"; //$NON-NLS-1$ + public static final String CLOSE_P = "</p>\n"; //$NON-NLS-1$ /** * Opening ol tag: <code><ol></code> */ @@ -160,7 +160,7 @@ public abstract class HTMLConvertor { /** * Opens a new <code><td></code> with the given width attribute set - * + * * @param width * @return a new open <code><td></code> tag */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceCollection.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceCollection.java index 8fa2912f3d..ff392c6852 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceCollection.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceCollection.java @@ -18,7 +18,7 @@ public interface IReferenceCollection { /** * Adds the reference descriptor for a type to the collection - * + * * @param type type * @param referenceDescriptor reference descriptor to be added */ @@ -26,7 +26,7 @@ public interface IReferenceCollection { /** * Checks if a reference for a given type already exists in the collection - * + * * @param type * @return Returns <code>true</code> if the the collection has references * for the given type, <code>false</code> otherwise. @@ -36,7 +36,7 @@ public interface IReferenceCollection { /** * Returns the list of all the references made to this component in the API * Use Scan report - * + * * @return the list of reference descriptors */ public IReferenceDescriptor[] getAllExternalDependencies(); @@ -44,7 +44,7 @@ public interface IReferenceCollection { /** * Returns the list of all the references made to a particular member of * this component in the API Use Scan report - * + * * @param types to which references have been made * @return the list of reference descriptors */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceDescriptor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceDescriptor.java index 1ca812d015..3d96cd68a1 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceDescriptor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/IReferenceDescriptor.java @@ -21,35 +21,35 @@ import org.eclipse.pde.api.tools.internal.provisional.descriptors.IMemberDescrip public interface IReferenceDescriptor { /** * The line number from which the reference was made or -1 if unknown. - * + * * @return source line number or -1 */ public int getLineNumber(); /** * Returns the member descriptor where the reference exists. - * + * * @return member descriptor where the reference exists */ public IMemberDescriptor getMember(); /** * Returns the component descriptor where the reference exists. - * + * * @return component descriptor where the reference exists */ public IComponentDescriptor getComponent(); /** * Returns the specific kind of reference that was made. - * + * * @return reference kind - one of the reference modifiers */ public int getReferenceKind(); /** * Returns any flags set on the reference - * + * * @return any flags set on the reference */ public int getReferenceFlags(); @@ -57,28 +57,28 @@ public interface IReferenceDescriptor { /** * Returns the type of reference that has been made - one of type, field, or * method. - * + * * @return one of the reference type constants defined in this interface */ public int getReferenceType(); /** * Returns a descriptor for the referenced member. - * + * * @return referenced member descriptor */ public IMemberDescriptor getReferencedMember(); /** * A descriptor for the referenced component. - * + * * @return referenced component descriptor */ public IComponentDescriptor getReferencedComponent(); /** * Describes the visibility of the reference. - * + * * @return visibility * @see org.eclipse.pde.api.tools.internal.provisional.VisibilityModifiers */ @@ -87,7 +87,7 @@ public interface IReferenceDescriptor { /** * Returns the collection of reported problem messages for the original * {@link IReference} or <code>null</code> if there are no messages. - * + * * @return the list of problem messages or <code>null</code> * @since 1.1 */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MigrationReportConvertor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MigrationReportConvertor.java index 33578998b0..f2ec1adb5b 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MigrationReportConvertor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MigrationReportConvertor.java @@ -15,14 +15,14 @@ import org.eclipse.osgi.util.NLS; /** * Report converter specialization for migration reports - * + * * @since 1.0.1 */ public class MigrationReportConvertor extends UseReportConverter { /** * Constructor - * + * * @param htmlroot * @param xmlroot * @param topatterns diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefMetadata.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefMetadata.java index aaaf8bf5f6..3073773bc1 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefMetadata.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefMetadata.java @@ -72,7 +72,7 @@ public class MissingRefMetadata implements IMetadata { /** * Constructor - * + * * @param profile * @param runatdate * @param reportlocation @@ -89,7 +89,7 @@ public class MissingRefMetadata implements IMetadata { /** * Returns the use metadata from meta.xml - * + * * @return * @throws Exception */ @@ -167,7 +167,7 @@ public class MissingRefMetadata implements IMetadata { /** * Allows the profile to be set. This method accepts <code>null</code> - * + * * @param profile the profile to set */ public void setProfile(String profile) { @@ -176,7 +176,7 @@ public class MissingRefMetadata implements IMetadata { /** * Returns the profile set in this metadata or <code>null</code> if none. - * + * * @return the profile */ public String getProfile() { @@ -185,7 +185,7 @@ public class MissingRefMetadata implements IMetadata { /** * Allows the run-at date to be set. This method accepts <code>null</code> - * + * * @param date the date to set */ public void setRunAtDate(String date) { @@ -195,7 +195,7 @@ public class MissingRefMetadata implements IMetadata { /** * Returns the run-at date set in this metadata or <code>null</code> if * none. - * + * * @return the run-at date or <code>null</code> */ public String getRunAtDate() { @@ -205,7 +205,7 @@ public class MissingRefMetadata implements IMetadata { /** * Returns the report location set in this metadata or <code>null</code> if * none. - * + * * @return the report location or <code>null</code> */ public String getReportLocation() { @@ -215,7 +215,7 @@ public class MissingRefMetadata implements IMetadata { /** * Allows the report location to be set. This method accepts * <code>null</code>. - * + * * @param location the new report location */ public void setReportLocation(String location) { @@ -225,7 +225,7 @@ public class MissingRefMetadata implements IMetadata { /** * Returns the API Use Scans set in this metadata or <code>null</code> if * none. - * + * * @return the apiusescans */ public String getApiUseScans() { @@ -234,7 +234,7 @@ public class MissingRefMetadata implements IMetadata { /** * Allows the API Use Scan to be set. This method accepts <code>null</code> - * + * * @param apiusescans the apiusescans to set */ public void setApiUseScans(String apiusescans) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefReportConverter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefReportConverter.java index 622124cf74..9b2370a085 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefReportConverter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/MissingRefReportConverter.java @@ -50,7 +50,7 @@ public class MissingRefReportConverter extends UseReportConverter { /** * Builds the name for the component - * + * * @param id id of the component * @param version version of the component, can be <code>null</code> * @return string name @@ -130,7 +130,7 @@ public class MissingRefReportConverter extends UseReportConverter { } buffer.append(CLOSE_TABLE); - buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(SearchMessages.MissingRefReportConverter_BackToIndex).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ + buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(SearchMessages.MissingRefReportConverter_BackToIndex).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ buffer.append(W3C_FOOTER); buffer.append(CLOSE_BODY); @@ -177,7 +177,7 @@ public class MissingRefReportConverter extends UseReportConverter { Collections.sort(pbs, missingcompare); for (IApiProblem pb : pbs) { buffer.append(OPEN_TR); - buffer.append("<td align=\"left\" width=\"75%\">").append(pb.getMessage()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("<td align=\"left\" width=\"75%\">").append(pb.getMessage()).append(CLOSE_TD); //$NON-NLS-1$ buffer.append(CLOSE_TR); } } @@ -195,7 +195,7 @@ public class MissingRefReportConverter extends UseReportConverter { /** * Returns the HTML markup for the problems table header. - * + * * @param sectionname * @param type * @return the default references table header @@ -208,7 +208,7 @@ public class MissingRefReportConverter extends UseReportConverter { buffer.append("<table border=\"1\" width=\"80%\">\n"); //$NON-NLS-1$ buffer.append(OPEN_TR); - buffer.append("<td bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\">").append(OPEN_B).append(type).append("</b></td>\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ + buffer.append("<td bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\">").append(OPEN_B).append(type).append("</b></td>\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ buffer.append(CLOSE_TR); return buffer.toString(); @@ -293,7 +293,7 @@ public class MissingRefReportConverter extends UseReportConverter { /** * Constructor - * + * * @param htmlroot the folder root where the HTML reports should be written * @param xmlroot the folder root where the current API use scan output is * located @@ -341,7 +341,7 @@ public class MissingRefReportConverter extends UseReportConverter { /** * Writes the main index file for the reports - * + * * @param result a list of {@link Report} objects returns from the use scan * parser */ @@ -370,7 +370,7 @@ public class MissingRefReportConverter extends UseReportConverter { getFilteredCount(); writeFilterCount(buffer); - + buffer.append(OPEN_H4).append(SearchMessages.MissingRefReportConverter_AddlBundleInfo).append(CLOSE_H4); // if(hasMissing()) { // buffer.append(OPEN_P); @@ -422,7 +422,7 @@ public class MissingRefReportConverter extends UseReportConverter { /** * Returns the HTML markup for one entry in the problem summary table. - * + * * @param report * @param link * @return a single reference table entry @@ -433,9 +433,9 @@ public class MissingRefReportConverter extends UseReportConverter { buffer.append("<td><b><a href=\"").append(link).append("\">").append(getBundleOnlyName(report.name)).append("</a>").append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ buffer.append("\t<td align=\"left\">").append(getVersion(report.name)).append(CLOSE_TD); //$NON-NLS-1$ buffer.append("\t<td align=\"center\">").append(report.typeProblems).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(report.methodProblems).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(report.fieldProblems).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(report.getTotal()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(report.methodProblems).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(report.fieldProblems).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(report.getTotal()).append(CLOSE_TD); //$NON-NLS-1$ buffer.append(CLOSE_TR); return buffer.toString(); } @@ -476,7 +476,7 @@ public class MissingRefReportConverter extends UseReportConverter { void writeMetadataSummary(StringBuffer buffer) throws Exception { MissingRefMetadata metadata = (MissingRefMetadata) getMetadata(); buffer.append(OPEN_H4).append(SearchMessages.MissingRefReportConverter_MetadataTitle).append(CLOSE_H4); - buffer.append("<table border=\"0px\" title=\"").append(SearchMessages.MissingRefReportConverter_MetadataTableTitle).append("\"width=\"50%\">"); //$NON-NLS-1$ //$NON-NLS-2$ + buffer.append("<table border=\"0px\" title=\"").append(SearchMessages.MissingRefReportConverter_MetadataTableTitle).append("\"width=\"50%\">"); //$NON-NLS-1$ //$NON-NLS-2$ buffer.append(OPEN_TR); buffer.append(openTD(14)).append(SearchMessages.MissingRefReportConverter_ReportDate).append(CLOSE_TD); @@ -525,7 +525,7 @@ public class MissingRefReportConverter extends UseReportConverter { @Override protected void writeMetadataHeaders(StringBuffer buffer) { - buffer.append("<meta name=\"").append("description").append("\" content=\"").append(SearchMessages.MissingRefReportConverter_IndexMetaTag).append("\">"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ + buffer.append("<meta name=\"").append("description").append("\" content=\"").append(SearchMessages.MissingRefReportConverter_IndexMetaTag).append("\">"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ } /** diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ReferenceLookupVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ReferenceLookupVisitor.java index 7a9a51cdf1..93fa04a269 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ReferenceLookupVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/ReferenceLookupVisitor.java @@ -66,7 +66,7 @@ public class ReferenceLookupVisitor extends UseScanVisitor { /** * Creates a visitor to resolve references in the given baseline - * + * * @param base baseline * @param location to create XML report */ @@ -251,7 +251,7 @@ public class ReferenceLookupVisitor extends UseScanVisitor { /** * Limits the scope of bundles to consider references from, as a regular * expression. - * + * * @param regex regular expression or <code>null</code> if all */ public void setAnalysisScope(String regex) { @@ -261,7 +261,7 @@ public class ReferenceLookupVisitor extends UseScanVisitor { /** * Limits the set of bundles to consider analyzing references to, as a * regular expression. - * + * * @param regex regular expression or <code>null</code> if all. */ public void setTargetScope(String regex) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/SkippedComponent.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/SkippedComponent.java index fbef2d2123..d3546b6973 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/SkippedComponent.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/SkippedComponent.java @@ -34,7 +34,7 @@ public class SkippedComponent implements IApiElement { /** * Constructor - * + * * @param componentid * @param version * @param errors the {@link ResolverError}s, if any, that prevented this @@ -137,7 +137,7 @@ public class SkippedComponent implements IApiElement { /** * Resolves the root errors for the given set of errors - * + * * @param rerrors * @param collector * @return the resolved leaf set of problem messages diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseMetadata.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseMetadata.java index a61cac3ba5..22053a66b8 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseMetadata.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseMetadata.java @@ -26,7 +26,7 @@ import org.w3c.dom.Element; /** * Implementation of {@link IMetadata} for API use scans - * + * * @since 1.0.1 */ public class UseMetadata implements IMetadata { @@ -88,7 +88,7 @@ public class UseMetadata implements IMetadata { * XML tag name for additional filters */ public static final String ADDITIONALFILTERS = "additionalfilters"; //$NON-NLS-1$ - + int searchflags = 0; String[] apipatterns = null, intpatterns = null, archivepatterns = null; @@ -104,7 +104,7 @@ public class UseMetadata implements IMetadata { /** * Constructor - * + * * @param searchflags * @param scopepattern * @param refpattern @@ -131,7 +131,7 @@ public class UseMetadata implements IMetadata { /** * Constructor - * + * * @param searchflags * @param scopepattern * @param refpattern @@ -217,7 +217,7 @@ public class UseMetadata implements IMetadata { child = doc.createElement(ADDITIONALFILTERS); root.appendChild(child); child.setAttribute(VALUE, this.additionalfilters); - + writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), IApiCoreConstants.UTF_8)); writer.write(Util.serializeDocument(doc)); writer.flush(); @@ -254,7 +254,7 @@ public class UseMetadata implements IMetadata { /** * Allows the run-at date to be set. This method accepts <code>null</code> - * + * * @param date the date to set */ public void setRunAtDate(String date) { @@ -264,7 +264,7 @@ public class UseMetadata implements IMetadata { /** * Returns the run-at date set in this metadata or <code>null</code> if * none. - * + * * @return the run-at date or <code>null</code> */ public String getRunAtDate() { @@ -273,7 +273,7 @@ public class UseMetadata implements IMetadata { /** * Returns the human-readable description of the scan - * + * * @return the description */ public String getDescription() { @@ -283,7 +283,7 @@ public class UseMetadata implements IMetadata { /** * Allows the human-readable description to be set. This method accepts * <code>null</code> - * + * * @param description the description to set */ public void setDescription(String description) { @@ -292,7 +292,7 @@ public class UseMetadata implements IMetadata { /** * Allows the combined search flags to be set. - * + * * @param flags the search flags to set */ public void setSearchflags(int flags) { @@ -302,7 +302,7 @@ public class UseMetadata implements IMetadata { /** * Returns the collection of API patterns set in this metadata or * <code>null</code> if none. - * + * * @return the API patterns or <code>null</code> */ public String[] getApiPatterns() { @@ -311,7 +311,7 @@ public class UseMetadata implements IMetadata { /** * Allows the API patterns to be set. This method accepts <code>null</code> - * + * * @param patterns the patterns to set */ public void setApiPatterns(String[] patterns) { @@ -321,7 +321,7 @@ public class UseMetadata implements IMetadata { /** * Returns the collection of internal patterns set in this metadata or * <code>null</code> if none. - * + * * @return the internal patterns or <code>null</code> */ public String[] getInternalPatterns() { @@ -331,7 +331,7 @@ public class UseMetadata implements IMetadata { /** * Allows the internal patterns to be set. This method accepts * <code>null</code>. - * + * * @param patterns the internal patterns to set */ public void setInternalPatterns(String[] patterns) { @@ -341,7 +341,7 @@ public class UseMetadata implements IMetadata { /** * Returns the collection of archive patterns set in this metadata or * <code>null</code> if none. - * + * * @return the archive patterns or <code>null</code> */ public String[] getArchivePatterns() { @@ -351,7 +351,7 @@ public class UseMetadata implements IMetadata { /** * Allows the set of archive patterns to be set. This method accepts * <code>null</code> - * + * * @param patterns the archive patterns to set */ public void setArchivePatterns(String[] patterns) { @@ -361,7 +361,7 @@ public class UseMetadata implements IMetadata { /** * Returns the additional filter set in this metadata or * <code>null</code> if none. - * + * * @return the additional filter or <code>null</code> */ public String getAdditionalfilters() { @@ -370,7 +370,7 @@ public class UseMetadata implements IMetadata { /** * Allows additional filters to be set. This method accepts <code>null</code> - * + * * @param additional filter to set */ public void setAdditionalfilters(String additionalfilters) { @@ -380,7 +380,7 @@ public class UseMetadata implements IMetadata { /** * Returns the baseline location set in this metadata or <code>null</code> * if none. - * + * * @return the baseline location or <code>null</code> */ public String getBaselineLocation() { @@ -390,7 +390,7 @@ public class UseMetadata implements IMetadata { /** * Allows the baseline location to be set. This method accepts * <code>null</code>. - * + * * @param location the new location */ public void setBaselineLocation(String location) { @@ -400,7 +400,7 @@ public class UseMetadata implements IMetadata { /** * Returns the report location set in this metadata or <code>null</code> if * none. - * + * * @return the report location or <code>null</code> */ public String getReportLocation() { @@ -410,7 +410,7 @@ public class UseMetadata implements IMetadata { /** * Allows the report location to be set. This method accepts * <code>null</code>. - * + * * @param location the new report location */ public void setReportLocation(String location) { @@ -420,7 +420,7 @@ public class UseMetadata implements IMetadata { /** * Allows the reference pattern to be set. This method accepts * <code>null</code> - * + * * @param pattern the new pattern */ public void setReferencePattern(String pattern) { @@ -430,7 +430,7 @@ public class UseMetadata implements IMetadata { /** * Returns the reference pattern set in this metadata or <code>null</code> * if none. - * + * * @return the reference pattern or <code>null</code> */ public String getReferencePattern() { @@ -439,7 +439,7 @@ public class UseMetadata implements IMetadata { /** * Allows the scope pattern to be set. This method accepts <code>null</code> - * + * * @param pattern the new pattern */ public void setScopePattern(String pattern) { @@ -449,7 +449,7 @@ public class UseMetadata implements IMetadata { /** * Returns the scope pattern set in this metadata or <code>null</code> if * none. - * + * * @return the scope pattern or <code>null</code> */ public String getScopePattern() { 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 8acb20592a..11d57faf48 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 @@ -76,7 +76,7 @@ import org.xml.sax.helpers.DefaultHandler; /** * This class converts a collection of API use report XML files from a given * location to a corresponding collection of HTML in a given location - * + * * @since 1.0.1 */ public class UseReportConverter extends HTMLConvertor { @@ -95,7 +95,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns if the reference should be reported or not - * + * * @param desc * @return true if the reference should be reported false otherwise */ @@ -113,7 +113,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the enclosing {@link IReferenceTypeDescriptor} for the given * member descriptor - * + * * @param member * @return the enclosing {@link IReferenceTypeDescriptor} or * <code>null</code> @@ -222,7 +222,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Formats the arrays of messages - * + * * @param messages * @return the formatted messages or <code>null</code> */ @@ -545,7 +545,7 @@ public class UseReportConverter extends HTMLConvertor { * 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. - * + * * @since 1.0.1 */ public static final int FRAGMENT_PERMISSIBLE = 0x0000005; @@ -563,13 +563,13 @@ public class UseReportConverter extends HTMLConvertor { public static final String INTERNAL_REFS_COLOUR = "#F2C3C3"; //$NON-NLS-1$ /** * Colour gray for illegal references - * + * * @since 1.1 */ public static final String ILLEGAL_REFS_COLOUR = "#E0E0E0"; //$NON-NLS-1$ /** * Colour gold for the references table header. Old colour: #CC9933 - * + * * @since 1.1 */ public static final String REFERENCES_TABLE_HEADER_COLOUR = "#E0C040"; //$NON-NLS-1$ @@ -615,7 +615,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Constructor - * + * * @param htmlroot the folder root where the HTML reports should be written * @param xmlroot the folder root where the current API use scan output is * located @@ -765,7 +765,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the handle to the default parser, caches the handle once it has * been created - * + * * @return the handle to the default parser * @throws Exception forwarded general exception that can be trapped in Ant * builds @@ -789,7 +789,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Builds the name for the component - * + * * @param id id of the component * @param version version of the component, can be <code>null</code> * @return string name @@ -818,7 +818,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Applies the given XSLT to the given XML to produce HTML in the given file - * + * * @param xsltfile * @param xmlfile * @param htmloutput @@ -843,7 +843,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Applies the given XSLT source to the given XML file outputting to the * given HTML file - * + * * @param xslt * @param xmlfile * @param htmlfile @@ -860,7 +860,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Transforms the given set of xml files with the given XSLT and places the * result into a corresponding HTML file - * + * * @param xmlfiles * @param xsltFile * @param html @@ -884,7 +884,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Gets the HTML path to write out the transformed XML file to - * + * * @param reportroot * @param xmlfile * @return @@ -907,7 +907,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the name to use for the corresponding HTML file from the given * XML file - * + * * @param xmlFile * @return the HTML name to use */ @@ -922,7 +922,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the collection of missing bundle names - * + * * @param missingfile * @return the collection of missing bundle names * @throws Exception @@ -951,7 +951,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the sentence describing the purpose / reason of the missing * bundles - * + * * @return a blurb describing the table of missing bundles */ protected String getMissingBundlesHeader() { @@ -961,7 +961,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes any existing metadata out to a meta.html file in the root of the * HTML report location - * + * * @param htmlroot * @throws Exception */ @@ -1004,7 +1004,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes out a summary of the missing required bundles - * + * * @param htmlroot * @return <code>true</code> if there was at least one missing bundle */ @@ -1045,13 +1045,13 @@ public class UseReportConverter extends HTMLConvertor { } else { buffer.append(OPEN_P).append(getMissingBundlesHeader()).append(CLOSE_P); buffer.append("<table border=\"1\" width=\"50%\">\n"); //$NON-NLS-1$ - buffer.append(OPEN_TR).append("<td bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\" width=\"36%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_required_bundles).append(CLOSE_B).append(CLOSE_TD).append(CLOSE_TR); //$NON-NLS-1$ //$NON-NLS-2$ + buffer.append(OPEN_TR).append("<td bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\" width=\"36%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_required_bundles).append(CLOSE_B).append(CLOSE_TD).append(CLOSE_TR); //$NON-NLS-1$ //$NON-NLS-2$ } for (String value : sorted) { buffer.append(OPEN_TR).append(OPEN_TD).append(value).append(CLOSE_TD).append(CLOSE_TR); } buffer.append(CLOSE_TABLE); - buffer.append(BR).append("<a href=\"not_searched.html\">").append(SearchMessages.UseReportConverter_back_to_not_searched).append(CLOSE_A); //$NON-NLS-1$ + buffer.append(BR).append("<a href=\"not_searched.html\">").append(SearchMessages.UseReportConverter_back_to_not_searched).append(CLOSE_A); //$NON-NLS-1$ buffer.append(W3C_FOOTER); // write file @@ -1071,7 +1071,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes out the file of components that were not searched: either because * they appeared in an exclude list or they have no .api_description file - * + * * @param htmlroot */ void writeNotSearchedPage(final File htmlroot) throws Exception { @@ -1099,7 +1099,7 @@ public class UseReportConverter extends HTMLConvertor { if (xml.exists()) { try { applyXSLT(xslt, xml, originhtml); - } catch (TransformerException e) { + } catch (TransformerException e) { useNotSearchedXml = true; ApiPlugin.logErrorMessage(SearchMessages.UseReportConverter_te_applying_xslt_skipped); } @@ -1120,7 +1120,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns path of XSL file to use when generating "not searched" * information. - * + * * @return path to the XSL file */ String getNotSearchedXSLPath() { @@ -1129,7 +1129,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes the referenced member index page - * + * * @param report * @param referees the listing of referencing bundles */ @@ -1203,7 +1203,7 @@ public class UseReportConverter extends HTMLConvertor { buffer.append(CLOSE_TR); } buffer.append(CLOSE_TABLE); - buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(SearchMessages.UseReportConverter_back_to_bundle_index).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ + buffer.append(OPEN_P).append("<a href=\"../index.html\">").append(SearchMessages.UseReportConverter_back_to_bundle_index).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ buffer.append(W3C_FOOTER); writer = new PrintWriter(new OutputStreamWriter(new FileOutputStream(originhtml), IApiCoreConstants.UTF_8)); @@ -1220,7 +1220,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the colour to use based on certain counts - * + * * @param counts * @return the colour to use * @since 1.1 @@ -1238,7 +1238,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns a string of additional information to print out at the top of the * referenced types page. - * + * * @return additional referenced type information. */ protected String getAdditionalReferencedTypeInformation() { @@ -1247,7 +1247,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the page title to use for the referenced types page - * + * * @param bundle * @return the page title for the referenced types page */ @@ -1257,7 +1257,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes the page that displays all of the members used in a type - * + * * @param map * @param type * @param typefile @@ -1282,7 +1282,7 @@ public class UseReportConverter extends HTMLConvertor { buffer.append("<div align=\"left\" class=\"main\">"); //$NON-NLS-1$ buffer.append("<table border=\"1\" width=\"80%\">\n"); //$NON-NLS-1$ buffer.append(OPEN_TR); - buffer.append("<td bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\">").append(OPEN_B).append(SearchMessages.UseReportConverter_member).append("</b></td>\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ + buffer.append("<td bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\">").append(OPEN_B).append(SearchMessages.UseReportConverter_member).append("</b></td>\n"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ buffer.append(CLOSE_TR); IElementDescriptor desc = null; for (Entry<IMemberDescriptor, Member> entry : map.entrySet()) { @@ -1301,7 +1301,7 @@ public class UseReportConverter extends HTMLConvertor { } buffer.append(CLOSE_TABLE); buffer.append(CLOSE_DIV); - buffer.append(OPEN_P).append("<a href=\"index.html\">").append(SearchMessages.UseReportConverter_back_to_bundle_index).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ + buffer.append(OPEN_P).append("<a href=\"index.html\">").append(SearchMessages.UseReportConverter_back_to_bundle_index).append(CLOSE_A).append(CLOSE_P); //$NON-NLS-1$ buffer.append(W3C_FOOTER); // write the file @@ -1320,7 +1320,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the header to use for the section that describes the type details * table - * + * * @return the details header */ protected String getTypeDetailsHeader() { @@ -1329,7 +1329,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the blurb that follows the type details header - * + * * @return the details information * @see #getTypeDetailsHeader() */ @@ -1339,7 +1339,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the title to use for the type references page - * + * * @param typename * @return the type references page title */ @@ -1349,7 +1349,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the nested table of references - * + * * @return the nested table of references as a string */ String getReferencesTable(Member member) { @@ -1362,8 +1362,8 @@ public class UseReportConverter extends HTMLConvertor { buffer.append("<td colspan=\"3\" bgcolor=\"#CCCCCC\">").append(OPEN_B).append(entry.getKey()).append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ buffer.append(CLOSE_TR); buffer.append("<tr bgcolor=\"").append(REFERENCES_TABLE_HEADER_COLOUR).append("\">"); //$NON-NLS-1$ //$NON-NLS-2$ - buffer.append("<td align=\"left\" width=\"84%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_reference_location).append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("<td align=\"center\" width=\"8%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_line_number).append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("<td align=\"left\" width=\"84%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_reference_location).append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("<td align=\"center\" width=\"8%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_line_number).append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ buffer.append("<td align=\"center\" width=\"8%\">").append(OPEN_B).append(SearchMessages.UseReportConverter_reference_kind).append(CLOSE_B).append(CLOSE_TD); //$NON-NLS-1$ buffer.append(CLOSE_TR); refs = entry.getValue(); @@ -1393,7 +1393,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the name to display for the given {@link IElementDescriptor} * which can be qualified or not - * + * * @param desc * @param qualifiedparams * @param qualified @@ -1436,7 +1436,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Extracts underlying link text from the given absolute filename based off * the root file - * + * * @param root * @param fileName * @return link text pruned via the given root file @@ -1454,7 +1454,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the page title for the index page - * + * * @return the index page title */ protected String getIndexTitle() { @@ -1463,7 +1463,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes the main index file for the reports - * + * * @param scanResult a list of {@link Report} objects returns from the use * scan parser * @param reportsRoot @@ -1554,7 +1554,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns a table describing what all of the colours mean in the reports - * + * * @return a colour legend table * @since 1.1 */ @@ -1587,7 +1587,7 @@ public class UseReportConverter extends HTMLConvertor { /** * This method is called during the HTML header creation phase to allow META * header elements to be written for metadata objects - * + * * @param buffer * @throws Exception */ @@ -1599,14 +1599,14 @@ public class UseReportConverter extends HTMLConvertor { /** * This method is called during the initial index page creation to allow and * executive summary of the use scan to be written out from metadata - * + * * @param buffer * @throws Exception */ void writeMetadataSummary(StringBuffer buffer) throws Exception { buffer.append(OPEN_H4).append(SearchMessages.UseReportConverter_scan_details).append(CLOSE_H4); if (this.metadata != null) { - buffer.append("<table border=\"0px\" title=\"").append(SearchMessages.UseReportConverter_scan_details).append("\"width=\"50%\">"); //$NON-NLS-1$ //$NON-NLS-2$ + buffer.append("<table border=\"0px\" title=\"").append(SearchMessages.UseReportConverter_scan_details).append("\"width=\"50%\">"); //$NON-NLS-1$ //$NON-NLS-2$ buffer.append(OPEN_TR); buffer.append(openTD(14)).append(SearchMessages.UseReportConverter_scan_date).append(CLOSE_TD); buffer.append(openTD(36)).append(this.metadata.getRunAtDate()).append(CLOSE_TD); @@ -1714,11 +1714,11 @@ public class UseReportConverter extends HTMLConvertor { } else { buffer.append(SearchMessages.UseReportConverter_none); } - + buffer.append(CLOSE_TD); buffer.append(CLOSE_TR); - + buffer.append(CLOSE_TD); buffer.append(CLOSE_TR); buffer.append(CLOSE_TABLE); @@ -1727,7 +1727,7 @@ public class UseReportConverter extends HTMLConvertor { } } - + void writeFilterCount(StringBuffer buffer) throws Exception { boolean isAdditionFilterProvided = this.metadata.getAdditionalfilters() != null && !this.metadata.getAdditionalfilters().isEmpty(); @@ -1742,7 +1742,7 @@ public class UseReportConverter extends HTMLConvertor { } /** * Returns the use metadata from this scan - * + * * @return * @throws Exception */ @@ -1827,7 +1827,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the use filtered count from this scan - * + * * @return * @throws Exception */ @@ -1865,7 +1865,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Reads saved patterns from the meta.xml file - * + * * @param element * @return the array of patterns or <code>null</code> */ @@ -1884,7 +1884,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Writes out a META tag of the kind <code>description</code> - * + * * @param buffer * @param description */ @@ -1897,7 +1897,7 @@ public class UseReportConverter extends HTMLConvertor { * the first column contains the linked item and the following five columns * are API, Internal, Permissible, Fragment-Permissible and Other reference * counts respectively - * + * * @param columnname * @param includeversion * @return the default references table header @@ -1942,7 +1942,7 @@ public class UseReportConverter extends HTMLConvertor { * Where the first column contains the linked item and the following five * columns are Version, API, Internal, Permissible, Fragment-Permissible * reference counts respectively - * + * * @param counts * @param link * @param linktext @@ -1956,11 +1956,11 @@ public class UseReportConverter extends HTMLConvertor { if (includeversion) { buffer.append("\t<td align=\"left\">").append(getVersion(linktext)).append(CLOSE_TD); //$NON-NLS-1$ } - buffer.append("\t<td align=\"center\">").append(counts.getTotalApiRefCount()).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(counts.getTotalInternalRefCount()).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(counts.getTotalPermissableRefCount()).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(counts.getTotalFragmentPermissibleRefCount()).append(CLOSE_TD); //$NON-NLS-1$ - buffer.append("\t<td align=\"center\">").append(counts.getTotalIllegalRefCount()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(counts.getTotalApiRefCount()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(counts.getTotalInternalRefCount()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(counts.getTotalPermissableRefCount()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(counts.getTotalFragmentPermissibleRefCount()).append(CLOSE_TD); //$NON-NLS-1$ + buffer.append("\t<td align=\"center\">").append(counts.getTotalIllegalRefCount()).append(CLOSE_TD); //$NON-NLS-1$ buffer.append(CLOSE_TR); return buffer.toString(); } @@ -1975,7 +1975,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns the version string from the text (if any) - * + * * @param text * @return * @since 1.1 @@ -1998,9 +1998,9 @@ public class UseReportConverter extends HTMLConvertor { /** * Allows additional infos to be added to the HTML at the top of the report * page - * + * * @param hasreports - * + * * @return additional information string to add */ protected String getAdditionalIndexInfo(boolean hasreports) { @@ -2009,7 +2009,7 @@ public class UseReportConverter extends HTMLConvertor { /** * Returns HTML summary for references from a specific component. - * + * * @param typename * @param counts * @return HTML as a string diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanManager.java index 81cf6027cd..18f9731a0e 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanManager.java @@ -103,7 +103,7 @@ public class UseScanManager { /** * Returns a handle to the singleton instance - * + * * @return the singleton {@link UseScanManager} */ public synchronized static UseScanManager getInstance() { @@ -118,7 +118,7 @@ public class UseScanManager { * Returns the references for a given <code>IApiComponent</code>. If it can * not find them in cache, they will be fetched from the API Use Scans and * stored. - * + * * @param apiComponent component whose references have to be fetched * @param refTypes reference types for which the references has to be * computed in the given <code>IApiComponent</code>. If @@ -163,7 +163,7 @@ public class UseScanManager { /** * fetches the references from the API Use Scan locations - * + * * @param apiComponent * @param member * @param references @@ -246,7 +246,7 @@ public class UseScanManager { /** * Returns the scan - * + * * @param location * @return */ @@ -273,7 +273,7 @@ public class UseScanManager { * <li>the previous child directory has its own child directory that matches * the name pattern <code>^.* (.*)$</code></li> * </ul> - * + * * @param file * @return <code>true</code> is the sub folders match the patterns, * <code>false</code> otherwise @@ -308,7 +308,7 @@ public class UseScanManager { * <li>the previous child directory has its own child directory that matches * the name pattern <code>{@link #NAME_REGEX}</code></li> * </ul> - * + * * @param file * @return <code>true</code> is the sub folders match the patterns, * <code>false</code> otherwise @@ -348,7 +348,7 @@ public class UseScanManager { /** * Returns if the scan if a valid API use scan - * + * * @param location * @return true if the scan is valid false otherwise */ @@ -363,7 +363,7 @@ public class UseScanManager { /** * Returns the report locations from the preferences - * + * * @return */ public String[] getReportLocations() { @@ -388,7 +388,7 @@ public class UseScanManager { * Sets the report locations to be used. Once set, these locations will be * used instead of ones in the preference. When set to <code>null</code>, * the locations in preference will be used. - * + * * @param locations */ public void setReportLocations(String[] locations) { @@ -397,7 +397,7 @@ public class UseScanManager { /** * Sets the cache size - * + * * @param size The total number of references that can be held in memory */ public void setCacheSize(int size) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanParser.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanParser.java index d8be1d19aa..0632c273ed 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanParser.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanParser.java @@ -65,7 +65,7 @@ public class UseScanParser { /** * Constructor - * + * * @param type one of IReference.T_TYPE_REFERENCE, * IReference.T_METHOD_REFERENCE, * IReference.T_FIELD_REFERENCE @@ -100,7 +100,7 @@ public class UseScanParser { /** * Process the XML element described by the URI, local name, name and * attributes - * + * * @param uri the URI of the XML element * @param localName the local name of the XML element * @param name the name of the XML element @@ -204,7 +204,7 @@ public class UseScanParser { /** * Parses the problem messages from the attributes - * + * * @param attribs * @return the messages or an empty array never <code>null</code> * @since 1.1 @@ -221,7 +221,7 @@ public class UseScanParser { /** * Resolves references from an API use scan rooted at the specified location * in the file system in the given baseline. - * + * * @param xmlLocation root of API use scan (XML directory). * @param monitor progress monitor * @param baseline API baseline to resolve references in @@ -314,7 +314,7 @@ public class UseScanParser { /** * Returns a parser - * + * * @return default parser * @throws Exception forwarded general exception that can be trapped in Ant * builds @@ -367,7 +367,7 @@ public class UseScanParser { /** * Returns all the child directories from the given directory - * + * * @param file * @return */ @@ -378,7 +378,7 @@ public class UseScanParser { /** * Returns the {@link IReference} type from the file name - * + * * @param xmlfile * @return the type from the file name */ @@ -486,7 +486,7 @@ public class UseScanParser { /** * Sorts the given files by name (not path). - * + * * @param files * @return sorted files */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanReferenceVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanReferenceVisitor.java index c51d573075..77af655029 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanReferenceVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanReferenceVisitor.java @@ -21,7 +21,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiComponent; /** * This class is used by <code>{@link UseScanParser}</code> to visit the API Use * Scan reports - * + * */ public class UseScanReferenceVisitor extends UseScanVisitor { private IApiComponent fLookupAPIComponent; diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanVisitor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanVisitor.java index d4f7dd84e7..aced5a6946 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanVisitor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseScanVisitor.java @@ -37,7 +37,7 @@ public abstract class UseScanVisitor { * <p> * Components in a scan are visited in alphabetical order. * </p> - * + * * @param target API component to which references exist * @return whether to visit components that reference this component */ @@ -47,7 +47,7 @@ public abstract class UseScanVisitor { /** * End visiting a component that was referenced by others - * + * * @param target the component that was visited */ public void endVisitComponent(IComponentDescriptor target) { @@ -60,7 +60,7 @@ public abstract class UseScanVisitor { * Referencing components in a scan are visited in alphabetical order within * the current target component. * </p> - * + * * @param component the component that references the current target * component * @return whether to visit reference members within the component @@ -72,7 +72,7 @@ public abstract class UseScanVisitor { /** * Ends visiting a component that made references to the current target * component. - * + * * @param component that component that was visited */ public void endVisitReferencingComponent(IComponentDescriptor component) { @@ -81,7 +81,7 @@ public abstract class UseScanVisitor { /** * Visits a referenced member and returns whether to visit reference * locations - * + * * @param referencedMember the member that was referenced * @return whether to visit individual reference locations */ @@ -91,7 +91,7 @@ public abstract class UseScanVisitor { /** * End visits a referenced member - * + * * @param referencedMember the member that was referenced */ public void endVisitMember(IMemberDescriptor referencedMember) { @@ -100,7 +100,7 @@ public abstract class UseScanVisitor { /** * Visits a reference to the current member. - * + * * @param reference the reference */ public void visitReference(IReferenceDescriptor reference) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseSearchRequestor.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseSearchRequestor.java index 648f73802e..a37ab3ce23 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseSearchRequestor.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/UseSearchRequestor.java @@ -40,14 +40,14 @@ import org.eclipse.pde.api.tools.internal.provisional.search.IApiSearchRequestor * {@link ApiSearchEngine}. This requestor returns a search scope composed of * the dependent (visible) {@link IApiComponent}s for the given * {@link IApiElement} - * + * * <p> * The references are filtered based on api filter stores. The filters may come * from a .api_filters found in the component or a separate filter location set * in the ant task via {@link #setFilterRoot(String)}. If filter files are found * in both locations, the filters at both will be applied. * </p> - * + * * @since 1.0.0 */ public class UseSearchRequestor implements IApiSearchRequestor { @@ -74,14 +74,14 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * The root directory of the .api_filters files that should be used to * filter references. - * + * * The .api_filters files specify specific problems to ignore during api * analysis. During the use scan, the problem filters will be used to filter * the use scan results. - * + * * The root is specified using an absolute path. The root needs to contain * the following structure: - * + * * <pre> * root * | @@ -109,14 +109,14 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * The default {@link ReferenceAnalyzer} for detecting illegal API use - * + * * @see #includesIllegalUse() */ ReferenceAnalyzer fAnalyzer = null; /** * Constructor - * + * * @param elements an array of {@link IApiElement}s for the search engine to * use * @param scope the raw list of {@link IApiElement}s to extract references @@ -175,7 +175,7 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * Returns if the given {@link IApiTypeContainer} should be processed - * + * * @param container * @return true if the container should be processed false otherwise */ @@ -230,7 +230,7 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * Returns true if the given reference is an illegal usage reference iff * illegal use is part of the search mask. - * + * * @param reference * @return true if the reference is illegal use false otherwise * @since 1.1 @@ -259,7 +259,7 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * Returns if the given problem is filtered - * + * * @param problem * @return <code>true</code> is filtered, false otherwise */ @@ -275,7 +275,7 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * Prepares the search scope based on the available entries in the * constructor - * + * * @param elements */ private void prepareScope(IApiElement[] elements) { @@ -309,7 +309,7 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * The patterns for jar names to exclude from the search - * + * * @param patterns */ public void setJarPatterns(String[] patterns) { @@ -319,16 +319,16 @@ public class UseSearchRequestor implements IApiSearchRequestor { /** * Sets the root directory of the .api_filters files that should be used to * filter references. - * + * * The .api_filters files specify specific problems to ignore during api * analysis. During the use scan, the problem filters will be used to filter * the use scan results. If .api_filter files are found inside the component * those filters will be applied in addition to any found at this filter * root. - * + * * The root is specified using an absolute path. The root needs to contain * the following structure: - * + * * <pre> * root * | @@ -336,7 +336,7 @@ public class UseSearchRequestor implements IApiSearchRequestor { * | * +--- .api_filters * </pre> - * + * * @param filterRoot the absolute string path to the root of the filters */ public void setFilterRoot(String filterRoot) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlReferenceDescriptorWriter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlReferenceDescriptorWriter.java index f248b65d94..e6ba04bdaa 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlReferenceDescriptorWriter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlReferenceDescriptorWriter.java @@ -51,7 +51,7 @@ import org.xml.sax.helpers.DefaultHandler; /** * Writes reference descriptions to XML files. - * + * * @since 1.0.1 */ public class XmlReferenceDescriptorWriter { @@ -75,7 +75,7 @@ public class XmlReferenceDescriptorWriter { /** * Constructor - * + * * @param location the absolute path in the local file system to the folder * to write the reports to * @param debug if debugging infos should be written out to the console @@ -94,7 +94,7 @@ public class XmlReferenceDescriptorWriter { /** * Writes the given references to XML files. - * + * * @param references */ public void writeReferences(IReferenceDescriptor[] references) { @@ -122,7 +122,7 @@ public class XmlReferenceDescriptorWriter { * the same reference, referencer, type, visibility, and member, one will be * removed (even if the line numbers differ). Updates {@link #fReferenceMap} * with a map based tree structure as follows: - * + * * <pre> * Returned Map (Referenced Component ID -> rmap) * rmap (Referencing Component ID -> mmap) @@ -130,7 +130,7 @@ public class XmlReferenceDescriptorWriter { * vmap (Reference Type -> tmap) * tmap (Referenced Member -> Reference Descriptor) * </pre> - * + * * @param references */ private void collateResults(IReferenceDescriptor[] references) throws CoreException { @@ -191,7 +191,7 @@ public class XmlReferenceDescriptorWriter { /** * Resolves the id to use for the component in the mapping - * + * * @param component * @return the id to use for the component in the mapping, includes the * version information as well @@ -206,7 +206,7 @@ public class XmlReferenceDescriptorWriter { /** * Returns a formatted version of the references xml file name for use * during conversion via the default XSLT file - * + * * @param groupname * @return a formatted version of the references file name */ @@ -225,7 +225,7 @@ public class XmlReferenceDescriptorWriter { /** * Returns the name for the file of references base on the given type - * + * * @param type * @return */ @@ -246,7 +246,7 @@ public class XmlReferenceDescriptorWriter { /** * Writes out the XML for the given api element using the collated * {@link IReference}s - * + * * @param parent * @throws CoreException * @throws FileNotFoundException @@ -303,7 +303,7 @@ public class XmlReferenceDescriptorWriter { /** * Writes out a group of references under the newly created element with the * given name - * + * * @param origin the name of the bundle that has the references in it * @param referee the name of the bundle that is referenced * @param parent @@ -398,7 +398,7 @@ public class XmlReferenceDescriptorWriter { /** * Add member descriptor details to the given element. - * + * * @param element XML element * @param member member to add details for */ @@ -425,7 +425,7 @@ public class XmlReferenceDescriptorWriter { /** * gets the root kind element - * + * * @param root * @param kind * @return @@ -447,7 +447,7 @@ public class XmlReferenceDescriptorWriter { /** * gets the root kind element - * + * * @param root * @param kind * @return @@ -467,7 +467,7 @@ public class XmlReferenceDescriptorWriter { /** * Writes the attributes from the given {@link IReference} into a new * {@link Element} that is added to the given parent. - * + * * @param document * @param parent * @param reference @@ -502,7 +502,7 @@ public class XmlReferenceDescriptorWriter { /** * Gets the {@link String} value of the given array by calling * {@link #toString()} on each of the elements in the array. - * + * * @param array the array to convert to a string * @return the {@link String} or an empty {@link String} never * <code>null</code> @@ -521,7 +521,7 @@ public class XmlReferenceDescriptorWriter { /** * Returns the text to set in the attribute for the given {@link IApiMember} - * + * * @param member * @return * @throws CoreException @@ -543,7 +543,7 @@ public class XmlReferenceDescriptorWriter { /** * Sets the alternate component where references were unresolved, or * <code>null</code> if none. - * + * * @param other component descriptor or <code>null</code> */ public void setAlternate(IComponentDescriptor other) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlSearchReporter.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlSearchReporter.java index 951648d5a9..ef2ad4186f 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlSearchReporter.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/search/XmlSearchReporter.java @@ -44,7 +44,7 @@ import org.xml.sax.helpers.DefaultHandler; /** * Search reporter that outputs results to an XML file - * + * * @since 1.0.1 */ public class XmlSearchReporter implements IApiSearchReporter { @@ -58,7 +58,7 @@ public class XmlSearchReporter implements IApiSearchReporter { /** * Constructor - * + * * @param location the absolute path in the local file system to the folder * to write the reports to * @param debug if debugging infos should be written out to the console @@ -119,7 +119,7 @@ public class XmlSearchReporter implements IApiSearchReporter { /** * Resolves the id to use for the component in the mapping - * + * * @param component * @return the id to use for the component in the mapping, includes the * version information as well diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FileManager.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FileManager.java index 6f42d72157..be32368fd3 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FileManager.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FileManager.java @@ -16,7 +16,7 @@ import java.util.HashSet; /** * Manager to handle temporary files that have been created. Used as a fall-back * to ensure we clean up after ourselves - * + * * @since 1.0.1 */ public final class FileManager { @@ -36,7 +36,7 @@ public final class FileManager { /** * Returns the singleton instance of the manager - * + * * @return the manager instance */ public synchronized static FileManager getManager() { @@ -49,7 +49,7 @@ public final class FileManager { /** * Records a file root path to be deleted on the next call to * {@link #deleteFiles()}. - * + * * @param absolutepath the absolute path in the local file system of the * file to delete */ @@ -67,7 +67,7 @@ public final class FileManager { /** * Deletes all of the recorded file roots from the local filesystem (if * still existing) and returns the success of the entire delete operation. - * + * * @return true if all recorded files were deleted, false otherwise */ public boolean deleteFiles() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FilteredElements.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FilteredElements.java index 6b97467b31..625f236d1a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FilteredElements.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/FilteredElements.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Signatures.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Signatures.java index 807e82f5c9..b2d028d231 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Signatures.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/Signatures.java @@ -42,7 +42,7 @@ import org.eclipse.pde.api.tools.internal.provisional.model.IApiType; /** * This class contains utility methods for creating and working with Java * element signatures. - * + * * @since 1.0.0 * @noinstantiate This class is not intended to be instantiated by clients. */ @@ -58,7 +58,7 @@ public final class Signatures { * Collects which signature to use and de-qualifies it. If there is a * generic signature it is returned, otherwise the standard signature is * used - * + * * @param method * @return the de-qualified signature for the method */ @@ -77,7 +77,7 @@ public final class Signatures { * For example:<br> * <code>a.b.c.Type$Member -> a.b.c.Type</code><br> * <code>x.y.z.Type -> x.y.z.Type</code><br> - * + * * @param typename the type name to process * @return the primary type name stripped off of the given type name */ @@ -93,7 +93,7 @@ public final class Signatures { * Returns the signature to use to display this {@link IApiMethod}. This * method will load the enclosing type in the event the method is a * constructor. - * + * * @param method * @return the display signature to use for this {@link IApiMethod} * @throws CoreException if a lookup to the parent type of the method fails @@ -109,7 +109,7 @@ public final class Signatures { /** * Returns the signature of the method qualified with the given type - * + * * @param type * @param method * @return the given type qualified signature of the given method @@ -133,7 +133,7 @@ public final class Signatures { /** * Returns the signature of the method qualified with the given type - * + * * @param method * @return the given type qualified signature of the given method * @throws CoreException if a lookup to the parent type of the given method @@ -157,7 +157,7 @@ public final class Signatures { * the format of a content assist proposal.<br> * <br> * For example: <code>x.y.z.Clazz.mymethod() : Object</code> - * + * * @param method the descriptor to get a formatted signature for * @param qualifiedparams * @param includereturn if the return type should be returned @@ -183,7 +183,7 @@ public final class Signatures { /** * Returns the de-qualified method signature - * + * * @param method * @param includereturn * @return the de-qualified method signature @@ -205,7 +205,7 @@ public final class Signatures { /** * Returns the name to use for the method. If the method is a constructor, * the enclosing type is loaded to get its simple name - * + * * @param method * @return the name for the method. If the method is a constructor the * simple name of the enclosing type is substituted. @@ -225,7 +225,7 @@ public final class Signatures { /** * Returns the name to use for the method. If the method is a constructor, * the enclosing type is loaded to get its simple name - * + * * @param method * @return the name for the method. If the method is a constructor the * simple name of the enclosing type is substituted. @@ -244,7 +244,7 @@ public final class Signatures { /** * Returns the unqualified signature of the given {@link IApiField} - * + * * @param field * @return the unqualified signature of the given {@link IApiField} */ @@ -254,7 +254,7 @@ public final class Signatures { /** * Returns the type-qualified field signature - * + * * @param field * @return the type-qualified field signature */ @@ -270,7 +270,7 @@ public final class Signatures { /** * Returns the type-qualified field signature - * + * * @param field * @return the type-qualified field signature * @throws Core @@ -288,7 +288,7 @@ public final class Signatures { /** * Returns the type signature to use for displaying the given * {@link IApiType} - * + * * @param type * @return the display signature to use for the given {@link IApiType} */ @@ -299,7 +299,7 @@ public final class Signatures { /** * Returns the type signature to use for displaying the given * {@link IReferenceTypeDescriptor} - * + * * @param type * @return the display signature to use for the given * {@link IReferenceTypeDescriptor} @@ -310,7 +310,7 @@ public final class Signatures { /** * Returns the de-qualified signature for the given {@link IApiType} - * + * * @param type the type to get the signature for * @return the de-qualified signature for the given {@link IApiType} */ @@ -321,7 +321,7 @@ public final class Signatures { /** * Returns the display-able representation of the given signature and * generic signature - * + * * @param signature * @param genericsignature * @param qualified @@ -343,14 +343,14 @@ public final class Signatures { /** * Returns the name of an anonymous or local type with all qualification * removed. For example: - * + * * <pre> * <code> * Class$3inner --> inner * Class$3 --> null * </code> * </pre> - * + * * @param name the name to resolve * @return the name of an anonymous or local type with qualification removed * or <code>null</code> if the anonymous type has no name @@ -378,7 +378,7 @@ public final class Signatures { /** * Appends the given listing of type parameter names to the signature * contained in the given buffer - * + * * @param buffer * @param parameters */ @@ -402,7 +402,7 @@ public final class Signatures { /** * Returns a comma and space used for displaying comma-separated lists in * signatures. - * + * * @return the string rendering for a comma and following space */ public static String getComma() { @@ -411,7 +411,7 @@ public final class Signatures { /** * Returns the string for rendering the '<code><</code>' character. - * + * * @return the string for rendering '<code><</code>' */ public static String getLT() { @@ -420,7 +420,7 @@ public final class Signatures { /** * Returns the string for rendering the '<code>></code>' character. - * + * * @return the string for rendering '<code>></code>' */ public static String getGT() { @@ -430,7 +430,7 @@ public final class Signatures { /** * Convert fully qualified signature to unqualified one. The descriptor can * be dot or slashed based. - * + * * @param descriptor the given descriptor to convert * @return the converted signature */ @@ -482,7 +482,7 @@ public final class Signatures { /** * Creates a method signature from a specified {@link MethodDeclaration} - * + * * @param node * @return the signature for the given method node or <code>null</code> */ @@ -511,7 +511,7 @@ public final class Signatures { * Returns the listing of the signatures of the parameters passed in, where * the list elements are all {@link SingleVariableDeclaration}s and the * elements in the returned list are of type {@link String} - * + * * @param rawparams * @return a listing of signatures for the specified parameters */ @@ -567,7 +567,7 @@ public final class Signatures { * segment and returning it. This method assumes that qualified type names * are '.' separated. If the type specified is a package than an empty * string is returned. - * + * * @param qualifiedname the fully qualified name of a type, '.' separated * (e.g. a.b.c.Type) * @return the simple name from the qualified name. For example if the @@ -586,7 +586,7 @@ public final class Signatures { /** * Processes the signature for the given {@link Type} - * + * * @param type the type to process * @return the signature for the type or <code>null</code> if one could not * be derived @@ -620,7 +620,7 @@ public final class Signatures { /** * Returns if the given signatures match. Where signatures are considered to * match iff the return type, name and parameters are the same. - * + * * @param signature * @param signature2 * @return true if the signatures are equal, false otherwise @@ -647,7 +647,7 @@ public final class Signatures { /** * Returns if the two types match. Types are considered to match iff the * type name and array count (if any) are the same - * + * * @param type * @param type2 * @return true if the type names match, false otherwise @@ -686,7 +686,7 @@ public final class Signatures { /** * Returns if the specified signature is qualified or not. Qualification is * determined if there is a token in the signature the begins with an 'L'. - * + * * @param signature * @return true if the signature is qualified, false otherwise */ @@ -700,7 +700,7 @@ public final class Signatures { /** * The type name is dot-separated - * + * * @param typeName the given type name * @return the package name for the given type name or an empty string if * none @@ -713,7 +713,7 @@ public final class Signatures { /** * Collects the synthetic parameter of the fully qualified name of the * enclosing context for a constructor of an inner type - * + * * @param method the constructor declaration * @param rparams the listing of parameters to add to */ @@ -758,7 +758,7 @@ public final class Signatures { /** * Returns if the {@link AbstractTypeDeclaration} is static or not (has the * static keyword or not) - * + * * @param typeDeclaration * @return true if it is static, false otherwise */ @@ -782,7 +782,7 @@ public final class Signatures { /** * Determines if the given {@link MethodDeclaration} is present in a top * level type - * + * * @param method the given method * @return true if the given {@link MethodDeclaration} is present in a top * level type, false otherwise @@ -798,7 +798,7 @@ public final class Signatures { * For example:<br> * <code>a.b.c.Type -> Type</code><br> * <code>a.b.c.Type$Member -> Type$Member</code> - * + * * @param referencedTypeName * @return the type name with package qualification removed */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/SinceTagVersion.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/SinceTagVersion.java index 9c2f201639..c96127d95a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/SinceTagVersion.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/SinceTagVersion.java @@ -19,7 +19,7 @@ import org.osgi.framework.Version; * Version identifier for @since tags. It consists of an optional bundle name * followed by a version string that follows the format defined in the class * {@link Version} - * + * * @since 3.4 */ public class SinceTagVersion { @@ -31,7 +31,7 @@ public class SinceTagVersion { /** * Creates a new instance. - * + * * @param value the given since tag value * @throws IllegalArgumentException if the given value is null */ @@ -125,7 +125,7 @@ public class SinceTagVersion { /** * Returns the version part of the @since tag as a string. null if the given * version did not have the right format - * + * * @return the version part of the @since tag */ public String getVersionString() { @@ -135,7 +135,7 @@ public class SinceTagVersion { /** * Returns the version part of the @since tag. null if the given version did * not have the right format - * + * * @return the version part of the @since tag */ public Version getVersion() { @@ -144,7 +144,7 @@ public class SinceTagVersion { /** * Returns the prefix part of the @since tag. It can be null. - * + * * @return the prefix part of the @since tag */ public String prefixString() { @@ -153,7 +153,7 @@ public class SinceTagVersion { /** * Returns the postfix part of the @since tag. It can be null. - * + * * @return the postfix part of the @since tag */ public String postfixString() { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarEntry.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarEntry.java index 4cec97fbc9..b5ba35b39a 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarEntry.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarEntry.java @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -32,7 +32,7 @@ public class TarEntry implements Cloneable { /** * Create a new TarEntry for a file of the given name at the given position * in the file. - * + * * @param name filename * @param pos position in the file in bytes */ @@ -46,7 +46,7 @@ public class TarEntry implements Cloneable { /** * Create a new TarEntry for a file of the given name. - * + * * @param name filename */ public TarEntry(String name) { @@ -66,7 +66,7 @@ public class TarEntry implements Cloneable { /** * Returns the type of this file, one of FILE, LINK, SYM_LINK, CHAR_DEVICE, * BLOCK_DEVICE, DIRECTORY or FIFO. - * + * * @return file type */ public int getFileType() { @@ -75,7 +75,7 @@ public class TarEntry implements Cloneable { /** * Returns the mode of the file in UNIX permissions format. - * + * * @return file mode */ public long getMode() { @@ -84,7 +84,7 @@ public class TarEntry implements Cloneable { /** * Returns the name of the file. - * + * * @return filename */ public String getName() { @@ -93,7 +93,7 @@ public class TarEntry implements Cloneable { /** * Returns the size of the file in bytes. - * + * * @return size */ public long getSize() { @@ -103,7 +103,7 @@ public class TarEntry implements Cloneable { /** * Returns the modification time of the file in seconds since January 1st * 1970. - * + * * @return time */ public long getTime() { @@ -113,7 +113,7 @@ public class TarEntry implements Cloneable { /** * Sets the type of the file, one of FILE, LINK, SYMLINK, CHAR_DEVICE, * BLOCK_DEVICE, or DIRECTORY. - * + * * @param type */ public void setFileType(int type) { @@ -122,7 +122,7 @@ public class TarEntry implements Cloneable { /** * Sets the mode of the file in UNIX permissions format. - * + * * @param mode */ public void setMode(long mode) { @@ -131,7 +131,7 @@ public class TarEntry implements Cloneable { /** * Sets the size of the file in bytes. - * + * * @param size */ public void setSize(long size) { @@ -140,7 +140,7 @@ public class TarEntry implements Cloneable { /** * Sets the modification time of the file in seconds since January 1st 1970. - * + * * @param time */ public void setTime(long time) { diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarException.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarException.java index c4ce38b2ce..53c0538176 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarException.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarException.java @@ -28,7 +28,7 @@ public class TarException extends Exception { /** * Constructs a TarException with the specified detail string. - * + * * @param s the detail string */ public TarException(String s) { @@ -37,7 +37,7 @@ public class TarException extends Exception { /** * Constructs a TarException with the specified detail string. - * + * * @param s the detail string * @param cause the cause */ diff --git a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarFile.java b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarFile.java index ed7a1c822d..12cbc0f544 100644 --- a/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarFile.java +++ b/apitools/org.eclipse.pde.api.tools/src/org/eclipse/pde/api/tools/internal/util/TarFile.java @@ -34,7 +34,7 @@ public class TarFile { /** * Creates a new tar input stream on the given input stream. - * + * * @param in input stream * @throws TarException * @throws IOException @@ -50,7 +50,7 @@ public class TarFile { /** * Create a new tar input stream, skipping ahead to the given entry in * the file. - * + * * @param in input stream * @param entry skips to this entry in the file * @throws TarException @@ -64,7 +64,7 @@ public class TarFile { /** * The checksum of a tar file header is simply the sum of the bytes in * the header. - * + * * @param header * @return checksum */ @@ -78,7 +78,7 @@ public class TarFile { /** * Skips ahead to the position of the given entry in the file. - * + * * @param entry * @returns false if the entry has already been passed * @throws TarException @@ -107,7 +107,7 @@ public class TarFile { /** * Returns true if the header checksum is correct. - * + * * @param header * @return true if this header has a valid checksum */ @@ -151,7 +151,7 @@ public class TarFile { /** * Returns the next entry in the tar file. Does not handle GNU @LongLink * extensions. - * + * * @return the next entry in the tar file * @throws TarException * @throws IOException @@ -283,7 +283,7 @@ public class TarFile { /** * Moves ahead to the next file in the tar archive and returns a * TarEntry object describing it. - * + * * @return the next entry in the tar file * @throws TarException * @throws IOException @@ -347,7 +347,7 @@ public class TarFile { /** * Create a new TarFile for the given file. - * + * * @param file * @throws TarException * @throws IOException @@ -376,7 +376,7 @@ public class TarFile { /** * Close the tar file input stream. - * + * * @throws IOException if the file cannot be successfully closed */ public void close() throws IOException { @@ -390,7 +390,7 @@ public class TarFile { /** * Create a new TarFile for the given path name. - * + * * @param filename * @throws TarException * @throws IOException @@ -401,7 +401,7 @@ public class TarFile { /** * Returns an enumeration cataloguing the tar archive. - * + * * @return enumeration of all files in the archive */ public Enumeration<?> entries() { @@ -428,7 +428,7 @@ public class TarFile { /** * Returns a new InputStream for the given file in the tar archive. - * + * * @param entry * @return an input stream for the given file * @throws TarException @@ -461,7 +461,7 @@ public class TarFile { /** * Returns the path name of the file this archive represents. - * + * * @return path */ public String getName() { 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 abb8ba1410..b4b0bd86e0 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 @@ -4,7 +4,7 @@ * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at * http://www.eclipse.org/legal/epl-v10.html - * + * * Contributors: * IBM Corporation - initial API and implementation *******************************************************************************/ @@ -129,7 +129,7 @@ import org.xml.sax.helpers.DefaultHandler; /** * A Utility class to use for API tools - * + * * @since 1.0.0 */ public final class Util { @@ -150,7 +150,7 @@ public final class Util { /** * Constructor - * + * * @param name * @param project */ @@ -171,7 +171,7 @@ public final class Util { /** * Returns if this build job is covered by another build job - * + * * @param other * @return true if covered by another build job, false otherwise */ @@ -306,7 +306,7 @@ public final class Util { /** * Throws an exception with the given message and underlying exception. - * + * * @param message error message * @param exception underlying exception, or <code>null</code> * @throws CoreException @@ -319,7 +319,7 @@ public final class Util { /** * Appends a property to the given string buffer with the given key and * value in the format "key=value\n". - * + * * @param buffer buffer to append to * @param key key * @param value value @@ -333,7 +333,7 @@ public final class Util { /** * Collects all of the deltas from the given parent delta - * + * * @param delta * @return */ @@ -353,7 +353,7 @@ public final class Util { /** * Collects files into the collector array list - * + * * @param root the root to collect the files from * @param collector the collector to place matches into * @param fileFilter the filter for files or <code>null</code> to accept all @@ -373,7 +373,7 @@ public final class Util { /** * Returns all of the API projects in the workspace - * + * * @return all of the API projects in the workspace or <code>null</code> if * there are none. */ @@ -402,7 +402,7 @@ public final class Util { /** * Returns all of the API projects in the workspace - * + * * @param sourcelevel * @return all of the API projects in the workspace or <code>null</code> if * there are none. @@ -436,7 +436,7 @@ public final class Util { /** * Copies the given file to the new file - * + * * @param file * @param newFile * @return if the copy succeeded @@ -486,7 +486,7 @@ public final class Util { /** * Creates an EE file for the given JRE and specified EE id - * + * * @param jre * @param eeid * @return @@ -510,7 +510,7 @@ public final class Util { /** * Returns whether the objects are equal, accounting for either one being * <code>null</code>. - * + * * @param o1 * @param o2 * @return whether the objects are equal, or both are <code>null</code> @@ -524,7 +524,7 @@ public final class Util { /** * Returns an execution environment description for the given VM. - * + * * @param vm JRE to create an definition for * @return an execution environment description for the given VM * @throws IOException if unable to generate description @@ -550,7 +550,7 @@ public final class Util { * Returns an array of all of the files from the given root that are * accepted by the given file filter. If the file filter is null all files * within the given root are returned. - * + * * @param root * @param fileFilter * @return the list of files from within the given root @@ -568,10 +568,10 @@ public final class Util { /** * Returns a build job that will perform a full build on the given projects. - * + * * If <code>projects</code> are null, then an AssertionFailedException is * thrown - * + * * @param projects the projects to build * @return the build job * @throws AssertionFailedException if the given projects are null @@ -587,10 +587,10 @@ public final class Util { /** * Returns a build job that will return the build that corresponds to the * given build kind on the given projects. - * + * * If <code>projects</code> are null, then an AssertionFailedException is * thrown - * + * * @param projects the projects to build * @param buildKind the given build kind * @return the build job @@ -607,7 +607,7 @@ public final class Util { /** * Returns a result of searching the given components for class file with * the given type name. - * + * * @param components API components to search or <code>null</code> if none * @param typeName type to search for * @return class file or <code>null</code> if none found @@ -636,7 +636,7 @@ public final class Util { * Return a string that represents the element type of the given delta. * Returns {@link #UNKNOWN_ELEMENT_KIND} if the element type cannot be * determined. - * + * * @param delta the given delta * @return a string that represents the element type of the given delta. */ @@ -646,7 +646,7 @@ public final class Util { /** * Returns a text representation of a marker severity level - * + * * @param severity * @return text of a marker severity level */ @@ -670,7 +670,7 @@ public final class Util { /** * Return an int value that represents the given element type Returns -1 if * the element type cannot be determined. - * + * * @param elementType the given element type * @return an int that represents the given element type constant. */ @@ -694,7 +694,7 @@ public final class Util { /** * Return a string that represents the given element type Returns * {@link #UNKNOWN_ELEMENT_KIND} if the element type cannot be determined. - * + * * @param elementType the given element type * @return a string that represents the given element type. */ @@ -729,7 +729,7 @@ public final class Util { /** * Return a string that represents the given flags Returns * {@link #UNKNOWN_FLAGS} if the flags cannot be determined. - * + * * @param flags the given delta's flags * @return a string that represents the given flags. */ @@ -876,7 +876,7 @@ public final class Util { /** * Return a string that represents the kind of the given delta. Returns * {@link #UNKNOWN_KIND} if the kind cannot be determined. - * + * * @param delta the given delta * @return a string that represents the kind of the given delta. */ @@ -887,7 +887,7 @@ public final class Util { /** * Return a string that represents the given kind. Returns * {@link #UNKNOWN_KIND} if the kind cannot be determined. - * + * * @param delta the given kind * @return a string that represents the given kind. */ @@ -908,7 +908,7 @@ public final class Util { /** * Returns the preference key for the given element type, the given kind and * the given flags. - * + * * @param elementType the given element type (retrieved using * {@link IDelta#getElementType()} * @param kind the given kind (retrieved using {@link IDelta#getKind()} @@ -971,7 +971,7 @@ public final class Util { /** * Returns the details of the API delta as a string - * + * * @param delta * @return the details of the delta as a string */ @@ -1029,7 +1029,7 @@ public final class Util { /** * Returns the {@link IDocument} for the specified {@link ICompilationUnit} - * + * * @param cu * @return the {@link IDocument} for the specified {@link ICompilationUnit} * @throws CoreException @@ -1054,9 +1054,9 @@ public final class Util { /** * Returns the OSGi profile properties corresponding to the given execution * environment id, or <code>null</code> if none. - * + * * @param eeId OSGi profile identifier - * + * * @return the corresponding properties or <code>null</code> if none */ public static Properties getEEProfile(String eeId) { @@ -1084,7 +1084,7 @@ public final class Util { * Returns the number of fragments for the given version value, -1 if the * format is unknown. The version is formed like: [optional plug-in name] * major.minor.micro.qualifier. - * + * * @param version the given version value * @return the number of fragments for the given version value or -1 if the * format is unknown @@ -1214,7 +1214,7 @@ public final class Util { /** * Updates a given progress monitor the given amount of work. Throws an * {@link OperationCanceledException} if the monitor has been canceled. - * + * * @param monitor * @param work * @throws OperationCanceledException @@ -1232,7 +1232,7 @@ public final class Util { /** * Updates the given monitor 0 work ticks. This method is used to poll for * cancellation without advancing the work done. - * + * * @param monitor * @throws OperationCanceledException */ @@ -1339,7 +1339,7 @@ public final class Util { /** * Returns the given input stream as a byte array - * + * * @param stream the stream to get as a byte array * @param length the length to read from the stream or -1 for unknown * @return the given input stream as a byte array @@ -1390,7 +1390,7 @@ public final class Util { * length is specified (i.e. if length != -1), this represents the number of * bytes in the stream. Note the specified stream is not closed in this * method - * + * * @param stream the stream to get convert to the char array * @param length the length of the input stream, or -1 if unknown * @param encoding the encoding to use when reading the stream @@ -1428,7 +1428,7 @@ public final class Util { /** * Tries to find the 'MANIFEST.MF' file with in the given project in the * 'META-INF folder'. - * + * * @param currentProject * @return a handle to the manifest file or <code>null</code> if not found */ @@ -1440,7 +1440,7 @@ public final class Util { * Returns if the given {@link IMarker} is representing an * {@link org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem} * or not - * + * * @param marker the marker to check * @return true if the marker is for an * {@link org.eclipse.pde.api.tools.internal.provisional.problems.IApiProblem} @@ -1453,7 +1453,7 @@ public final class Util { /** * Returns a reference type for the given fully qualified type name. - * + * * @param fullyQualifiedName type name * @return reference type */ @@ -1466,7 +1466,7 @@ public final class Util { /** * Returns if the given project is API enabled - * + * * @param project the given project * @return true if the project is API enabled, false otherwise */ @@ -1480,7 +1480,7 @@ public final class Util { /** * Returns if the given project is a java project - * + * * @param project the given project * @return <code>true</code> if the project is a java project, * <code>false</code> otherwise @@ -1495,7 +1495,7 @@ public final class Util { /** * Returns if the given project is API enabled - * + * * @param project the given project * @return <code>true</code> if the project is API enabled, * <code>false</code> otherwise @@ -1510,7 +1510,7 @@ public final class Util { /** * Returns if the given {@link IApiComponent} is a valid * {@link IApiComponent} - * + * * @param apiComponent the given component * @return true if the given {@link IApiComponent} is valid, false otherwise */ @@ -1546,7 +1546,7 @@ public final class Util { /** * Returns if the specified file name is an archive name. A name is * considered to be an archive name if it ends with either '.zip' or '.jar' - * + * * @param fileName * @return true if the file name is an archive name false otherwise */ @@ -1557,7 +1557,7 @@ public final class Util { /** * Returns if the given file name represents a 'standard' archive, where the * name has an extension of *.zip or *.jar - * + * * @param fileName * @return true if the given file name is that of a 'standard' archive, * false otherwise @@ -1570,7 +1570,7 @@ public final class Util { /** * Returns if the given file name represents a G-zip file name, where the * name has an extension of *.tar.gz or *.tgz - * + * * @param fileName * @return true if the given file name is that of a G-zip archive, false * otherwise @@ -1582,7 +1582,7 @@ public final class Util { /** * Returns if the flags are for a class - * + * * @param accessFlags the given access flags * @return */ @@ -1593,7 +1593,7 @@ public final class Util { /** * Returns if the specified file name is for a class file. A name is * considered to be a class file if it ends in '.class' - * + * * @param fileName * @return true if the name is for a class file false otherwise */ @@ -1634,7 +1634,7 @@ public final class Util { /** * Returns if the specified file name is for a java source file. A name is * considered to be a java source file if it ends in '.java' - * + * * @param fileName * @return true if the name is for a java source file, false otherwise */ @@ -1644,7 +1644,7 @@ public final class Util { /** * Returns if the given name is {@link java.lang.Object} - * + * * @param name * @return true if the name is java.lang.Object, false otherwise */ @@ -1654,7 +1654,7 @@ public final class Util { /** * Return if the name is {@link java.lang.RuntimeException} - * + * * @param name * @return true if the name is java.lang.RuntimeException, false otherwise */ @@ -1672,7 +1672,7 @@ public final class Util { /** * Returns a new XML document. - * + * * @return document * @throws CoreException if unable to create a new document */ @@ -1691,7 +1691,7 @@ public final class Util { /** * Parses the given string representing an XML document, returning its root * element. - * + * * @param document XML document as a string * @return the document's root element * @throws CoreException if unable to parse the document @@ -1727,7 +1727,7 @@ public final class Util { /** * Save the given contents into the given file. The file parent folder must * exist. - * + * * @param file the given file target * @param contents the given contents * @throws IOException if an IOException occurs while saving the file @@ -1751,7 +1751,7 @@ public final class Util { /** * Returns the contents of the given file as a string, or <code>null</code> - * + * * @param file the file to get the contents for * @return the contents of the file as a {@link String} or <code>null</code> */ @@ -1779,7 +1779,7 @@ public final class Util { /** * Returns the given string as an {@link InputStream}. It is up to the * caller to close the new stream. - * + * * @param string the string to convert * @return the {@link InputStream} for the given string */ @@ -1794,7 +1794,7 @@ public final class Util { /** * Serializes the given XML document into a UTF-8 string. - * + * * @param document XML document to serialize * @return a string representing the given document * @throws CoreException if unable to serialize the document @@ -1913,7 +1913,7 @@ public final class Util { /** * Gets the .ee file supplied to run tests based on system property. - * + * * @return */ public static File getEEDescriptionFile() { @@ -1942,7 +1942,7 @@ public final class Util { /** * Creates a new file in the users' <code>temp</code> directory - * + * * @param prefix * @param suffix * @return a new temp file @@ -2065,7 +2065,7 @@ public final class Util { * Delete a file or directory and insure that the file is no longer present * on file system. In case of directory, delete all the hierarchy * underneath. - * + * * @param file The file or directory to delete * @return true iff the file was really delete, false otherwise */ @@ -2097,7 +2097,7 @@ public final class Util { /** * Wait until the file is _really_ deleted on file system. - * + * * @param file Deleted file * @return true if the file was finally deleted, false otherwise */ @@ -2150,7 +2150,7 @@ public final class Util { * Returns whether a file is really deleted or not. Does not only rely on * {@link File#exists()} method but also look if it's not in its parent * children {@link #getParentChildFile(File)}. - * + * * @param file The file to test if deleted * @return true if the file does not exist and was not found in its parent * children. @@ -2162,7 +2162,7 @@ public final class Util { /** * Returns the parent's child file matching the given file or null if not * found. - * + * * @param file The searched file in parent * @return The parent's child matching the given file or null if not found. */ @@ -2192,7 +2192,7 @@ public final class Util { /** * Turns the given array of strings into a {@link HashSet} - * + * * @param values * @return a new {@link HashSet} of the string array */ @@ -2209,7 +2209,7 @@ public final class Util { /** * Returns an identifier for the given API component including its version * identifier (component id + '(' + major + . + minor + . + micro + ')' ) - * + * * @param component API component * @return API component + version identifier */ @@ -2235,7 +2235,7 @@ public final class Util { /** * Returns an identifier for the given API component including its version * identifier (component id + _ + major + _ + minor + _ + micro) - * + * * @param component API component * @return API component + version identifier */ @@ -2296,7 +2296,7 @@ public final class Util { /** * Returns the string representation of the {@link IApiElement} type - * + * * @param type * @return the string of the {@link IApiElement} type */ @@ -2399,7 +2399,7 @@ public final class Util { * {@link IType} is <code>null</code> or the type cannot be located (does * not exist) than the MANIFEST.MF will be returned. <code>null</code> can * be returned in the case that the project does not have a manifest file. - * + * * @param project the project to look in for the {@link IResource} * @param type the type we are looking for the resource for, or * <code>null</code> @@ -2444,7 +2444,7 @@ public final class Util { * Initializes the exclude set with regex support. The API baseline is used * to determine which bundles should be added to the list when processing * regex expressions. - * + * * @param location * @param baseline * @return the list of bundles to be excluded @@ -2505,7 +2505,7 @@ public final class Util { /** * Collects the set of component ids that match a given regex in the exclude * file - * + * * @param line * @param list * @param components @@ -2553,7 +2553,7 @@ public final class Util { * Returns true if the given {@link IApiType} is API or not, where API is * defined as having API visibility in an API description and having either * the public of protected Java flag set - * + * * @param visibility * @param typeDescriptor * @return true if the given type is API, false otherwise @@ -2566,7 +2566,7 @@ public final class Util { /** * Simple method to walk an array and call <code>toString()</code> on each * of the entries. Does not descend into sub-collections. - * + * * @param array the array * @return the comma-separated string representation of the the array * @since 1.0.3 diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationReportConversionTask.java index d0813bc78f..6414eefefe 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationReportConversionTask.java @@ -360,7 +360,7 @@ public class APIDeprecationReportConversionTask extends Task { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -369,16 +369,16 @@ public class APIDeprecationReportConversionTask extends Task { /** * Set the path of the html file to generate. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * <p> * This is optional. If not set, the html file name is retrieved from the * xml file name by replacing ".xml" in ".html". * </p> - * + * * @param htmlFilePath the path of the html file to generate */ public void setHtmlFile(String htmlFilePath) { @@ -387,11 +387,11 @@ public class APIDeprecationReportConversionTask extends Task { /** * Set the path of the xml file to convert to html. - * + * * <p> * The path is set using an absolute path. * </p> - * + * * @param xmlFilePath the path of the xml file to convert to html */ public void setXmlFile(String xmlFilePath) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationTask.java index ed17a7c265..2223cf1d29 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIDeprecationTask.java @@ -186,7 +186,7 @@ public class APIDeprecationTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -202,7 +202,7 @@ public class APIDeprecationTask extends CommonUtilsTask { * <p> * The file is specified using an absolute path. This is optional. * </p> - * + * * @param eeFileLocation the given execution environment file */ public void setEEFile(String eeFileLocation) { @@ -211,7 +211,7 @@ public class APIDeprecationTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles and members should excluded * from the xml report generated by the task execution. Lines starting with @@ -220,7 +220,7 @@ public class APIDeprecationTask extends CommonUtilsTask { * <p> * The format of the exclude file looks like this: * </p> - * + * * <pre> * # 229688 * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#dispose()V @@ -230,7 +230,7 @@ public class APIDeprecationTask extends CommonUtilsTask { * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListTreeContentProvider#getChildren(Ljava/lang/Object;)[Ljava/lang/Object; * ... * </pre> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -239,7 +239,7 @@ public class APIDeprecationTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles and members should included * from the xml report generated by the task execution. Lines starting with @@ -248,7 +248,7 @@ public class APIDeprecationTask extends CommonUtilsTask { * <p> * The format of the exclude file looks like this: * </p> - * + * * <pre> * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#dispose()V * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; @@ -257,7 +257,7 @@ public class APIDeprecationTask extends CommonUtilsTask { * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListTreeContentProvider#getChildren(Ljava/lang/Object;)[Ljava/lang/Object; * ... * </pre> - * + * * @param includeListLocation the given location for the included list file */ public void setIncludeList(String includeListLocation) { @@ -267,13 +267,13 @@ public class APIDeprecationTask extends CommonUtilsTask { /** * Set the location of the current product or baseline that you want to * compare against the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the baseline to analyze */ public void setProfile(String baselineLocation) { @@ -282,13 +282,13 @@ public class APIDeprecationTask extends CommonUtilsTask { /** * Set the location of the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ @@ -298,7 +298,7 @@ public class APIDeprecationTask extends CommonUtilsTask { /** * Set the given report file name to be generated. - * + * * @param reportLocation the given report file name to be generated. */ public void setReport(String reportLocation) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeReportConversionTask.java index df63b2faad..4b1b74baee 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeReportConversionTask.java @@ -517,7 +517,7 @@ public class APIFreezeReportConversionTask extends Task { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -526,16 +526,16 @@ public class APIFreezeReportConversionTask extends Task { /** * Set the path of the html file to generate. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * <p> * This is optional. If not set, the html file name is retrieved from the * xml file name by replacing ".xml" in ".html". * </p> - * + * * @param htmlFilePath the path of the html file to generate */ public void setHtmlFile(String htmlFilePath) { @@ -544,11 +544,11 @@ public class APIFreezeReportConversionTask extends Task { /** * Set the path of the xml file to convert to html. - * + * * <p> * The path is set using an absolute path. * </p> - * + * * @param xmlFilePath the path of the xml file to convert to html */ public void setXmlFile(String xmlFilePath) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeTask.java index a997d8d794..d9833364c8 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIFreezeTask.java @@ -256,7 +256,7 @@ public class APIFreezeTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -272,7 +272,7 @@ public class APIFreezeTask extends CommonUtilsTask { * <p> * The file is specified using an absolute path. This is optional. * </p> - * + * * @param eeFileLocation the given execution environment file */ public void setEEFile(String eeFileLocation) { @@ -281,7 +281,7 @@ public class APIFreezeTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles and members should excluded * from the xml report generated by the task execution. Lines starting with @@ -290,7 +290,7 @@ public class APIFreezeTask extends CommonUtilsTask { * <p> * The format of the exclude file looks like this: * </p> - * + * * <pre> * # 229688 * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#dispose()V @@ -300,7 +300,7 @@ public class APIFreezeTask extends CommonUtilsTask { * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListTreeContentProvider#getChildren(Ljava/lang/Object;)[Ljava/lang/Object; * ... * </pre> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -309,7 +309,7 @@ public class APIFreezeTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles and members should included * from the xml report generated by the task execution. Lines starting with @@ -318,7 +318,7 @@ public class APIFreezeTask extends CommonUtilsTask { * <p> * The format of the include file looks like this: * </p> - * + * * <pre> * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#dispose()V * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; @@ -327,7 +327,7 @@ public class APIFreezeTask extends CommonUtilsTask { * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListTreeContentProvider#getChildren(Ljava/lang/Object;)[Ljava/lang/Object; * ... * </pre> - * + * * @param includeListLocation the given location for the included list file */ public void setIncludeList(String includeListLocation) { @@ -337,13 +337,13 @@ public class APIFreezeTask extends CommonUtilsTask { /** * Set the location of the current product or baseline that you want to * compare against the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the baseline to analyze */ public void setProfile(String baselineLocation) { @@ -352,13 +352,13 @@ public class APIFreezeTask extends CommonUtilsTask { /** * Set the location of the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ @@ -368,7 +368,7 @@ public class APIFreezeTask extends CommonUtilsTask { /** * Set the given report file name to be generated. - * + * * @param reportLocation the given report file name to be generated. */ public void setReport(String reportLocation) { @@ -381,7 +381,7 @@ public class APIFreezeTask extends CommonUtilsTask { * comparison may not be accurate. A list of the bundles with resolver * errors is included in the xml output and is incorporated into the html * output of the report conversion task. Defaults to <code>true</code> - * + * * @param processUnresolvedBundles whether to continue processing a bundle * that has resolver errors */ @@ -393,7 +393,7 @@ public class APIFreezeTask extends CommonUtilsTask { * Modifies the given doc to add a new element under the root element that * lists all the components that had resolver errors which could affect the * results of the comparison. - * + * * @param document XML document to modify */ private void addResolverErrors(Document document) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIToolsAnalysisTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIToolsAnalysisTask.java index 0e7468f165..8e698c4220 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIToolsAnalysisTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/APIToolsAnalysisTask.java @@ -311,7 +311,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Run the api tools verification task - * + * * @throws BuildException exception is thrown if anything goes wrong during * the verification */ @@ -527,7 +527,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * match to the exlude list or the name is not a match to the include list. * If no include or exclude list is provided, no filtering is done and * <code>false</code> is returned. - * + * * @param componentID name of the api component (symbolic name of a bundle) * @return whether the given component should be filtered out of results */ @@ -571,14 +571,14 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Returns an element that contains all the API problem nodes. - * + * * @param document the given XML document * @param problems the given problem to dump into the document * @param counter a counter object to which the reported problems can be * added * @return an element that contains all the api problem nodes or null if an * error occurred - * + * * @throws CoreException */ private void insertAPIProblems(Element root, Document document, List<IApiProblem> problems, ProblemCounter counter) throws CoreException { @@ -638,7 +638,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * By default, we return a warning severity. - * + * * @param problem the given problem * @return the problem's severity */ @@ -665,7 +665,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -681,7 +681,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The file is specified using an absolute path. This is optional. * </p> - * + * * @param eeFileLocation the given execution environment file */ public void setEEFile(String eeFileLocation) { @@ -690,7 +690,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles should excluded from the * xml report generated by the task execution. Lines starting with '#' are @@ -699,7 +699,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The format of the exclude list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -717,7 +717,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -726,7 +726,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles should included from the * xml report generated by the task execution. Lines starting with '#' are @@ -735,7 +735,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The format of the include list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -753,7 +753,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param includeListLocation the given location for the included list file */ public void setIncludeList(String includeListLocation) { @@ -762,13 +762,13 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the root directory of API filters to use during the analysis. - * + * * <p> * The argument is the root directory of the .api_filters files that should * be used to filter potential problems created by the API Tools analysis. * The root needs to contain the following structure: * </p> - * + * * <pre> * root * | @@ -776,7 +776,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * | * +--- .api_filters * </pre> - * + * * @param filters the root of the .api_filters files */ public void setFilters(String filters) { @@ -785,7 +785,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the preferences for the task. - * + * * <p> * The preferences are used to configure problem severities. Problem * severities have three possible values: Ignore, Warning, or Error. The set @@ -799,7 +799,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * Lines starting with '#' are ignored. The format of the preferences file * looks like this: * </p> - * + * * <pre> * #Thu Nov 20 17:35:06 EST 2008 * ANNOTATION_ELEMENT_TYPE_ADDED_METHOD_WITHOUT_DEFAULT_VALUE=Ignore @@ -823,7 +823,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param preferencesLocation the location of the preference file */ public void setPreferences(String preferencesLocation) { @@ -853,13 +853,13 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the location of the current product or baseline that you want to * compare against the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the baseline to analyze */ public void setProfile(String baselineLocation) { @@ -868,7 +868,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the location of the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is @@ -877,7 +877,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ @@ -887,20 +887,20 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { /** * Set the output location where the reports will be generated. - * + * * <p> * Once the task is completed, reports are available in this directory using * a structure similar to the filter root. A sub-folder is created for each * component that has problems to be reported. Each sub-folder contains a * file called "report.xml". * </p> - * + * * <p> * A special folder called "allNonApiBundles" is also created in this folder * that contains a xml file called "report.xml". This file lists all the * bundles that are not using the API Tools nature. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ @@ -914,7 +914,7 @@ public class APIToolsAnalysisTask extends CommonUtilsTask { * analysis may not be accurate. A list of the resolver errors found for * each bundle will be included in the xml output and incorporated into the * html output of the report conversion task. Defaults to <code>true</code> - * + * * @param processUnresolvedBundles whether to continue processing a bundle * that has resolver errors */ diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/AnalysisReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/AnalysisReportConversionTask.java index 6255d9df0d..c88d62249b 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/AnalysisReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/AnalysisReportConversionTask.java @@ -309,7 +309,7 @@ public class AnalysisReportConversionTask extends Task { /** * Write out the index file - * + * * @param reportsRoot * @param summaries * @param allNonApiBundleSummary @@ -542,7 +542,7 @@ public class AnalysisReportConversionTask extends Task { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -551,7 +551,7 @@ public class AnalysisReportConversionTask extends Task { /** * Set the location where the html reports are generated. - * + * * <p> * This is optional. If not set, the html files are created in the same * folder as the xml files. @@ -559,7 +559,7 @@ public class AnalysisReportConversionTask extends Task { * <p> * The location is set using an absolute path. * </p> - * + * * @param htmlFilesLocation the given the location where the html reports * are generated */ @@ -569,11 +569,11 @@ public class AnalysisReportConversionTask extends Task { /** * Set the location where the xml reports are retrieved. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * @param xmlFilesLocation the given location to retrieve the xml reports */ public void setXmlFiles(String xmlFilesLocation) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiConsumerUseReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiConsumerUseReportConversionTask.java index 1d5b47b322..49651ff1f1 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiConsumerUseReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiConsumerUseReportConversionTask.java @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; * Task to convert a report generated from {@link ApiUseTask} to HTML. * References to API/internals are grouped by the bundle that used them * (Consumers). - * + * * @since 1.0.300 * @see ApiUseTask */ @@ -42,7 +42,7 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -51,7 +51,7 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { /** * Set the location where the html reports are generated. - * + * * <p> * This is optional. If not set, the html files are created in the same * folder as the xml files. @@ -59,7 +59,7 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param htmlFilesLocation the given the location where the html reports * are generated */ @@ -69,11 +69,11 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { /** * Set the location where the xml reports are retrieved. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * @param xmlFilesLocation the given location to retrieve the xml reports */ public void setXmlFiles(String xmlFilesLocation) { @@ -84,7 +84,7 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { * Set the group of {@link String} patterns to use as heuristics to filter * references to names matching any of the given patterns during the report * conversion - * + * * @param patterns */ public void setToFilterPatterns(String patterns) { @@ -95,7 +95,7 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { * Set the group of {@link String} patterns to use as heuristics to filter * references from names matching any of the given patterns during the * report conversion - * + * * @param patterns */ public void setFilterPatterns(String patterns) { @@ -105,15 +105,15 @@ public class ApiConsumerUseReportConversionTask extends CommonUtilsTask { /** * Sets the location of the XSLT file to use in the conversion of the XML * the HTML. - * + * * <p> * This is optional. If none is specified, then a default one is used. * </p> - * + * * <p> * The location is an absolute path. * </p> - * + * * @param xsltFileLocation */ public void setXSLTFile(String xsltFileLocation) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiFileGenerationTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiFileGenerationTask.java index b052eff782..40e92b9fb7 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiFileGenerationTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiFileGenerationTask.java @@ -119,7 +119,7 @@ public class ApiFileGenerationTask extends Task { boolean allowNonApiProject = false; /** * The encoding to read the source files with - * + * * @since 1.0.600 */ String encoding; @@ -127,7 +127,7 @@ public class ApiFileGenerationTask extends Task { /** * Set the project name. - * + * * @param projectName the given project name */ public void setProjectName(String projectName) { @@ -136,14 +136,14 @@ public class ApiFileGenerationTask extends Task { /** * Set the project location. - * + * * <br> * <br> * This is the folder that contains all the source files for the given * project. <br> * <br> * The location is set using an absolute path.</p> - * + * * @param projectLocation the given project location */ public void setProject(String projectLocation) { @@ -152,13 +152,13 @@ public class ApiFileGenerationTask extends Task { /** * Set the target location. - * + * * <br> * <br> * This is the folder in which the generated files are generated. <br> * <br> * The location is set using an absolute path.</p> - * + * * @param targetLocation the given target location */ public void setTarget(String targetLocation) { @@ -167,7 +167,7 @@ public class ApiFileGenerationTask extends Task { /** * Set the binary locations. - * + * * <br> * <br> * This is a list of folders or jar files that contain all the .class files @@ -175,7 +175,7 @@ public class ApiFileGenerationTask extends Task { * Each entry must exist. <br> * <br> * They should be specified using absolute paths. - * + * * @param binaryLocations the given binary locations */ public void setBinary(String binaryLocations) { @@ -191,7 +191,7 @@ public class ApiFileGenerationTask extends Task { * <p> * Default is: <code>false</code>. * </p> - * + * * @since 1.2 * @param allow */ @@ -201,7 +201,7 @@ public class ApiFileGenerationTask extends Task { /** * Sets the encoding the task should use when reading text streams - * + * * @param encoding * @since 1.0.600 */ @@ -217,7 +217,7 @@ public class ApiFileGenerationTask extends Task { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -226,7 +226,7 @@ public class ApiFileGenerationTask extends Task { /** * Set the extra manifest files' locations. - * + * * <p> * This is a list of extra MANIFEST.MF files' locations that can be set to * provide more API packages to scan. They are separated by the platform @@ -240,7 +240,7 @@ public class ApiFileGenerationTask extends Task { * Jar files can be specified instead of MANIFEST.MF file. If a jar file is * specified, its MANIFEST.MF file will be read if it exists. * </p> - * + * * @param manifests the given extra manifest files' locations */ public void setExtraManifests(String manifests) { @@ -249,14 +249,14 @@ public class ApiFileGenerationTask extends Task { /** * Set the extra source locations. - * + * * <br> * <br> * This is a list of locations for source files that will be scanned. They * are separated by the platform path separator. Each entry must exist. <br> * <br> * They should be specified using absolute paths. - * + * * @param manifests the given extra source locations */ public void setExtraSourceLocations(String sourceLocations) { @@ -486,7 +486,7 @@ public class ApiFileGenerationTask extends Task { /** * Returns if the given path ends with one of the collected API path names - * + * * @param path * @return true if the given path name ends with one of the collected API * package names @@ -503,7 +503,7 @@ public class ApiFileGenerationTask extends Task { /** * Collects the names of the packages that are API for the bundle the API * description is being created for - * + * * @param manifestmap * @return the names of the packages that are API for the bundle the API * description is being created for @@ -559,7 +559,7 @@ public class ApiFileGenerationTask extends Task { /** * Resolves the compiler compliance based on the BREE entry in the * MANIFEST.MF file - * + * * @param manifestmap * @return The derived {@link JavaCore#COMPILER_COMPLIANCE} from the BREE in * the manifest map, or {@link JavaCore#VERSION_1_3} if there is no @@ -592,7 +592,7 @@ public class ApiFileGenerationTask extends Task { /** * Resolves if the '.project' file belongs to an API enabled project or not - * + * * @param dotProjectFile * @return true if the '.project' file is for an API enabled project, false * otherwise @@ -630,7 +630,7 @@ public class ApiFileGenerationTask extends Task { /** * Check if the given source contains an source extension point. - * + * * @param pluginXMLContents the given file contents * @return true if it contains a source extension point, false otherwise */ diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationReportConversionTask.java index 7fa1103640..e8349d614f 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiMigrationReportConversionTask.java @@ -20,7 +20,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Task to convert a report generated from {@link ApiMigrationTask} to HTML - * + * * @since 1.0.1 * @see ApiMigrationTask */ @@ -40,7 +40,7 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -49,7 +49,7 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { /** * Set the location where the html reports are generated. - * + * * <p> * This is optional. If not set, the html files are created in the same * folder as the xml files. @@ -57,7 +57,7 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param htmlFilesLocation the given the location where the html reports * are generated */ @@ -67,11 +67,11 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { /** * Set the location where the xml reports are retrieved. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * @param xmlFilesLocation the given location to retrieve the xml reports */ public void setXmlFiles(String xmlFilesLocation) { @@ -82,7 +82,7 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { * Set the group of {@link String} patterns to use as heuristics to filter * references to names matching any of the given patterns during the report * conversion - * + * * @param patterns */ public void setToFilterPatterns(String patterns) { @@ -93,7 +93,7 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { * Set the group of {@link String} patterns to use as heuristics to filter * references from names matching any of the given patterns during the * report conversion - * + * * @param patterns */ public void setFilterPatterns(String patterns) { @@ -103,15 +103,15 @@ public class ApiMigrationReportConversionTask extends CommonUtilsTask { /** * Sets the location of the XSLT file to use in the conversion of the XML * the HTML. - * + * * <p> * This is optional. If none is specified, then a default one is used. * </p> - * + * * <p> * The location is an absolute path. * </p> - * + * * @param xsltFileLocation */ public void setXSLTFile(String xsltFileLocation) { 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 a976d3a5bc..3460042c3e 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 @@ -64,13 +64,13 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Set the location of the product you want to use as the migration * candidate. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param location the location for the migration candidate to consider */ public void setCandidate(String location) { @@ -80,12 +80,12 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Set the regular expression pattern used to build the scope of elements to * search for references from in the product location. - * + * * <p> * The pattern must be a well-formatted regular expression as defined here: * http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html * </p> - * + * * @param scopepattern */ public void setScopePattern(String scopepattern) { @@ -95,12 +95,12 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Set the regular expression pattern used to build the scope of elements to * search for references to in the product location. - * + * * <p> * The pattern must be a well-formatted regular expression as defined here: * http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html * </p> - * + * * @param referencepattern */ public void setReferencePattern(String referencepattern) { @@ -109,20 +109,20 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Set the output location where the reports will be generated. - * + * * <p> * Once the task is completed, reports are available in this directory using * a structure similar to the filter root. A sub-folder is created for each * component that has problems to be reported. Each sub-folder contains a * file called "report.xml". * </p> - * + * * <p> * A special folder called "allNonApiBundles" is also created in this folder * that contains a xml file called "report.xml". This file lists all the * bundles that are not using the API Tools nature. * </p> - * + * * @param reportlocation the given location for the reference baseline to * analyze */ @@ -134,7 +134,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * Set the location of an existing API use scan containing references to * re-resolve in the migration candidate. This can be the root directory * containing 'xml' and 'html' subdirectories or the 'xml' directory itself. - * + * * @param scanLocation the location of an existing API use scan */ public void setUseScan(String scanLocation) { @@ -149,7 +149,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -263,7 +263,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Returns if we should add the given component to our search scope - * + * * @param component * @param pattern * @param allowresolve @@ -292,7 +292,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * location. The returned {@link IApiBaseline} is not checked for resolution * errors or consistency. If <code>null</code> is passed in as a location * <code>null</code> is returned. - * + * * @param name the name to give to the baseline * @param location the location the baseline should be prepared from. If * <code>null</code> is passed in, <code>null</code> is returned @@ -375,7 +375,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles should excluded from the * xml report generated by the task execution. Lines starting with '#' are @@ -384,7 +384,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * <p> * The format of the exclude list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -402,7 +402,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -411,7 +411,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles should included from the * xml report generated by the task execution. Lines starting with '#' are @@ -420,7 +420,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * <p> * The format of the include list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -438,7 +438,7 @@ public final class ApiMigrationTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param includeListLocation the given location for the included list file */ public void setIncludeList(String includeListLocation) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseReportConversionTask.java index f7600fe9fb..85329fac83 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/ApiUseReportConversionTask.java @@ -21,7 +21,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Default task for converting the XML output from the apitooling.apiuse ant * task to HTML - * + * * @since 1.0.0 * @noinstantiate This class is not intended to be instantiated by clients. */ @@ -41,7 +41,7 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -50,7 +50,7 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { /** * Set the location where the html reports are generated. - * + * * <p> * This is optional. If not set, the html files are created in the same * folder as the xml files. @@ -58,7 +58,7 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param htmlFilesLocation the given the location where the html reports * are generated */ @@ -68,11 +68,11 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { /** * Set the location where the xml reports are retrieved. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * @param xmlFilesLocation the given location to retrieve the xml reports */ public void setXmlFiles(String xmlFilesLocation) { @@ -83,7 +83,7 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { * Set the group of {@link String} patterns to use as heuristics to filter * references to names matching any of the given patterns during the report * conversion - * + * * @param patterns */ public void setToFilterPatterns(String patterns) { @@ -94,7 +94,7 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { * Set the group of {@link String} patterns to use as heuristics to filter * references from names matching any of the given patterns during the * report conversion - * + * * @param patterns */ public void setFilterPatterns(String patterns) { @@ -104,15 +104,15 @@ public final class ApiUseReportConversionTask extends CommonUtilsTask { /** * Sets the location of the XSLT file to use in the conversion of the XML * the HTML. - * + * * <p> * This is optional. If none is specified, then a default one is used. * </p> - * + * * <p> * The location is an absolute path. * </p> - * + * * @param xsltFileLocation */ public void setXSLTFile(String xsltFileLocation) { 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 82ea4f36cb..aeacea04b8 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 @@ -43,7 +43,7 @@ import com.ibm.icu.text.DateFormat; /** * Ant task for performing the API use analysis of a given Eclipse SDK - * + * * @since 1.0.1 */ public final class ApiUseTask extends CommonUtilsTask { @@ -58,7 +58,7 @@ public final class ApiUseTask extends CommonUtilsTask { private boolean considerinternal = false; /** * if illegal API use should be reported in the search - * + * * @since 1.1 */ private boolean considerillegaluse = false; @@ -94,7 +94,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Archive name patterns to not scan during analysis. Formulation: - * + * * <pre> * <bundle name>:<path to jar> * </pre> @@ -118,13 +118,13 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the location of the current product you want to search. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param location the given location for the baseline to analyze */ public void setLocation(String location) { @@ -134,12 +134,12 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the regular expression pattern used to build the scope of elements to * search for references from in the product location. - * + * * <p> * The pattern must be a well-formatted regular expression as defined here: * http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html * </p> - * + * * @param scopepattern */ public void setScopePattern(String scopepattern) { @@ -149,12 +149,12 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the regular expression pattern used to build the scope of elements to * search for references to in the product location. - * + * * <p> * The pattern must be a well-formatted regular expression as defined here: * http://java.sun.com/j2se/1.4.2/docs/api/java/util/regex/Pattern.html * </p> - * + * * @param referencepattern */ public void setReferencePattern(String referencepattern) { @@ -163,20 +163,20 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the output location where the reports will be generated. - * + * * <p> * Once the task is completed, reports are available in this directory using * a structure similar to the filter root. A sub-folder is created for each * component that has problems to be reported. Each sub-folder contains a * file called "report.xml". * </p> - * + * * <p> * A special folder called "allNonApiBundles" is also created in this folder * that contains a xml file called "report.xml". This file lists all the * bundles that are not using the API Tools nature. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ @@ -192,7 +192,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -207,7 +207,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param considerapi the given value */ public void setConsiderAPI(String considerapi) { @@ -222,7 +222,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param considerillegaluse the given value */ public void setConsiderIllegalUse(String considerillegaluse) { @@ -231,7 +231,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Sets any package name patterns to consider as API packages. - * + * * @param patterns comma separated list of regular expressions or * <code>null</code> */ @@ -247,7 +247,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param considerapi the given value */ public void setConsiderInternal(String considerinternal) { @@ -256,7 +256,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Sets any package name patterns to consider as internal packages. - * + * * @param patterns comma separated list of regular expressions or * <code>null</code> */ @@ -266,7 +266,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Sets any archive name patterns to not scan during the analysis. - * + * * @param patterns */ public void setArchivePatterns(String patterns) { @@ -347,7 +347,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Returns if we should add the given component to our search scope - * + * * @param component * @param pattern * @param allowresolve @@ -373,7 +373,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Collects the scope elements and reference ids in one pass - * + * * @param baseline the baseline to check the components for * @param ids the live set of reference ids * @param scope the live set of elements for the scope @@ -428,7 +428,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Returns the set of search flags to use for the * {@link IApiSearchRequestor} - * + * * @return the set of flags to use */ protected int getSearchFlags() { @@ -443,7 +443,7 @@ public final class ApiUseTask extends CommonUtilsTask { * location. The returned {@link IApiBaseline} is not checked for resolution * errors or consistency. If <code>null</code> is passed in as a location * <code>null</code> is returned. - * + * * @param name the name to give to the baseline * @param location the location the baseline should be prepared from. If * <code>null</code> is passed in, <code>null</code> is returned @@ -543,7 +543,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles should excluded from the * xml report generated by the task execution. Lines starting with '#' are @@ -552,7 +552,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * The format of the exclude list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -570,7 +570,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -579,7 +579,7 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles should included from the * xml report generated by the task execution. Lines starting with '#' are @@ -588,7 +588,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * The format of the include list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -606,7 +606,7 @@ public final class ApiUseTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param includeListLocation the given location for the included list file */ public void setIncludeList(String includeListLocation) { @@ -615,18 +615,18 @@ public final class ApiUseTask extends CommonUtilsTask { /** * Set the root directory of API filters to use during the use scan. - * + * * The argument is the root directory of the .api_filters files that should * be used to filter references. - * + * * The .api_filters files specify specific problems to ignore during api * analysis. During the use scan, the problem filters will be used to filter * the use scan results. If a .api_filters file is found inside the * component both sets of filters will be applied. - * + * * The root is specified using an absolute path. The root needs to contain * the following structure: - * + * * <pre> * root * | @@ -634,7 +634,7 @@ public final class ApiUseTask extends CommonUtilsTask { * | * +--- .api_filters * </pre> - * + * * @param filters the root of the .api_filters files */ public void setFilters(String filters) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CommonUtilsTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CommonUtilsTask.java index 5c01e87a44..67ae15b56a 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CommonUtilsTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CommonUtilsTask.java @@ -32,7 +32,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Common code for API Tools Ant tasks. - * + * * @since 1.0.0 * @noextend This class is not intended to be sub-classed by clients. */ @@ -58,7 +58,7 @@ public abstract class CommonUtilsTask extends Task { * directory. The installLocation will be searched for bundles to add as API * components. If an error occurs creating the baseline, the exception stack * trace will be printed and an empty baseline will be returned. - * + * * @param baselineName Name to use for the new baseline * @param installLocation Location of an installation or directory of * bundles to add as API components @@ -91,7 +91,7 @@ public abstract class CommonUtilsTask extends Task { /** * Deletes an {@link IApiBaseline} from the given folder - * + * * @param referenceLocation * @param folder */ @@ -104,7 +104,7 @@ public abstract class CommonUtilsTask extends Task { /** * Extract extracts the SDK from the given location to the given directory * name - * + * * @param installDirName * @param location * @return the {@link File} handle to the extracted SDK @@ -149,7 +149,7 @@ public abstract class CommonUtilsTask extends Task { /** * Initializes the include/exclude list from the given file location, and * returns a {@link Set} of project names that should be include/excluded. - * + * * @param excludeListLocation * @return the set of project names to be excluded */ @@ -165,7 +165,7 @@ public abstract class CommonUtilsTask extends Task { * Saves the report with the given name in the report location. If a * componentID is provided, a child directory using that name will be * created to put the report in. - * + * * @param componentID Name of the component to create a child directory for * or <code>null<code> to put the report in the XML root * @param contents contents to output to the report @@ -209,7 +209,7 @@ public abstract class CommonUtilsTask extends Task { /** * Parses and returns patterns as an array of Strings or <code>null</code> * if none. - * + * * @param patterns comma separated list or <code>null</code> * @return individual patterns or <code>null</code> */ diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CompareTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CompareTask.java index 41ee37354a..a2667de800 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CompareTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/CompareTask.java @@ -210,7 +210,7 @@ public class CompareTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -220,13 +220,13 @@ public class CompareTask extends CommonUtilsTask { /** * Set the location of the current product or baseline that you want to * compare against the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the baseline to analyze */ public void setProfile(String baselineLocation) { @@ -235,13 +235,13 @@ public class CompareTask extends CommonUtilsTask { /** * Set the location of the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ @@ -251,12 +251,12 @@ public class CompareTask extends CommonUtilsTask { /** * Set the output location where the report will be generated. - * + * * <p> * Once the task is completed, a report file called "compare.xml" is * generated into this location. * </p> - * + * * @param reportLocation the output location where the report will be * generated */ @@ -266,17 +266,17 @@ public class CompareTask extends CommonUtilsTask { /** * Set the visibility to use for the comparison. - * + * * <p> * The two expected values are: <code>"API"</code>, <code>"ALL"</code>. * </p> - * + * * <p> * If the given string doesn't match one of the two values, a build * exception is thrown. If none is set, then the default visibility is * "API". * </p> - * + * * @param visibility the given visibility * @throws BuildException if the given value is not "API" or "ALL". */ @@ -295,22 +295,22 @@ public class CompareTask extends CommonUtilsTask { /** * Set the given components that needs to be compared against the baseline. - * + * * <p> * This is set using a list of component names separated by commas. Each * component name can be either an exact name, or a regular expression if it * starts with <code>"R:"</code>. * </p> - * + * * <p> * Each component should be listed only once. * </p> - * + * * <p> * This is optional. If not set, the whole given baseline will be compared * with the given reference baseline. * </p> - * + * * @param elements the given components */ public void setComponents(String componentsList) { @@ -319,13 +319,13 @@ public class CompareTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles should excluded from the * xml report generated by the task execution. Lines starting with '#' are * ignored from the excluded element. * </p> - * + * * <p> * The exclude list can also contains regular expressions. In this case, the * line must start with "R:". @@ -333,7 +333,7 @@ public class CompareTask extends CommonUtilsTask { * <p> * The format of the exclude file looks like this: * </p> - * + * * <pre> * # 229688 * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#dispose()V @@ -345,7 +345,7 @@ public class CompareTask extends CommonUtilsTask { * org.eclipse.jdt.core * R:org\.eclipse\.pde\..* * </pre> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -354,13 +354,13 @@ public class CompareTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles should included from the * xml report generated by the task execution. Lines starting with '#' are * ignored from the included element. * </p> - * + * * <p> * The include list can also contains regular expressions. In this case, the * line must start with "R:". @@ -368,7 +368,7 @@ public class CompareTask extends CommonUtilsTask { * <p> * The format of the include file looks like this: * </p> - * + * * <pre> * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#dispose()V * org.eclipse.jface.databinding_1.2.0:org.eclipse.jface.databinding.viewers.ObservableListContentProvider#getElements(Ljava/lang/Object;)[Ljava/lang/Object; @@ -379,7 +379,7 @@ public class CompareTask extends CommonUtilsTask { * org.eclipse.jdt.core * R:org\.eclipse\.pde\..* * </pre> - * + * * @param includeListLocation the given location for the included list file */ public void setincludeList(String includeListLocation) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsReportConversionTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsReportConversionTask.java index 204eaf2cbf..e3b6cfab02 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsReportConversionTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsReportConversionTask.java @@ -22,7 +22,7 @@ import org.eclipse.pde.api.tools.internal.util.Util; /** * Default task for converting the XML output from the apitooling.apiuse ants to * HTML - * + * * @noinstantiate This class is not intended to be instantiated by clients. */ public final class MissingRefProblemsReportConversionTask extends CommonUtilsTask { @@ -38,7 +38,7 @@ public final class MissingRefProblemsReportConversionTask extends CommonUtilsTas * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(String debugValue) { @@ -47,7 +47,7 @@ public final class MissingRefProblemsReportConversionTask extends CommonUtilsTas /** * Set the location where the html reports are generated. - * + * * <p> * This is optional. If not set, the html files are created in the same * folder as the xml files. @@ -55,7 +55,7 @@ public final class MissingRefProblemsReportConversionTask extends CommonUtilsTas * <p> * The location is set using an absolute path. * </p> - * + * * @param htmlFilesLocation the given the location where the html reports * are generated */ @@ -65,11 +65,11 @@ public final class MissingRefProblemsReportConversionTask extends CommonUtilsTas /** * Set the location where the xml reports are retrieved. - * + * * <p> * The location is set using an absolute path. * </p> - * + * * @param xmlFilesLocation the given location to retrieve the xml reports */ public void setXmlFiles(String xmlFilesLocation) { diff --git a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsTask.java b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsTask.java index 3e075b6d3e..048c64374c 100644 --- a/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsTask.java +++ b/apitools/org.eclipse.pde.api.tools/src_ant/org/eclipse/pde/api/tools/internal/tasks/MissingRefProblemsTask.java @@ -86,7 +86,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Run the API use scan problems task - * + * * @throws BuildException exception is thrown if anything goes wrong during * the verification */ @@ -217,7 +217,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * If the component should be scanned or not. If not than it is added to the * 'not searched' listing - * + * * @param component * @return <code>true</code> if the component should be scanned, * <code>false</code> otherwise @@ -261,7 +261,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { } } if (super.debug) { - System.out.println("Writing metadata to " + file.getAbsolutePath()); //$NON-NLS-1$ + System.out.println("Writing metadata to " + file.getAbsolutePath()); //$NON-NLS-1$ } MissingRefMetadata metadata = new MissingRefMetadata(super.currentBaselineLocation, super.reportLocation, this.apiUseScans); @@ -381,7 +381,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Adds {@link IApiProblem}s to the given document and root - * + * * @param root * @param document * @param problems @@ -450,7 +450,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * <p> * Default is <code>false</code>. * </p> - * + * * @param debugValue the given debug value */ public void setDebug(boolean debugValue) { @@ -459,7 +459,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Set the exclude list location. - * + * * <p> * The exclude list is used to know what bundles should excluded from the * xml report generated by the task execution. Lines starting with '#' are @@ -468,7 +468,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * <p> * The format of the exclude list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -486,7 +486,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param excludeListLocation the given location for the excluded list file */ public void setExcludeList(String excludeListLocation) { @@ -495,7 +495,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Set the include list location. - * + * * <p> * The include list is used to know what bundles should included from the * xml report generated by the task execution. Lines starting with '#' are @@ -504,7 +504,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * <p> * The format of the include list file looks like this: * </p> - * + * * <pre> * # DOC BUNDLES * org.eclipse.jdt.doc.isv @@ -522,7 +522,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param includeListLocation the given location for the included list file */ public void setIncludeList(String includeListLocation) { @@ -531,7 +531,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Set the preferences for the task. - * + * * <p> * The preferences are used to configure problem severities. Problem * severities have three possible values: Ignore, Warning, or Error. The set @@ -545,7 +545,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * Lines starting with '#' are ignored. The format of the preferences file * looks like this: * </p> - * + * * <pre> * #Thu Jan 11 17:03:09 IST 2011 * API_USE_SCAN_TYPE_SEVERITY=Error @@ -560,7 +560,7 @@ public class MissingRefProblemsTask extends CommonUtilsTask { * <p> * The location is set using an absolute path. * </p> - * + * * @param preferencesLocation the location of the preference file */ public void setPreferences(String preferencesLocation) { @@ -590,13 +590,13 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Set the location of the current product or baseline that you want to * compare against the reference baseline. - * + * * <p> * It can be a .zip, .jar, .tgz, .tar.gz file, or a directory that * corresponds to the Eclipse installation folder. This is the directory is * which you can find the Eclipse executable. * </p> - * + * * @param baselineLocation the given location for the baseline to analyze */ public void setProfile(String baselineLocation) { @@ -606,35 +606,35 @@ public class MissingRefProblemsTask extends CommonUtilsTask { /** * Comma-separated list of the locations of the API Use Scans that you want * to check against the reference baseline. - * + * * <p> * It can be a .zip file or a directory that corresponds to the API Use Scan * report. This is the directory is which you can find the XML folder. * </p> - * + * * @param baselineLocation the given location for the baseline to analyze */ public void setAPIUseScans(String apiUseScans) { this.apiUseScans = apiUseScans; - this.usescans = apiUseScans.split(","); //$NON-NLS-1$ + this.usescans = apiUseScans.split(","); //$NON-NLS-1$ } /** * Set the output location where the reports will be generated. - * + * * <p> * Once the task is completed, reports are available in this directory using * a structure similar to the filter root. A sub-folder is created for each * component that has problems to be reported. Each sub-folder contains a * file called "report.xml". * </p> - * + * * <p> * A special folder called "allNonApiBundles" is also created in this folder * that contains a xml file called "report.xml". This file lists all the * bundles that are not using the api tooling nature. * </p> - * + * * @param baselineLocation the given location for the reference baseline to * analyze */ |