From c1ff5f35db0d3c58516461b2ae0b12ecfcca9de4 Mon Sep 17 00:00:00 2001 From: Andrew Gvozdev Date: Wed, 28 Jul 2010 19:41:48 +0000 Subject: [PATCH] bug 319826: Undeclared/unnecessary Javadoc parameters --- .../scannerconfig/ScannerConfigNature.java | 8 - .../scannerconfig/jobs/CfgSCJobsUtil.java | 8 - .../buildmodel/BuildDescriptionManager.java | 1 - .../buildmodel/IBuildDescription.java | 7 +- .../buildmodel/IBuildResource.java | 4 +- .../managedbuilder/buildmodel/IBuildStep.java | 10 +- .../buildmodel/IStepVisitor.java | 4 - .../managedbuilder/core/IAdditionalInput.java | 6 +- .../cdt/managedbuilder/core/IBuilder.java | 16 -- .../managedbuilder/core/IConfiguration.java | 33 ---- .../managedbuilder/core/IConfigurationV2.java | 27 +-- .../cdt/managedbuilder/core/IFolderInfo.java | 2 +- .../managedbuilder/core/IHoldsOptions.java | 17 +- .../cdt/managedbuilder/core/IInputOrder.java | 8 - .../cdt/managedbuilder/core/IInputType.java | 10 - .../core/IManagedBuildInfo.java | 54 ------ .../core/IManagedCommandLineGenerator.java | 12 -- .../core/IManagedCommandLineInfo.java | 7 - .../core/IManagedOutputNameProvider.java | 6 - .../managedbuilder/core/IManagedProject.java | 18 +- .../cdt/managedbuilder/core/IOption.java | 32 ---- .../managedbuilder/core/IOptionCategory.java | 25 +-- .../cdt/managedbuilder/core/IOutputType.java | 15 -- .../cdt/managedbuilder/core/IProjectType.java | 4 - .../core/IResourceConfiguration.java | 23 +-- .../managedbuilder/core/IResourceInfo.java | 9 - .../cdt/managedbuilder/core/ITarget.java | 26 --- .../managedbuilder/core/ITargetPlatform.java | 11 +- .../cdt/managedbuilder/core/ITool.java | 57 +----- .../cdt/managedbuilder/core/IToolChain.java | 47 ++--- .../managedbuilder/core/IToolReference.java | 8 +- .../core/ManagedBuildManager.java | 6 - .../core/ManagedCProjectNature.java | 7 +- .../core/OptionStringValue.java | 12 -- .../buildmodel/BuildProcessManager.java | 3 +- .../internal/buildmodel/ParallelBuilder.java | 4 - .../internal/core/AdditionalInput.java | 7 +- .../managedbuilder/internal/core/Builder.java | 13 +- .../internal/core/CommonBuilder.java | 11 -- .../internal/core/ConfigurationV2.java | 11 -- .../core/DefaultManagedConfigElement.java | 6 - .../core/GeneratedMakefileBuilder.java | 16 -- .../internal/core/HoldsOptions.java | 23 +-- .../internal/core/InputOrder.java | 10 +- .../internal/core/InputType.java | 2 - .../internal/core/ManagedBuildInfo.java | 62 +------ .../internal/core/ManagedProject.java | 3 - .../internal/core/MultiConfiguration.java | 1 - .../managedbuilder/internal/core/Option.java | 1 - .../internal/core/OptionCategory.java | 7 +- .../internal/core/OptionReference.java | 23 --- .../internal/core/OutputType.java | 13 +- .../internal/core/ProjectType.java | 27 +-- .../internal/core/ResourceConfiguration.java | 11 +- .../managedbuilder/internal/core/Target.java | 47 +---- .../internal/core/TargetPlatform.java | 15 +- .../managedbuilder/internal/core/Tool.java | 11 -- .../internal/core/ToolChain.java | 2 - .../internal/core/ToolReference.java | 5 - .../internal/macros/BuildMacroProvider.java | 34 +--- .../macros/BuildfileMacroSubstitutor.java | 2 +- .../macros/BuildMacroException.java | 52 +++--- .../macros/IBuildMacroProvider.java | 12 +- .../IManagedBuilderMakefileGenerator.java | 19 -- ...faultGCCDependencyCalculator3Commands.java | 2 +- ...CDependencyCalculatorPreBuildCommands.java | 2 +- .../makegen/gnu/GnuMakefileGenerator.java | 175 ++++++------------ .../UpdateManagedProject20.java | 1 - .../UpdateManagedProject21.java | 1 - .../UpdateManagedProject30.java | 1 - .../IApplicableModification.java | 1 - .../IConfigurationModification.java | 19 +- .../IFolderInfoModification.java | 15 +- .../IModificationOperation.java | 3 - .../IToolChainModificationManager.java | 6 - .../tcmodification/IToolListModification.java | 9 +- .../tcmodification/IToolModification.java | 7 - .../templateengine/ProjectCreatedActions.java | 6 - .../processes/NewManagedProject.java | 4 - .../cdt/newmake/core/MakeScannerProvider.java | 6 +- 80 files changed, 228 insertions(+), 1023 deletions(-) diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigNature.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigNature.java index 6e83967ca12..0129f2bc4d6 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigNature.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/core/scannerconfig/ScannerConfigNature.java @@ -120,10 +120,6 @@ public class ScannerConfigNature implements IProjectNature { /** * Returns build command as stored in .project file - * - * @param description - * @param builderID - * @return ICommand */ public static ICommand getBuildSpec(IProjectDescription description, String builderID) { ICommand[] commands = description.getBuildSpec(); @@ -137,10 +133,6 @@ public class ScannerConfigNature implements IProjectNature { /** * Stores a build command in .project file - * - * @param description - * @param newCommand - * @return IProjecDescription */ public static IProjectDescription setBuildSpec(IProjectDescription description, ICommand newCommand) { ICommand[] oldCommands = description.getBuildSpec(); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/jobs/CfgSCJobsUtil.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/jobs/CfgSCJobsUtil.java index ca8309a9ca4..48ff6fd253a 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/jobs/CfgSCJobsUtil.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/build/internal/core/scannerconfig/jobs/CfgSCJobsUtil.java @@ -65,10 +65,6 @@ public class CfgSCJobsUtil { /** * Call ESI providers to get scanner info - * - * @param collector - * @param buildInfo - * @param monitor */ public static SCProfileInstance getProviderScannerInfo(final IProject project, final CfgInfoContext context, @@ -121,10 +117,6 @@ public class CfgSCJobsUtil { /** * Update and persist scanner configuration - * - * @param project - * @param buildInfo - * @param monitor */ public static boolean updateScannerConfiguration(IProject project, CfgInfoContext context, diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/BuildDescriptionManager.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/BuildDescriptionManager.java index 739f19e1754..22f27693c87 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/BuildDescriptionManager.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/BuildDescriptionManager.java @@ -256,7 +256,6 @@ public class BuildDescriptionManager { * cleans the resources to be rebuilt * * @param des build description - * @throws CoreException */ public static void cleanGeneratedRebuildResources(IBuildDescription des) throws CoreException{ IBuildResource bRcs[] = filterGeneratedBuildResources(des.getResources(), REMOVED | REBUILD); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildDescription.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildDescription.java index a00d5f9cce3..5c5f69b6550 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildDescription.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildDescription.java @@ -43,8 +43,6 @@ public interface IBuildDescription { /** * Returns the Build resource for the given resource location * - * @param location - * * @return the IBuildResource or null if not found */ IBuildResource getBuildResource(IPath location); @@ -52,8 +50,6 @@ public interface IBuildDescription { /** * Returns the Build resource for the given resource * - * @param location - * * @return the IBuildResource or null if not found */ IBuildResource getBuildResource(IResource resource); @@ -93,8 +89,7 @@ public interface IBuildDescription { URI getDefaultBuildDirLocationURI(); /** - * The Workspace FullPath of the build directory - * @return + * @return The Workspace FullPath of the build directory */ IPath getDefaultBuildDirFullPath(); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildResource.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildResource.java index 3d8c4d678fb..00063c22c2e 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildResource.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildResource.java @@ -52,7 +52,7 @@ public interface IBuildResource { * In case the resource is the project source, * The returned output io type belongs to the main input step * - * @see IBuildRepresentation.getInputStep() + * @see IBuildDescription#getInputStep() * * @return IBuildIOType */ @@ -70,7 +70,7 @@ public interface IBuildResource { * In case the resource is the project source, * The main input step is returned * - * @see IBuildRepresentation.getInputStep() + * @see IBuildDescription#getInputStep() * * @return IBuildIOType */ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildStep.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildStep.java index 520e67fb0c6..6cdf69432a0 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildStep.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IBuildStep.java @@ -76,16 +76,8 @@ public interface IBuildStep { IBuildDescription getBuildDescription(); /** - * - * Returns the set of commands used for building the step - * + * @return the set of commands used for building the step * NOTE: This is a preliminary method - * - * @param cwd - * @param inStepMap - * @param outStepMap - * @param resolveAll - * @return */ IBuildCommand[] getCommands(IPath cwd, Map inStepMap, Map outStepMap, boolean resolveAll); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IStepVisitor.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IStepVisitor.java index 1393f4d4d85..e9c09b18f1d 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IStepVisitor.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/buildmodel/IStepVisitor.java @@ -43,10 +43,6 @@ public interface IStepVisitor { * @see IStepVisitor#VISIT_CONTINUE * @see IStepVisitor#VISIT_STOP * @see BuildDescriptionManager#accept(IStepVisitor, IBuildDescription, boolean) - * - * @param step - * @return int - * @throws CoreException */ int visit(IBuildStep step) throws CoreException; } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IAdditionalInput.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IAdditionalInput.java index 215179e8d6a..7d3e28afd27 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IAdditionalInput.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IAdditionalInput.java @@ -52,10 +52,8 @@ public interface IAdditionalInput { public String[] getPaths(); /** - * Sets semi-colon separated list of the relative or absolute paths of the resources to + * Sets semicolon separated list of the relative or absolute paths of the resources to * which this element applies. - * - * @param paths */ public void setPaths(String paths); @@ -83,8 +81,6 @@ public interface IAdditionalInput { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IBuilder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IBuilder.java index 69ad4ae8849..d60995e093e 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IBuilder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IBuilder.java @@ -193,16 +193,12 @@ public interface IBuilder extends IBuildObject, IMakeBuilderInfo { /** * Sets the arguments to be passed to the build utility used by the * receiver to produce a build goal. - * - * @param makeArgs */ public void setArguments(String makeArgs); /** * Sets the BuildFileGenerator plugin.xml element * - * @param element - * * @deprecated as of CDT 4.0 */ @Deprecated @@ -210,29 +206,21 @@ public interface IBuilder extends IBuildObject, IMakeBuilderInfo { /** * Sets the build command for the receiver to the value in the argument. - * - * @param command */ public void setCommand(String command); /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); /** * Sets the semicolon separated list of error parser ids - * - * @param ids */ public void setErrorParserIds(String ids); /** * Sets the isAbstract attribute of the builder. - * - * @param b */ public void setIsAbstract(boolean b); @@ -254,16 +242,12 @@ public interface IBuilder extends IBuildObject, IMakeBuilderInfo { /** * Sets the 'versionsSupported' attribute of the builder. - * - * @param versionsSupported */ public void setVersionsSupported(String versionsSupported); /** * Sets the 'convertToId' attribute of the builder. - * - * @param convertToId */ public void setConvertToId(String convertToId); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java index 383f791e652..8b7f0499dce 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfiguration.java @@ -68,16 +68,11 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont /** * Sets the description of the receiver to the value specified in the argument - * - * @param description */ public void setDescription(String description); /** * Creates a child resource configuration corresponding to the passed in file. - * - * @param file - * @return IResourceConfiguration */ public IResourceConfiguration createResourceConfiguration(IFile file); @@ -347,59 +342,43 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont /** * Set (override) the extension that should be appended to the build artifact * for the receiver. - * - * @param extension */ public void setArtifactExtension(String extension); /** * Set the name of the artifact that will be produced when the receiver * is built. - * - * @param name */ public void setArtifactName(String name); /** * Sets the arguments to be passed to the build utility used by the * receiver to produce a build goal. - * - * @param makeArgs */ public void setBuildArguments(String makeArgs); /** * Sets the build command for the receiver to the value in the argument. - * - * @param command */ public void setBuildCommand(String command); /** * Sets the prebuild step for the receiver to the value in the argument. - * - * @param step */ public void setPrebuildStep(String step); /** * Sets the postbuild step for the receiver to the value in the argument. - * - * @param step */ public void setPostbuildStep(String step); /** * Sets the prebuild step display string for the receiver to the value in the argument. - * - * @param announceStep */ public void setPreannouncebuildStep(String announceStep); /** * Sets the postbuild step display string for the receiver to the value in the argument. - * - * @param announceStep */ public void setPostannouncebuildStep(String announceStep); @@ -411,15 +390,11 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); /** * Sets the semicolon separated list of error parser ids - * - * @param ids */ public void setErrorParserIds(String ids); @@ -427,8 +402,6 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont /** * Sets the name of the receiver to the value specified in the argument - * - * @param name */ public void setName(String name); @@ -441,8 +414,6 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont * * @return IOption The modified option. This can be the same option or a newly created option. * - * @throws BuildException - * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ @@ -458,8 +429,6 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont * * @return IOption The modified option. This can be the same option or a newly created option. * - * @throws BuildException - * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ @@ -475,8 +444,6 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont * * @return IOption The modified option. This can be the same option or a newly created option. * - * @throws BuildException - * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfigurationV2.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfigurationV2.java index a13fe1d0a88..95f8ccf822b 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfigurationV2.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IConfigurationV2.java @@ -43,22 +43,17 @@ public interface IConfigurationV2 extends IBuildObject { ITool[] getFilteredTools(IProject project); /** - * Returns the resource that owns the project that owns the configuration. - * @return + * @return the resource that owns the project that owns the configuration. */ public IResource getOwner(); /** - * Answers the configuration that this configuration is based on. - * - * @return + * @return the configuration that this configuration is based on. */ public IConfigurationV2 getParent(); /** - * Returns the target for this configuration. - * - * @return + * @return the target for this configuration. */ public ITarget getTarget(); @@ -79,9 +74,7 @@ public interface IConfigurationV2 extends IBuildObject { public ITool[] getTools(); /** - * Returns the tool references that are children of this configuration. - * - * @return + * @return the tool references that are children of this configuration. */ public IToolReference[] getToolReferences(); @@ -104,15 +97,13 @@ public interface IConfigurationV2 extends IBuildObject { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); /** * Sets the name of the receiver to the value specified in the argument * - * @param name + * @param name new name */ public void setName(String name); @@ -121,8 +112,6 @@ public interface IConfigurationV2 extends IBuildObject { * * @param option The option to change. * @param value The value to apply to the option. - * - * @throws BuildException */ public void setOption(IOption option, boolean value) throws BuildException; @@ -132,8 +121,6 @@ public interface IConfigurationV2 extends IBuildObject { * * @param option The option that will be effected by change. * @param value The value to apply to the option. - * - * @throws BuildException */ public void setOption(IOption option, String value) throws BuildException; @@ -143,8 +130,6 @@ public interface IConfigurationV2 extends IBuildObject { * * @param option The option to change. * @param value The values to apply to the option. - * - * @throws BuildException */ public void setOption(IOption option, String[] value) throws BuildException; @@ -167,8 +152,6 @@ public interface IConfigurationV2 extends IBuildObject { /** * Sets the configuration that was created from this V2.0 configuration. - * - * @param config */ public void setCreatedConfig(IConfiguration config); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IFolderInfo.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IFolderInfo.java index 4a8e32eed9c..009017e1063 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IFolderInfo.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IFolderInfo.java @@ -44,7 +44,7 @@ public interface IFolderInfo extends IResourceInfo { * Returns a ITool for the tool associated with the * input extension. * - * @param extension the file extension of the input file + * @param sourceExtension the file extension of the input file * @return ITool * * @since 3.1 diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IHoldsOptions.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IHoldsOptions.java index 3cba255cb2d..1bc6baf15ba 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IHoldsOptions.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IHoldsOptions.java @@ -32,10 +32,10 @@ public interface IHoldsOptions extends IBuildObject { /** * Creates a child Option * - * @param Option The superClass, if any - * @param String The id for the new option - * @param String The name for the new option - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new option + * @param name The name for the new option + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return IOption */ @@ -43,8 +43,6 @@ public interface IHoldsOptions extends IBuildObject { /** * Removes an option. - * - * @param option */ public void removeOption(IOption option); @@ -52,7 +50,7 @@ public interface IHoldsOptions extends IBuildObject { * This is a deprecated method for retrieving an IOption from * the receiver based on an ID. It is preferred that you use the newer method * getOptionById - * @see org.eclipse.cdt.core.build.managed.IHoldsOptions#getOptionById(java.lang.String) + * @see IHoldsOptions#getOptionById(java.lang.String) * * @param id unique identifier of the option to search for * @return IOption @@ -137,7 +135,7 @@ public interface IHoldsOptions extends IBuildObject { * Each individual option in superclass, will become the superclass for * the new option. * - * @param IHoldsOptions The superClass + * @param superClass The superClass * @since 3.0 */ public void createOptions(IHoldsOptions superClass); @@ -146,7 +144,7 @@ public interface IHoldsOptions extends IBuildObject { * This method should be called in order to obtain the option whose value and attributes could be directly changed/adjusted * - * @param id -the option to be modified + * @param option -the option to be modified * @param adjustExtension - if false, modifications are to be made for the non-extension element * (only for some particular configuration associated with some eclipse project) * This is the most common use of this method. @@ -167,7 +165,6 @@ public interface IHoldsOptions extends IBuildObject { /** * sets the holder rebuild state - * @param rebuild */ public void setRebuildState(boolean rebuild); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputOrder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputOrder.java index 5a3cc69bbdf..5db1e8b70aa 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputOrder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputOrder.java @@ -45,8 +45,6 @@ public interface IInputOrder { /** * Sets the relative or absolute path of the resource to which this element applies. - * - * @param path */ public void setPath(String path); @@ -66,8 +64,6 @@ public interface IInputOrder { /** * Sets the comma-separated list of integer values that specify the order of this resource. - * - * @param order */ public void setOrder(String order); @@ -80,8 +76,6 @@ public interface IInputOrder { /** * Sets whether this resource is not used as an input for the tool. - * - * @param excluded */ public void setExcluded(boolean excluded); @@ -95,8 +89,6 @@ public interface IInputOrder { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputType.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputType.java index e7c87e75e08..0738d05952c 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputType.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IInputType.java @@ -303,8 +303,6 @@ public interface IInputType extends IBuildObject { * Sets the id of the option that is associated with this input type on * the command line. If specified, the name(s) of the input files for * this input type are taken from the value specified for the option. - * - * @param optionId */ public void setOptionId(String optionId); @@ -329,8 +327,6 @@ public interface IInputType extends IBuildObject { * option value is only updated during build file generation and therefore * could be out of sync with the project until build file generation * occurs. - * - * @param optionId */ public void setAssignToOptionId(String optionId); @@ -345,8 +341,6 @@ public interface IInputType extends IBuildObject { /** * Sets whether this inputType can contain multiple input resources - * - * @param multiple */ public void setMultipleOfType(boolean multiple); @@ -360,8 +354,6 @@ public interface IInputType extends IBuildObject { /** * Sets whether this inputType is considered the primary input of the tool - * - * @param primary */ public void setPrimaryInput(boolean primary); @@ -410,8 +402,6 @@ public interface IInputType extends IBuildObject { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedBuildInfo.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedBuildInfo.java index c48675ed537..b3d87498484 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedBuildInfo.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedBuildInfo.java @@ -72,9 +72,6 @@ public interface IManagedBuildInfo { * @param sourceExtension - source extension * @param flags - build flags * @param outputFlag - output flag for build tool - * @param outputPrefix - * @param outputName - * @param inputResources * @return IManagedCommandLineInfo * * @deprecated - use generateToolCommandLineInfo instead @@ -92,16 +89,6 @@ public interface IManagedBuildInfo { * chosen to keep the environment build macros unresolved, the command line info contains values contain * the environment macro references converted to the buildfile variable format, * all other macro references are resolved - * - * @param sourceExtension - * @param flags - * @param outputFlag - * @param outputPrefix - * @param outputName - * @param inputResources - * @param inputLocation - * @param outputLocation - * @return */ public IManagedCommandLineInfo generateToolCommandLineInfo( String sourceExtension, String[] flags, String outputFlag, String outputPrefix, String outputName, String[] inputResources, IPath inputLocation, IPath outputLocation ); @@ -167,8 +154,6 @@ public interface IManagedBuildInfo { /** * Answers the command needed to remove files on the build machine - * - * @return */ public String getCleanCommand(); @@ -195,10 +180,6 @@ public interface IManagedBuildInfo { */ public IConfiguration getDefaultConfiguration(); - /** - * @param sourceExtension - * @return - */ public IManagedDependencyGeneratorType getDependencyGenerator(String sourceExtension); /** @@ -212,9 +193,6 @@ public interface IManagedBuildInfo { * the environment macro references converted to the buildfile variable format, * all other macro references are resolved * - * @param extension - * @return - * * @deprecated - use getToolFlagsForConfiguration */ @Deprecated @@ -230,11 +208,6 @@ public interface IManagedBuildInfo { * chosen to keep the environment build macros unresolved, the string contains * the environment macro references converted to the buildfile variable format, * all other macro references are resolved - * - * @param extension - * @param inputLocation - * @param outputLocation - * @return */ public String getToolFlagsForConfiguration(String extension, IPath inputLocation, IPath outputLocation); @@ -249,9 +222,6 @@ public interface IManagedBuildInfo { * the environment macro references converted to the buildfile variable format, * all other macro references are resolved * - * @param extension - * @return - * * @deprecated - use getToolFlagsForSource */ @Deprecated @@ -267,19 +237,11 @@ public interface IManagedBuildInfo { * chosen to keep the environment build macros unresolved, the string contains * the environment macro references converted to the buildfile variable format, * all other macro references are resolved - * - * @param extension - * @param inputLocation - * @param outputLocation - * @return */ public String getToolFlagsForSource(String extension, IPath inputLocation, IPath outputLocation); /** * Answers the libraries the project links in. - * - * @param extension - * @return */ public String[] getLibsForConfiguration(String extension); @@ -293,9 +255,6 @@ public interface IManagedBuildInfo { /** * Answers the extension that will be built by the current configuration * for the extension passed in the argument or null. - * - * @param resourceExtension - * @return */ public String getOutputExtension(String resourceExtension); @@ -304,9 +263,6 @@ public interface IManagedBuildInfo { * or an empty String if there is no special flag. For example, the * GCC tools use the '-o' flag to produce a named output, for example * gcc -c foo.c -o foo.o - * - * @param outputExt - * @return */ public String getOutputFlag(String outputExt); @@ -315,7 +271,6 @@ public interface IManagedBuildInfo { * artifact. For example, a library foo, should have the prefix 'lib' and * the extension '.a', so the final goal would be 'libfoo.a' * - * @param outputExtension * @return the prefix or an empty string */ public String getOutputPrefix(String outputExtension); @@ -457,36 +412,27 @@ public interface IManagedBuildInfo { public void setDefaultConfiguration(IConfiguration configuration); /** - * @param configName * @return boolean indicating if setDefaultConfiguration was successful */ public boolean setDefaultConfiguration(String configName); /** * Sets the dirty flag for the build model to the value of the argument. - * - * @param isDirty */ public void setDirty(boolean isDirty); /** * Sets the valid flag for the build model to the value of the argument. - * - * @param isValid */ public void setValid(boolean isValid); /** * Sets the ManagedProject associated with this build info - * - * @param project */ public void setManagedProject(IManagedProject project); /** * sets the read only status of Managed Build Info - * - * @param readOnly */ public void setReadOnly(boolean readOnly); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineGenerator.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineGenerator.java index f16231fe603..f3ba81ed1e4 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineGenerator.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineGenerator.java @@ -11,18 +11,6 @@ package org.eclipse.cdt.managedbuilder.core; public interface IManagedCommandLineGenerator { - /** - * - * @param tool - * @param commandNamee - * @param flags - * @param outputFlag - * @param outputPrefix - * @param outputName - * @param inputResources - * @param commandLinePattern - * @return - */ public IManagedCommandLineInfo generateCommandLineInfo( ITool tool, String commandName, String[] flags, String outputFlag, String outputPrefix, String outputName, String[] inputResources, String commandLinePattern ); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineInfo.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineInfo.java index 73b86498ffb..a7f936f48da 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineInfo.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedCommandLineInfo.java @@ -23,43 +23,36 @@ public interface IManagedCommandLineInfo { /** * give command line pattern - * @return */ public String getCommandLinePattern(); /** * provide tool name - * @return */ public String getCommandName(); /** * give command flags - * @return */ public String getFlags(); /** * provide list of resources used by tool for transformation - * @return */ public String getInputs(); /** * return output file name - * @return */ public String getOutput(); /** * give command flag to generate output - * @return */ public String getOutputFlag(); /** * return output prefix - * @return */ public String getOutputPrefix(); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedOutputNameProvider.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedOutputNameProvider.java index 346926d5ced..30f3a59407a 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedOutputNameProvider.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedOutputNameProvider.java @@ -13,11 +13,5 @@ package org.eclipse.cdt.managedbuilder.core; import org.eclipse.core.runtime.IPath; public interface IManagedOutputNameProvider { - /** - * - * @param tool - * @param primaryInputNames - * @return IPath[] - */ public IPath[] getOutputNames( ITool tool, IPath[] primaryInputNames ); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedProject.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedProject.java index b8a95e12074..e0d527e9392 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedProject.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IManagedProject.java @@ -113,8 +113,6 @@ public interface IManagedProject extends IBuildObject, IBuildObjectPropertiesCon /** * Sets the owner of the managed project. - * - * @param resource */ public void updateOwner(IResource resource); @@ -128,8 +126,6 @@ public interface IManagedProject extends IBuildObject, IBuildObjectPropertiesCon /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); @@ -143,17 +139,15 @@ public interface IManagedProject extends IBuildObject, IBuildObjectPropertiesCon /** * Sets the element's "Valid" flag. - * - * @param isValid */ public void setValid(boolean isValid); - /** - * Persist the managed project to the project file (.cdtbuild). - * - * @param doc - * @param element - */ +// /** +// * Persist the managed project to the project file (.cdtbuild). +// * +// * @param doc +// * @param element +// */ // public void serialize(Document doc, Element element); /** diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOption.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOption.java index e8eeb8ade19..4cd39785be5 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOption.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOption.java @@ -161,7 +161,6 @@ public interface IOption extends IBuildObject { /** * @return the value for a boolean option. - * @throws BuildException */ public boolean getBooleanValue() throws BuildException; @@ -237,7 +236,6 @@ public interface IOption extends IBuildObject { /** * Sets the category for this option. - * @param category */ public void setCategory(IOptionCategory category); @@ -298,7 +296,6 @@ public interface IOption extends IBuildObject { /** * @return the user-defined preprocessor symbols. - * @throws BuildException */ public String[] getDefinedSymbols() throws BuildException; @@ -310,38 +307,30 @@ public interface IOption extends IBuildObject { * for the debug level option of the Gnu compiler, and the plugin * manifest defined that as -g, then the return value would be the * String "-g" - * - * @throws BuildException */ public String getEnumCommand (String id) throws BuildException; /** * @param id - enumeration id * @return the "name" associated with the enumeration id. - * - * @throws BuildException */ public String getEnumName (String id) throws BuildException; /** * @param name - a "name" associated with enumeration id * @return enumeration id - * - * @throws BuildException */ public String getEnumeratedId(String name) throws BuildException; /** * @return an array of String containing the includes paths * defined in the build model. - * @throws BuildException */ public String[] getIncludePaths() throws BuildException; /** * @return an array or Strings containing the libraries * that must be linked into the project. - * @throws BuildException */ public String[] getLibraries() throws BuildException ; @@ -349,7 +338,6 @@ public interface IOption extends IBuildObject { * @return an array or Strings containing the library files * that must be linked into the project. * - * @throws BuildException * @since 7.0 */ public String[] getLibraryFiles() throws BuildException ; @@ -367,21 +355,17 @@ public interface IOption extends IBuildObject { /** * @return the current value for this option if it is a List of Strings. - * @throws BuildException */ public String [] getStringListValue() throws BuildException; /** * @return the current value for this option if it is a String - * @throws BuildException */ public String getStringValue() throws BuildException; /** * @return all of the user-defined object files that must be linked with * the final build target. - * - * @throws BuildException */ public String [] getUserObjects() throws BuildException; @@ -399,8 +383,6 @@ public interface IOption extends IBuildObject { /** * @return the type for the value of the option. - * - * @throws BuildException */ public int getValueType() throws BuildException; @@ -408,17 +390,11 @@ public interface IOption extends IBuildObject { * Sets the boolean value of the receiver to the value specified in the argument. * If the receiver is not a reference to a boolean option, method will throw an * exception. - * - * @param value - * @throws BuildException */ public void setValue(boolean value) throws BuildException; /** * Sets the string value of the receiver to the value specified in the argument. - * - * @param value - * @throws BuildException */ public void setValue(String value) throws BuildException; @@ -426,7 +402,6 @@ public interface IOption extends IBuildObject { * Sets the value of the receiver to be an array of strings. * * @param value An array of strings to place in the option reference. - * @throws BuildException */ public void setValue(String [] value) throws BuildException; @@ -448,8 +423,6 @@ public interface IOption extends IBuildObject { /** * Sets the value-type of this option. Use with care. - * - * @param type */ public void setValueType(int type); @@ -467,7 +440,6 @@ public interface IOption extends IBuildObject { /** * Sets the value handlers extra argument specified for this tool - * @param extraArgument * @since 3.0 */ public void setValueHandlerExtraArgument(String extraArgument); @@ -501,16 +473,12 @@ public interface IOption extends IBuildObject { * {@link IOption#INCLUDE_PATH}, {@link IOption#PREPROCESSOR_SYMBOLS}, {@link IOption#LIBRARIES}, * {@link IOption#OBJECTS}, {@link IOption#INCLUDE_FILES}, {@link IOption#LIBRARY_PATHS}, * {@link IOption#LIBRARY_FILES}, {@link IOption#MACRO_FILES} - * - * @throws BuildException */ int getBasicValueType() throws BuildException ; /** * @return in case the option basic value type is STRING_LIST, returns the String list value, * throws BuildException otherwise - * - * @throws BuildException */ String[] getBasicStringListValue() throws BuildException; diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOptionCategory.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOptionCategory.java index c7fcd75dd43..f0cb3292e4b 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOptionCategory.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOptionCategory.java @@ -31,8 +31,6 @@ public interface IOptionCategory extends IBuildObject { /** * Returns the list of children of this node in the option category tree - * - * @return */ public IOptionCategory[] getChildCategories(); @@ -40,9 +38,6 @@ public interface IOptionCategory extends IBuildObject { * Returns an array of ITool/IOption pairs for the options in this category * for a given configuration. * - * @param tool - * @return Object[][] - * * @since 3.1 */ public Object[][] getOptions(IConfiguration configuration, IHoldsOptions optHolder); @@ -52,21 +47,24 @@ public interface IOptionCategory extends IBuildObject { @Deprecated public Object[][] getOptions(IConfiguration configuration); +// /** +// * Returns an array of ITool/IOption pairs for the options in this category +// * for a given resource configuration. +// * +// * @since 3.1 +// */ +// public Object[][] getOptions(IResourceConfiguration resConfig, IHoldsOptions optHolder); + /** * Returns an array of ITool/IOption pairs for the options in this category * for a given resource configuration. * - * @param tool - * @return Object[][] - * * @since 3.1 */ -// public Object[][] getOptions(IResourceConfiguration resConfig, IHoldsOptions optHolder); - public Object[][] getOptions(IResourceInfo resInfo, IHoldsOptions optHolder); /** - * @deprecated since 3.1 - use getOption with IHoldsOptions aregument instead + * @deprecated since 3.1 - use getOption with IHoldsOptions argument instead */ @Deprecated public Object[][] getOptions(IResourceConfiguration resConfig); @@ -74,8 +72,6 @@ public interface IOptionCategory extends IBuildObject { /** * Returns the category that owns this category, or null if this is the * top category for a tool. - * - * @return */ public IOptionCategory getOwner(); @@ -83,7 +79,6 @@ public interface IOptionCategory extends IBuildObject { * Returns the tool that ultimately owns this category. * If owned by a toolChain return null. * - * @return * @deprecated since 3.0 - use getOptionHolder() instead */ @Deprecated @@ -122,8 +117,6 @@ public interface IOptionCategory extends IBuildObject { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOutputType.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOutputType.java index e74d9a91e10..1a65a5d2b5c 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOutputType.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IOutputType.java @@ -84,8 +84,6 @@ public interface IOutputType extends IBuildObject { * NOTE: The value of this attribute will NOT be used if a * output content type is specified and is registered with * Eclipse. - * - * @param String */ public void setOutputExtensionsAttribute(String extensions); @@ -125,8 +123,6 @@ public interface IOutputType extends IBuildObject { /** * Sets the id of the option that is associated with this * output type on the command line. - * - * @param optionId */ public void setOptionId(String optionId); @@ -141,8 +137,6 @@ public interface IOutputType extends IBuildObject { /** * Sets whether this outputType can create multiple output resources in * one invocation of the tool. - * - * @param multiple */ public void setMultipleOfType(boolean multiple); @@ -157,8 +151,6 @@ public interface IOutputType extends IBuildObject { /** * Sets the input type that is used in determining the default * names of this output type. - * - * @param inputType */ public void setPrimaryInputType(IInputType contentType); @@ -172,8 +164,6 @@ public interface IOutputType extends IBuildObject { /** * Sets whether this is the primary output of the tool. - * - * @param primary */ public void setPrimaryOutput(boolean primary); @@ -187,7 +177,6 @@ public interface IOutputType extends IBuildObject { /** * Sets the prefix that the tool should prepend to the name of the build artifact. * For example, a librarian usually prepends 'lib' to the target.a - * @param String */ public void setOutputPrefix(String prefix); @@ -200,8 +189,6 @@ public interface IOutputType extends IBuildObject { /** * Sets the complete set of output file names for this outputType - * - * @param names */ public void setOutputNames(String names); @@ -263,8 +250,6 @@ public interface IOutputType extends IBuildObject { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IProjectType.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IProjectType.java index b9f238b6c8a..1eea850c358 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IProjectType.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IProjectType.java @@ -118,8 +118,6 @@ public interface IProjectType extends IBuildObject, IBuildObjectPropertiesContai /** * Sets the isAbstract attribute of the tool-chain. - * - * @param b */ public void setIsAbstract(boolean b); @@ -182,8 +180,6 @@ public interface IProjectType extends IBuildObject, IBuildObjectPropertiesContai /** * Sets the 'convertToId' attribute of the project type. - * - * @param convertToId */ public void setConvertToId(String convertToId); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java index d2a8c18b112..36304d7e71e 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceConfiguration.java @@ -83,8 +83,6 @@ public interface IResourceConfiguration extends IResourceInfo { /** * Sets the new value representing the users desire for ordering the application of * a resource custom build step tool. - * - * @param int */ public void setRcbsApplicability(int value); @@ -92,8 +90,6 @@ public interface IResourceConfiguration extends IResourceInfo { * Sets the "excluded" flag for the resource. * If true, the project resource identified by the resoursePath * attribute is excluded from the build of the parent configuration. - * - * @param boolean */ public void setExclude(boolean excluded); @@ -112,8 +108,6 @@ public interface IResourceConfiguration extends IResourceInfo { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); @@ -135,18 +129,16 @@ public interface IResourceConfiguration extends IResourceInfo { /** * Removes the Tool from the Tool list and map - * - * @param Tool */ public void removeTool(ITool tool); /** * Creates a Tool child for this resource configuration. * - * @param ITool The superClass, if any - * @param String The id for the new tool chain - * @param String The name for the new tool chain - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new tool chain + * @param name The name for the new tool chain + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return ITool */ @@ -169,8 +161,6 @@ public interface IResourceConfiguration extends IResourceInfo { * * @return IOption The modified option. This can be the same option or a newly created option. * - * @throws BuildException - * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ @@ -186,8 +176,6 @@ public interface IResourceConfiguration extends IResourceInfo { * * @return IOption The modified option. This can be the same option or a newly created option. * - * @throws BuildException - * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ @@ -203,8 +191,6 @@ public interface IResourceConfiguration extends IResourceInfo { * * @return IOption The modified option. This can be the same option or a newly created option. * - * @throws BuildException - * * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions. * Code assuming ITool as type, will continue to work unchanged. */ @@ -228,7 +214,6 @@ public interface IResourceConfiguration extends IResourceInfo { /** * sets the resource configuration rebuild state - * @param rebuild */ void setRebuildState(boolean rebuild); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceInfo.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceInfo.java index 2e4e465c1e4..982657ed13f 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceInfo.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IResourceInfo.java @@ -73,9 +73,6 @@ public interface IResourceInfo extends IBuildObject { * @param value The value to apply to the option. * * @return IOption The modified option. This can be the same option or a newly created option. - * - * @throws BuildException - * */ public IOption setOption(IHoldsOptions parent, IOption option, boolean value) throws BuildException; @@ -88,9 +85,6 @@ public interface IResourceInfo extends IBuildObject { * @param value The value to apply to the option. * * @return IOption The modified option. This can be the same option or a newly created option. - * - * @throws BuildException - * */ public IOption setOption(IHoldsOptions parent, IOption option, String value) throws BuildException; @@ -103,9 +97,6 @@ public interface IResourceInfo extends IBuildObject { * @param value The values to apply to the option. * * @return IOption The modified option. This can be the same option or a newly created option. - * - * @throws BuildException - * */ public IOption setOption(IHoldsOptions parent, IOption option, String[] value) throws BuildException; diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITarget.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITarget.java index 42c6934aca3..29a24c01f6c 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITarget.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITarget.java @@ -75,9 +75,6 @@ public interface ITarget extends IBuildObject { */ public String getArtifactName(); - /** - * @param isDirty - */ public void setDirty(boolean isDirty); /** @@ -129,8 +126,6 @@ public interface ITarget extends IBuildObject { /** * Answers the command line arguments to pass to the make utility used * by the receiver to build a project. - * - * @return */ public String getMakeArguments(); @@ -143,9 +138,6 @@ public interface ITarget extends IBuildObject { /** * Returns the configuration with the given id, or null if not found. - * - * @param id - * @return IConfigurationV2 */ public IConfigurationV2 getConfiguration(String id); @@ -188,9 +180,6 @@ public interface ITarget extends IBuildObject { /** * Answers the tool in the receiver with the ID specified in the argument, * or null - * - * @param id - * @return */ public ITool getTool(String id); @@ -236,46 +225,34 @@ public interface ITarget extends IBuildObject { /** * Removes the configuration with the ID specified in the argument. - * - * @param id */ public void removeConfiguration(String id); /** * Set (override) the extension that should be appended to the build artifact * for the receiver. - * - * @param extension */ public void setArtifactExtension(String extension); /** * Set the name of the artifact that will be produced when the receiver * is built. - * - * @param name */ public void setArtifactName(String name); /** * Sets the arguments to be passed to the make utility used by the * receiver to produce a build goal. - * - * @param makeArgs */ public void setMakeArguments(String makeArgs); /** * Sets the make command for the receiver to the value in the argument. - * - * @param command */ public void setMakeCommand(String command); /** * Sets the semicolon separated list of error parser ids - * - * @param ids */ public void setErrorParserIds(String ids); @@ -289,15 +266,12 @@ public interface ITarget extends IBuildObject { /** * Sets the resource that owns the receiver. - * - * @param resource */ public void updateOwner(IResource resource); /** * Converts a CDT V2.0 target into a ProjectType + Configuration + Toolchain + * Builder + TargetPlatform. - * @param managedBuildRevision */ public void convertToProjectType(String managedBuildRevision); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITargetPlatform.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITargetPlatform.java index 77d2a875e84..cb5ea9b07b0 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITargetPlatform.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITargetPlatform.java @@ -53,8 +53,6 @@ public interface ITargetPlatform extends IBuildObject { /** * Sets the isAbstract attribute of the target paltform. - * - * @param b */ public void setIsAbstract(boolean b); @@ -76,7 +74,7 @@ public interface ITargetPlatform extends IBuildObject { /** * Sets the OS list. * - * @param String[] The list of OS names + * @param OSs The list of OS names */ public void setOSList(String[] OSs); @@ -90,7 +88,7 @@ public interface ITargetPlatform extends IBuildObject { /** * Sets the architecture list. * - * @param String[] The list of architecture names + * @param archs The list of architecture names */ public void setArchList(String[] archs); @@ -113,7 +111,6 @@ public interface ITargetPlatform extends IBuildObject { /** * Sets the string id of the binary parser for this target platform. * - * @param id * @deprecated Use setBinaryParserList */ @Deprecated @@ -121,8 +118,6 @@ public interface ITargetPlatform extends IBuildObject { /** * Sets the string ids of the binary parsers for this target platform. - * - * @param ids */ public void setBinaryParserList(String[] ids); @@ -136,8 +131,6 @@ public interface ITargetPlatform extends IBuildObject { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITool.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITool.java index 9fa7b0ed88c..41430dc0c1b 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITool.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ITool.java @@ -69,10 +69,10 @@ public interface ITool extends IHoldsOptions { /** * Creates a child InputType for this tool. * - * @param InputType The superClass, if any - * @param String The id for the new InputType - * @param String The name for the new InputType - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new InputType + * @param name The name for the new InputType + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return IInputType * @since 3.0 @@ -82,7 +82,6 @@ public interface ITool extends IHoldsOptions { /** * Removes an InputType from the tool's list. * - * @param type * @since 3.0 */ public void removeInputType(IInputType type); @@ -159,10 +158,10 @@ public interface ITool extends IHoldsOptions { /** * Creates a child OutputType for this tool. * - * @param OutputType The superClass, if any - * @param String The id for the new OutputType - * @param String The name for the new OutputType - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new OutputType + * @param name The name for the new OutputType + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return IOutputType * @since 3.0 @@ -172,7 +171,6 @@ public interface ITool extends IHoldsOptions { /** * Removes an OutputType from the tool's list. * - * @param type * @since 3.0 */ public void removeOutputType(IOutputType type); @@ -244,8 +242,6 @@ public interface ITool extends IHoldsOptions { /** * Sets the isAbstract attribute of the tool-chain. - * - * @param b */ public void setIsAbstract(boolean b); @@ -275,8 +271,6 @@ public interface ITool extends IHoldsOptions { /** * Sets the semicolon separated list of error parser ids - * - * @param ids */ public void setErrorParserIds(String ids); @@ -390,8 +384,6 @@ public interface ITool extends IHoldsOptions { * Sets all of the output extensions that the receiver can build, * into the outputs attribute. Note that the outputs attribute is * ignored when one or more outputTypes are specified. - * - * @param String */ public void setOutputsAttribute(String extensions); @@ -408,8 +400,6 @@ public interface ITool extends IHoldsOptions { * Sets the argument that must be passed to a specific tool in order to * control the name of the output artifact. For example, the GCC compile and * linker use '-o', while the archiver does not. - * - * @param String */ public void setOutputFlag(String flag); @@ -423,8 +413,8 @@ public interface ITool extends IHoldsOptions { /** * Sets the prefix that the tool should prepend to the name of the build artifact. * For example, a librarian usually prepends 'lib' to the target.a - * @param String - * @see {@link #setOutputPrefixForPrimaryOutput(String)} + * + * @see #setOutputPrefixForPrimaryOutput(String) */ public void setOutputPrefix(String prefix); @@ -443,8 +433,6 @@ public interface ITool extends IHoldsOptions { * Sets whether the Tool wants the MBS to display the Advanced * Input category that allows the user to specify additional input resources and * dependencies. - * - * @param display */ public void setAdvancedInputCategory(boolean display); @@ -458,8 +446,6 @@ public interface ITool extends IHoldsOptions { /** * Sets whether the Tool represents a user-define custom build step. - * - * @param customBuildStep */ public void setCustomBuildStep(boolean customBuildStep); @@ -471,7 +457,6 @@ public interface ITool extends IHoldsOptions { /** * Sets the announcement string for this tool - * @param announcement */ public void setAnnouncement(String announcement); @@ -485,8 +470,6 @@ public interface ITool extends IHoldsOptions { /** * Sets the command-line invocation command defined for this tool. * - * @param String - * * @return boolean if true, then the tool command was modified */ public boolean setToolCommand(String command); @@ -499,7 +482,6 @@ public interface ITool extends IHoldsOptions { /** * Sets the command line pattern for this tool - * @param String */ public void setCommandLinePattern(String pattern); @@ -544,9 +526,6 @@ public interface ITool extends IHoldsOptions { * the environment macro references converted to the buildfile variable format, * all other macro references are resolved * - * @return String[] - * @throws BuildException - * * @deprecated - use getToolCommandFlags instead */ @Deprecated @@ -578,11 +557,6 @@ public interface ITool extends IHoldsOptions { * chosen to keep the environment build macros unresolved, the flags contain * the environment macro references converted to the buildfile variable format, * all other macro references are resolved - * - * @param inputFileLocation - * @param outputFileLocation - * @return - * @throws BuildException */ public String[] getToolCommandFlags(IPath inputFileLocation, IPath outputFileLocation) throws BuildException; @@ -595,11 +569,6 @@ public interface ITool extends IHoldsOptions { * chosen to keep the environment build macros unresolved, the string contains * the environment macro references converted to the buildfile variable format, * all other macro references are resolved - * - * @param inputFileLocation - * @param outputFileLocation - * @return - * @throws BuildException */ public String getToolCommandFlagsString(IPath inputFileLocation, IPath outputFileLocation) throws BuildException; @@ -660,8 +629,6 @@ public interface ITool extends IHoldsOptions { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); @@ -689,15 +656,11 @@ public interface ITool extends IHoldsOptions { /** * Sets the 'versionsSupported' attribute of the tool. - * - * @param versionsSupported */ public void setVersionsSupported(String versionsSupported); /** * Sets the 'convertToId' attribute of the tool. - * - * @param convertToId */ public void setConvertToId(String convertToId); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java index 85cd6082474..57cba447fca 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolChain.java @@ -63,10 +63,10 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Creates the TargetPlatform child of this tool-chain. * - * @param ITargetPlatform The superClass, if any - * @param String The id for the new tool chain - * @param String The name for the new tool chain - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new tool chain + * @param name The name for the new tool chain + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return ITargetPlatform */ @@ -102,26 +102,22 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the 'versionsSupported' attribute of the tool-chain. - * - * @param versionsSupported */ public void setVersionsSupported(String versionsSupported); /** * Sets the 'convertToId' attribute of the tool-chain. - * - * @param convertToId */ public void setConvertToId(String convertToId); /** * Creates the Builder child of this tool-chain. * - * @param IBuilder The superClass, if any - * @param String The id for the new tool chain - * @param String The name for the new tool chain - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new tool chain + * @param name The name for the new tool chain + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return IBuilder */ @@ -143,10 +139,10 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Creates a Tool child of this tool-chain. * - * @param ITool The superClass, if any - * @param String The id for the new tool chain - * @param String The name for the new tool chain - * @param boolean Indicates whether this is an extension element or a managed project element + * @param superClass The superClass, if any + * @param Id The id for the new tool chain + * @param name The name for the new tool chain + * @param isExtensionElement Indicates whether this is an extension element or a managed project element * * @return ITool */ @@ -199,8 +195,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the isAbstract attribute of the tool-chain. - * - * @param b */ public void setIsAbstract(boolean b); @@ -222,7 +216,7 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the OS list. * - * @param String[] The list of OS names + * @param OSs The list of OS names */ public void setOSList(String[] OSs); @@ -236,7 +230,7 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the architecture list. * - * @param String[] The list of architecture names + * @param archs The list of architecture names */ public void setArchList(String[] archs); @@ -251,9 +245,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Returns the semicolon separated list of unique IDs of the error parsers associated * with the tool-chain, filtered for the specified configuration. - * - * @param config - * @return String */ public String getErrorParserIds(IConfiguration config); @@ -267,8 +258,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the semicolon separated list of error parser ids. - * - * @param ids */ public void setErrorParserIds(String ids); @@ -281,8 +270,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the scanner config discovery profile id. - * - * @param profileId */ public void setScannerConfigDiscoveryProfileId(String profileId); @@ -302,8 +289,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { * Sets the sem-colon separated list of Tool ids containing each * tool that can create the final build artifact (the end target of * the build). - * - * @param targetToolIds */ public void setTargetToolIds(String targetToolIds); @@ -332,8 +317,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { * Sets the semicolon separated list of OutputType identifiers in * this tool-chain, besides the primary output of the targetTool, * that are also considered to be build artifacts. - * - * @param ids */ public void setSecondaryOutputs(String ids); @@ -347,8 +330,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions { /** * Sets the element's "dirty" (have I been modified?) flag. - * - * @param isDirty */ public void setDirty(boolean isDirty); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolReference.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolReference.java index 5e4d7ec202f..18a92806dfa 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolReference.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/IToolReference.java @@ -26,9 +26,6 @@ public interface IToolReference extends ITool { /** * Answers a reference to the option. If the reference does not exist, * a new reference is created. - * - * @param option - * @return OptionReference */ public OptionReference createOptionReference(IOption option); @@ -41,8 +38,6 @@ public interface IToolReference extends ITool { /** * Answers the tool that the reference has been created for. - * - * @return */ public ITool getTool(); @@ -57,7 +52,7 @@ public interface IToolReference extends ITool { * Answers true if the reference is a reference to the * tool specified in the argument. * - * @param target the tool that should be tested + * @param tool the tool that should be tested * @return boolean */ public boolean references(ITool tool); @@ -70,7 +65,6 @@ public interface IToolReference extends ITool { /** * Set the tool command in the receiver to be the argument. * - * @param cmd * @return true if the command is changed, else false */ public boolean setToolCommand(String cmd); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java index dba0db378bc..c605dcf68c9 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedBuildManager.java @@ -4485,7 +4485,6 @@ public class ManagedBuildManager extends AbstractCExtension { * Build the specified build configurations * @param configs - configurations to build * @param monitor - progress monitor - * @throws CoreException */ public static void buildConfigurations(IConfiguration[] configs, IProgressMonitor monitor) throws CoreException{ buildConfigurations(configs, null, monitor); @@ -4496,7 +4495,6 @@ public class ManagedBuildManager extends AbstractCExtension { * @param configs - configurations to build * @param builder - builder to retrieve build arguments * @param monitor - progress monitor - * @throws CoreException */ public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor) throws CoreException{ buildConfigurations(configs, builder, monitor, true); @@ -4510,8 +4508,6 @@ public class ManagedBuildManager extends AbstractCExtension { * @param monitor - progress monitor * @param allBuilders - {@code true} if all builders need to be building * or {@code false} to build with {@link CommonBuilder} - * - * @throws CoreException */ public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor, boolean allBuilders) throws CoreException{ buildConfigurations(configs, builder, monitor, allBuilders, IncrementalProjectBuilder.FULL_BUILD); @@ -4530,8 +4526,6 @@ public class ManagedBuildManager extends AbstractCExtension { *
  • {@link IncrementalProjectBuilder#INCREMENTAL_BUILD}
    • *
  • {@link IncrementalProjectBuilder#FULL_BUILD}
    • * - * @throws CoreException - * * @since 7.0 */ public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor, diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedCProjectNature.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedCProjectNature.java index fe00bec6336..aa59e81c128 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedCProjectNature.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/ManagedCProjectNature.java @@ -39,7 +39,7 @@ public class ManagedCProjectNature implements IProjectNature { /** * Utility method for adding a managed nature to a project. * - * @param proj the project to add the managed nature to. + * @param project the project to add the managed nature to. * @param monitor a progress monitor to indicate the duration of the operation, or * null if progress reporting is not required. */ @@ -91,7 +91,7 @@ public class ManagedCProjectNature implements IProjectNature { /** * Utility method for adding a nature to a project. * - * @param proj the project to add the nature to. + * @param project the project to add the nature to. * @param natureId the id of the nature to assign to the project * @param monitor a progress monitor to indicate the duration of the operation, or * null if progress reporting is not required. @@ -190,7 +190,6 @@ public class ManagedCProjectNature implements IProjectNature { * @param project to remove the managed nature from * @param mon progress monitor to indicate the duration of the operation, or * null if progress reporting is not required. - * @throws CoreException */ public static void removeManagedNature(IProject project, IProgressMonitor mon) throws CoreException { removeNature(project, MNG_NATURE_ID, mon); @@ -199,7 +198,7 @@ public class ManagedCProjectNature implements IProjectNature { /** * Utility method for removing a project nature from a project. * - * @param proj the project to remove the nature from + * @param project the project to remove the nature from * @param natureId the nature id to remove * @param monitor a progress monitor to indicate the duration of the operation, or * null if progress reporting is not required. diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/OptionStringValue.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/OptionStringValue.java index 5185529e78f..a7ea619d931 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/OptionStringValue.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/core/OptionStringValue.java @@ -72,12 +72,6 @@ public final class OptionStringValue { /** * source path settings are applicable for the {@link IOption#LIBRARY_FILES} only - * - * @param value - * @param isBuiltIn - * @param srcPath - * @param srcRootPath - * @param srcPrefixMapping */ public OptionStringValue(String value, boolean isBuiltIn, String srcPath, String srcRootPath, String srcPrefixMapping){ if(value == null) @@ -112,8 +106,6 @@ public final class OptionStringValue { * source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only * added to fully support the {@link ICLibraryFileEntry} settings * - * @return - * * @see ICLibraryFileEntry * @see ICLibraryFileEntry#getSourceAttachmentPath() * @see ICLibraryFileEntry#getSourceAttachmentRootPath() @@ -128,8 +120,6 @@ public final class OptionStringValue { * source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only * added to fully support the {@link ICLibraryFileEntry} settings * - * @return - * * @see ICLibraryFileEntry * @see ICLibraryFileEntry#getSourceAttachmentPath() * @see ICLibraryFileEntry#getSourceAttachmentRootPath() @@ -144,8 +134,6 @@ public final class OptionStringValue { * source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only * added to fully support the {@link ICLibraryFileEntry} settings * - * @return - * * @see ICLibraryFileEntry * @see ICLibraryFileEntry#getSourceAttachmentPath() * @see ICLibraryFileEntry#getSourceAttachmentRootPath() diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/BuildProcessManager.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/BuildProcessManager.java index 417d998b2b4..28a31ae2d5a 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/BuildProcessManager.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/BuildProcessManager.java @@ -151,8 +151,7 @@ public class BuildProcessManager { } /** - * - * @return + * @return Number of processors detected */ static public int checkCPUNumber() { if (procNumber > 0) return procNumber; diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/ParallelBuilder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/ParallelBuilder.java index a4be3c287a1..782c3d59075 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/ParallelBuilder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/buildmodel/ParallelBuilder.java @@ -104,9 +104,6 @@ public class ParallelBuilder { /** * Updates level value - * - * @param _step - * @param _level */ public boolean check(IBuildStep _step, int _level) { if (level < _level && step.equals(_step)) { @@ -464,7 +461,6 @@ public class ParallelBuilder { /** * Updates info about generated files (after step completed) - * @param step */ protected void refreshOutputs(IBuildStep step){ IProgressMonitor mon = new NullProgressMonitor(); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/AdditionalInput.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/AdditionalInput.java index 9cee0c101e6..d18194cf021 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/AdditionalInput.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/AdditionalInput.java @@ -58,8 +58,8 @@ public class AdditionalInput implements IAdditionalInput { * This constructor is called to create an AdditionalInput whose attributes and children will be * added by separate calls. * - * @param InputType The parent of the an AdditionalInput - * @param boolean Indicates whether this is an extension element or a managed project element + * @param parent The parent of the an AdditionalInput + * @param isExtensionElement Indicates whether this is an extension element or a managed project element */ public AdditionalInput(InputType parent, boolean isExtensionElement) { this.parent = parent; @@ -162,9 +162,6 @@ public class AdditionalInput implements IAdditionalInput { /** * Persist the AdditionalInput to the project file. - * - * @param doc - * @param element */ public void serialize(ICStorageElement element) { diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Builder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Builder.java index 444b6e323f3..2a99c3f0607 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Builder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/Builder.java @@ -172,11 +172,11 @@ public class Builder extends BuildObject implements IBuilder, IMatchKeyProvider, * This constructor is called to create a Builder whose attributes and children will be * added by separate calls. * - * @param ToolChain The parent of the builder, if any - * @param Builder The superClass, if any - * @param String The id for the new Builder - * @param String The name for the new Builder - * @param boolean Indicates whether this is an extension element or a managed project element + * @param parent The parent of the builder, if any + * @param superClass The superClass, if any + * @param Id The id for the new Builder + * @param name The name for the new Builder + * @param isExtensionElement Indicates whether this is an extension element or a managed project element */ public Builder(ToolChain parent, IBuilder superClass, String Id, String name, boolean isExtensionElement) { this.parent = parent; @@ -754,9 +754,6 @@ public class Builder extends BuildObject implements IBuilder, IMatchKeyProvider, /** * Persist the builder to the project file. - * - * @param doc - * @param element */ public void serialize(ICStorageElement element, boolean resetDirtyState) { if (superClass != null) diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java index 860ffcd4c42..adecbdfb768 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/CommonBuilder.java @@ -273,10 +273,6 @@ public class CommonBuilder extends ACBuilder { reservedNames = Arrays.asList(new String[]{".cdtbuild", ".cdtproject", ".project"}); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ } - /** - * @param changedResource - * @return - */ private boolean isGeneratedResource(IResource resource) { // Is this a generated directory ... IPath path = resource.getFullPath(); @@ -288,10 +284,6 @@ public class CommonBuilder extends ACBuilder { return false; } - /** - * @param resource - * @return - */ private boolean isProjectFile(IResource resource) { return reservedNames.contains(resource.getName()); } @@ -1985,7 +1977,6 @@ public class CommonBuilder extends ACBuilder { /** * Check whether the build has been canceled. - * @param monitor */ public void checkCancel(IProgressMonitor monitor) { if (monitor != null && monitor.isCanceled()) @@ -2049,8 +2040,6 @@ public class CommonBuilder extends ACBuilder { /** * Parsing arguments in a shell style - * @param builder - * @return */ private String[] argumentsToArray(String args) { return CommandLineUtil.argumentsToArray(args); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ConfigurationV2.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ConfigurationV2.java index 8d3e5f2055c..2aec567e76c 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ConfigurationV2.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/ConfigurationV2.java @@ -195,9 +195,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 { /** * A fresh new configuration for a target. - * - * @param target - * @param id */ public ConfigurationV2(Target target, String id) { this.id = id; @@ -219,8 +216,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 { /** * Adds a tool reference to the receiver. - * - * @param toolRef */ public void addToolReference(ToolReference toolRef) { getLocalToolReferences().add(toolRef); @@ -534,9 +529,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 { return null; } - /** - * @param targetElement - */ public void reset(IManagedConfigElement element) { // I just need to reset the tool references getLocalToolReferences().clear(); @@ -553,9 +545,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 { /** * Persist receiver to project file. - * - * @param doc - * @param element */ public void serialize(Document doc, Element element) { element.setAttribute(IConfigurationV2.ID, id); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/DefaultManagedConfigElement.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/DefaultManagedConfigElement.java index 0fefe5427bd..f74796caa82 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/DefaultManagedConfigElement.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/DefaultManagedConfigElement.java @@ -24,9 +24,6 @@ public class DefaultManagedConfigElement implements IManagedConfigElement { private IConfigurationElement element; private IExtension extension; - /** - * @param element - */ public DefaultManagedConfigElement(IConfigurationElement element, IExtension extension) { this.element = element; this.extension = extension; @@ -67,9 +64,6 @@ public class DefaultManagedConfigElement implements IManagedConfigElement { return extension; } - /** - * @return - */ public IConfigurationElement getConfigurationElement() { return element; } diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/GeneratedMakefileBuilder.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/GeneratedMakefileBuilder.java index 7011bbb5365..c374b9a7729 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/GeneratedMakefileBuilder.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/GeneratedMakefileBuilder.java @@ -121,10 +121,6 @@ public class GeneratedMakefileBuilder extends ACBuilder { reservedNames = Arrays.asList(new String[]{".cdtbuild", ".cdtproject", ".project"}); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ } - /** - * @param changedResource - * @return - */ private boolean isGeneratedResource(IResource resource) { // Is this a generated directory ... IPath path = resource.getProjectRelativePath(); @@ -138,10 +134,6 @@ public class GeneratedMakefileBuilder extends ACBuilder { return false; } - /** - * @param resource - * @return - */ private boolean isProjectFile(IResource resource) { return reservedNames.contains(resource.getName()); } @@ -335,9 +327,6 @@ public class GeneratedMakefileBuilder extends ACBuilder { public GeneratedMakefileBuilder() { } - /** - * @param epm - */ private void addBuilderMarkers(ErrorParserManager epm) { IWorkspaceRoot root = CCorePlugin.getWorkspace().getRoot(); Iterator iter = getGenerationProblems().iterator(); @@ -569,7 +558,6 @@ public class GeneratedMakefileBuilder extends ACBuilder { /** * Check whether the build has been canceled. Cancellation requests * propagated to the caller by throwing OperationCanceledException. - * @param monitor * * @see org.eclipse.core.runtime.OperationCanceledException#OperationCanceledException() */ @@ -1690,10 +1678,6 @@ public class GeneratedMakefileBuilder extends ACBuilder { } - /** - * @param currentProject - * @throws CoreException - */ private void initNewBuildConsole(IProject currentProject) throws CoreException { // Get a build console for the project console = CCorePlugin.getDefault().getConsole(); diff --git a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/HoldsOptions.java b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/HoldsOptions.java index 98b63b4d09a..d5dc41705a2 100644 --- a/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/HoldsOptions.java +++ b/build/org.eclipse.cdt.managedbuilder.core/src/org/eclipse/cdt/managedbuilder/internal/core/HoldsOptions.java @@ -191,7 +191,6 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions, * class only, thus do not handle exceptions. * * @param element where to serialize the tool - * @throws BuildException */ protected void serialize(ICStorageElement element) throws BuildException { if (childOptionCategories != null) { @@ -396,7 +395,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions, * M E T H O D S M O V E D F R O M T O O L I N 3 . 0 */ - /* (non-Javadoc) + /** * Memory-safe way to access the vector of category IDs */ private Vector getCategoryIds() { @@ -406,23 +405,17 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions, return categoryIds; } - /** - * @param category - */ public void addChildCategory(IOptionCategory category) { if (childOptionCategories == null) childOptionCategories = new ArrayList(); childOptionCategories.add(category); } - /** - * @param option - */ public void addOption(Option option) { getOptionMap().put(option.getId(), option); } - /* (non-Javadoc) - * Memeory-safe way to access the map of category IDs to categories + /** + * Memory-safe way to access the map of category IDs to categories */ private Map getCategoryMap() { if (categoryMap == null) { @@ -431,7 +424,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions, return categoryMap; } - /* (non-Javadoc) + /** * Memory-safe way to access the list of options */ private Collection