1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00

bug 319826: Undeclared/unnecessary Javadoc parameters

This commit is contained in:
Andrew Gvozdev 2010-07-28 19:41:48 +00:00
parent 3317bebc0f
commit c1ff5f35db
80 changed files with 228 additions and 1023 deletions

View file

@ -120,10 +120,6 @@ public class ScannerConfigNature implements IProjectNature {
/** /**
* Returns build command as stored in .project file * Returns build command as stored in .project file
*
* @param description
* @param builderID
* @return ICommand
*/ */
public static ICommand getBuildSpec(IProjectDescription description, String builderID) { public static ICommand getBuildSpec(IProjectDescription description, String builderID) {
ICommand[] commands = description.getBuildSpec(); ICommand[] commands = description.getBuildSpec();
@ -137,10 +133,6 @@ public class ScannerConfigNature implements IProjectNature {
/** /**
* Stores a build command in .project file * Stores a build command in .project file
*
* @param description
* @param newCommand
* @return IProjecDescription
*/ */
public static IProjectDescription setBuildSpec(IProjectDescription description, ICommand newCommand) { public static IProjectDescription setBuildSpec(IProjectDescription description, ICommand newCommand) {
ICommand[] oldCommands = description.getBuildSpec(); ICommand[] oldCommands = description.getBuildSpec();

View file

@ -65,10 +65,6 @@ public class CfgSCJobsUtil {
/** /**
* Call ESI providers to get scanner info * Call ESI providers to get scanner info
*
* @param collector
* @param buildInfo
* @param monitor
*/ */
public static SCProfileInstance getProviderScannerInfo(final IProject project, public static SCProfileInstance getProviderScannerInfo(final IProject project,
final CfgInfoContext context, final CfgInfoContext context,
@ -121,10 +117,6 @@ public class CfgSCJobsUtil {
/** /**
* Update and persist scanner configuration * Update and persist scanner configuration
*
* @param project
* @param buildInfo
* @param monitor
*/ */
public static boolean updateScannerConfiguration(IProject project, public static boolean updateScannerConfiguration(IProject project,
CfgInfoContext context, CfgInfoContext context,

View file

@ -256,7 +256,6 @@ public class BuildDescriptionManager {
* cleans the resources to be rebuilt * cleans the resources to be rebuilt
* *
* @param des build description * @param des build description
* @throws CoreException
*/ */
public static void cleanGeneratedRebuildResources(IBuildDescription des) throws CoreException{ public static void cleanGeneratedRebuildResources(IBuildDescription des) throws CoreException{
IBuildResource bRcs[] = filterGeneratedBuildResources(des.getResources(), REMOVED | REBUILD); IBuildResource bRcs[] = filterGeneratedBuildResources(des.getResources(), REMOVED | REBUILD);

View file

@ -43,8 +43,6 @@ public interface IBuildDescription {
/** /**
* Returns the Build resource for the given resource location * Returns the Build resource for the given resource location
* *
* @param location
*
* @return the IBuildResource or null if not found * @return the IBuildResource or null if not found
*/ */
IBuildResource getBuildResource(IPath location); IBuildResource getBuildResource(IPath location);
@ -52,8 +50,6 @@ public interface IBuildDescription {
/** /**
* Returns the Build resource for the given resource * Returns the Build resource for the given resource
* *
* @param location
*
* @return the IBuildResource or null if not found * @return the IBuildResource or null if not found
*/ */
IBuildResource getBuildResource(IResource resource); IBuildResource getBuildResource(IResource resource);
@ -93,8 +89,7 @@ public interface IBuildDescription {
URI getDefaultBuildDirLocationURI(); URI getDefaultBuildDirLocationURI();
/** /**
* The Workspace FullPath of the build directory * @return The Workspace FullPath of the build directory
* @return
*/ */
IPath getDefaultBuildDirFullPath(); IPath getDefaultBuildDirFullPath();
} }

View file

@ -52,7 +52,7 @@ public interface IBuildResource {
* In case the resource is the project source, * In case the resource is the project source,
* The returned output io type belongs to the main input step * The returned output io type belongs to the main input step
* *
* @see IBuildRepresentation.getInputStep() * @see IBuildDescription#getInputStep()
* *
* @return IBuildIOType * @return IBuildIOType
*/ */
@ -70,7 +70,7 @@ public interface IBuildResource {
* In case the resource is the project source, * In case the resource is the project source,
* The main input step is returned * The main input step is returned
* *
* @see IBuildRepresentation.getInputStep() * @see IBuildDescription#getInputStep()
* *
* @return IBuildIOType * @return IBuildIOType
*/ */

View file

@ -76,16 +76,8 @@ public interface IBuildStep {
IBuildDescription getBuildDescription(); IBuildDescription getBuildDescription();
/** /**
* * @return the set of commands used for building the step
* Returns the set of commands used for building the step
*
* NOTE: This is a preliminary method * 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); IBuildCommand[] getCommands(IPath cwd, Map inStepMap, Map outStepMap, boolean resolveAll);
} }

View file

@ -43,10 +43,6 @@ public interface IStepVisitor {
* @see IStepVisitor#VISIT_CONTINUE * @see IStepVisitor#VISIT_CONTINUE
* @see IStepVisitor#VISIT_STOP * @see IStepVisitor#VISIT_STOP
* @see BuildDescriptionManager#accept(IStepVisitor, IBuildDescription, boolean) * @see BuildDescriptionManager#accept(IStepVisitor, IBuildDescription, boolean)
*
* @param step
* @return int
* @throws CoreException
*/ */
int visit(IBuildStep step) throws CoreException; int visit(IBuildStep step) throws CoreException;
} }

View file

@ -52,10 +52,8 @@ public interface IAdditionalInput {
public String[] getPaths(); 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. * which this element applies.
*
* @param paths
*/ */
public void setPaths(String paths); public void setPaths(String paths);
@ -83,8 +81,6 @@ public interface IAdditionalInput {
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);

View file

@ -193,16 +193,12 @@ public interface IBuilder extends IBuildObject, IMakeBuilderInfo {
/** /**
* Sets the arguments to be passed to the build utility used by the * Sets the arguments to be passed to the build utility used by the
* receiver to produce a build goal. * receiver to produce a build goal.
*
* @param makeArgs
*/ */
public void setArguments(String makeArgs); public void setArguments(String makeArgs);
/** /**
* Sets the BuildFileGenerator plugin.xml element * Sets the BuildFileGenerator plugin.xml element
* *
* @param element
*
* @deprecated as of CDT 4.0 * @deprecated as of CDT 4.0
*/ */
@Deprecated @Deprecated
@ -210,29 +206,21 @@ public interface IBuilder extends IBuildObject, IMakeBuilderInfo {
/** /**
* Sets the build command for the receiver to the value in the argument. * Sets the build command for the receiver to the value in the argument.
*
* @param command
*/ */
public void setCommand(String command); public void setCommand(String command);
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
/** /**
* Sets the semicolon separated list of error parser ids * Sets the semicolon separated list of error parser ids
*
* @param ids
*/ */
public void setErrorParserIds(String ids); public void setErrorParserIds(String ids);
/** /**
* Sets the isAbstract attribute of the builder. * Sets the isAbstract attribute of the builder.
*
* @param b
*/ */
public void setIsAbstract(boolean b); public void setIsAbstract(boolean b);
@ -254,16 +242,12 @@ public interface IBuilder extends IBuildObject, IMakeBuilderInfo {
/** /**
* Sets the 'versionsSupported' attribute of the builder. * Sets the 'versionsSupported' attribute of the builder.
*
* @param versionsSupported
*/ */
public void setVersionsSupported(String versionsSupported); public void setVersionsSupported(String versionsSupported);
/** /**
* Sets the 'convertToId' attribute of the builder. * Sets the 'convertToId' attribute of the builder.
*
* @param convertToId
*/ */
public void setConvertToId(String convertToId); public void setConvertToId(String convertToId);

View file

@ -68,16 +68,11 @@ public interface IConfiguration extends IBuildObject, IBuildObjectPropertiesCont
/** /**
* Sets the description of the receiver to the value specified in the argument * Sets the description of the receiver to the value specified in the argument
*
* @param description
*/ */
public void setDescription(String description); public void setDescription(String description);
/** /**
* Creates a child resource configuration corresponding to the passed in file. * Creates a child resource configuration corresponding to the passed in file.
*
* @param file
* @return IResourceConfiguration
*/ */
public IResourceConfiguration createResourceConfiguration(IFile file); 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 * Set (override) the extension that should be appended to the build artifact
* for the receiver. * for the receiver.
*
* @param extension
*/ */
public void setArtifactExtension(String extension); public void setArtifactExtension(String extension);
/** /**
* Set the name of the artifact that will be produced when the receiver * Set the name of the artifact that will be produced when the receiver
* is built. * is built.
*
* @param name
*/ */
public void setArtifactName(String name); public void setArtifactName(String name);
/** /**
* Sets the arguments to be passed to the build utility used by the * Sets the arguments to be passed to the build utility used by the
* receiver to produce a build goal. * receiver to produce a build goal.
*
* @param makeArgs
*/ */
public void setBuildArguments(String makeArgs); public void setBuildArguments(String makeArgs);
/** /**
* Sets the build command for the receiver to the value in the argument. * Sets the build command for the receiver to the value in the argument.
*
* @param command
*/ */
public void setBuildCommand(String command); public void setBuildCommand(String command);
/** /**
* Sets the prebuild step for the receiver to the value in the argument. * Sets the prebuild step for the receiver to the value in the argument.
*
* @param step
*/ */
public void setPrebuildStep(String step); public void setPrebuildStep(String step);
/** /**
* Sets the postbuild step for the receiver to the value in the argument. * Sets the postbuild step for the receiver to the value in the argument.
*
* @param step
*/ */
public void setPostbuildStep(String step); public void setPostbuildStep(String step);
/** /**
* Sets the prebuild step display string for the receiver to the value in the argument. * Sets the prebuild step display string for the receiver to the value in the argument.
*
* @param announceStep
*/ */
public void setPreannouncebuildStep(String announceStep); public void setPreannouncebuildStep(String announceStep);
/** /**
* Sets the postbuild step display string for the receiver to the value in the argument. * Sets the postbuild step display string for the receiver to the value in the argument.
*
* @param announceStep
*/ */
public void setPostannouncebuildStep(String 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
/** /**
* Sets the semicolon separated list of error parser ids * Sets the semicolon separated list of error parser ids
*
* @param ids
*/ */
public void setErrorParserIds(String 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 * Sets the name of the receiver to the value specified in the argument
*
* @param name
*/ */
public void setName(String 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. * @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. * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions.
* Code assuming ITool as type, will continue to work unchanged. * 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. * @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. * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions.
* Code assuming ITool as type, will continue to work unchanged. * 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. * @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. * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions.
* Code assuming ITool as type, will continue to work unchanged. * Code assuming ITool as type, will continue to work unchanged.
*/ */

View file

@ -43,22 +43,17 @@ public interface IConfigurationV2 extends IBuildObject {
ITool[] getFilteredTools(IProject project); ITool[] getFilteredTools(IProject project);
/** /**
* Returns the resource that owns the project that owns the configuration. * @return the resource that owns the project that owns the configuration.
* @return
*/ */
public IResource getOwner(); public IResource getOwner();
/** /**
* Answers the configuration that this configuration is based on. * @return the configuration that this configuration is based on.
*
* @return
*/ */
public IConfigurationV2 getParent(); public IConfigurationV2 getParent();
/** /**
* Returns the target for this configuration. * @return the target for this configuration.
*
* @return
*/ */
public ITarget getTarget(); public ITarget getTarget();
@ -79,9 +74,7 @@ public interface IConfigurationV2 extends IBuildObject {
public ITool[] getTools(); public ITool[] getTools();
/** /**
* Returns the tool references that are children of this configuration. * @return the tool references that are children of this configuration.
*
* @return
*/ */
public IToolReference[] getToolReferences(); public IToolReference[] getToolReferences();
@ -104,15 +97,13 @@ public interface IConfigurationV2 extends IBuildObject {
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
/** /**
* Sets the name of the receiver to the value specified in the argument * Sets the name of the receiver to the value specified in the argument
* *
* @param name * @param name new name
*/ */
public void setName(String name); public void setName(String name);
@ -121,8 +112,6 @@ public interface IConfigurationV2 extends IBuildObject {
* *
* @param option The option to change. * @param option The option to change.
* @param value The value to apply to the option. * @param value The value to apply to the option.
*
* @throws BuildException
*/ */
public void setOption(IOption option, boolean value) public void setOption(IOption option, boolean value)
throws BuildException; throws BuildException;
@ -132,8 +121,6 @@ public interface IConfigurationV2 extends IBuildObject {
* *
* @param option The option that will be effected by change. * @param option The option that will be effected by change.
* @param value The value to apply to the option. * @param value The value to apply to the option.
*
* @throws BuildException
*/ */
public void setOption(IOption option, String value) public void setOption(IOption option, String value)
throws BuildException; throws BuildException;
@ -143,8 +130,6 @@ public interface IConfigurationV2 extends IBuildObject {
* *
* @param option The option to change. * @param option The option to change.
* @param value The values to apply to the option. * @param value The values to apply to the option.
*
* @throws BuildException
*/ */
public void setOption(IOption option, String[] value) public void setOption(IOption option, String[] value)
throws BuildException; throws BuildException;
@ -167,8 +152,6 @@ public interface IConfigurationV2 extends IBuildObject {
/** /**
* Sets the configuration that was created from this V2.0 configuration. * Sets the configuration that was created from this V2.0 configuration.
*
* @param config
*/ */
public void setCreatedConfig(IConfiguration config); public void setCreatedConfig(IConfiguration config);

View file

@ -44,7 +44,7 @@ public interface IFolderInfo extends IResourceInfo {
* Returns a <code>ITool</code> for the tool associated with the * Returns a <code>ITool</code> for the tool associated with the
* input extension. * input extension.
* *
* @param extension the file extension of the input file * @param sourceExtension the file extension of the input file
* @return ITool * @return ITool
* *
* @since 3.1 * @since 3.1

View file

@ -32,10 +32,10 @@ public interface IHoldsOptions extends IBuildObject {
/** /**
* Creates a child Option * Creates a child Option
* *
* @param Option The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new option * @param Id The id for the new option
* @param String The name for the new option * @param name The name for the new option
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return IOption * @return IOption
*/ */
@ -43,8 +43,6 @@ public interface IHoldsOptions extends IBuildObject {
/** /**
* Removes an option. * Removes an option.
*
* @param option
*/ */
public void removeOption(IOption option); public void removeOption(IOption option);
@ -52,7 +50,7 @@ public interface IHoldsOptions extends IBuildObject {
* This is a deprecated method for retrieving an <code>IOption</code> from * This is a deprecated method for retrieving an <code>IOption</code> from
* the receiver based on an ID. It is preferred that you use the newer method * the receiver based on an ID. It is preferred that you use the newer method
* <code>getOptionById</code> * <code>getOptionById</code>
* @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 * @param id unique identifier of the option to search for
* @return <code>IOption</code> * @return <code>IOption</code>
@ -137,7 +135,7 @@ public interface IHoldsOptions extends IBuildObject {
* Each individual option in superclass, will become the superclass for * Each individual option in superclass, will become the superclass for
* the new option. * the new option.
* *
* @param IHoldsOptions The superClass * @param superClass The superClass
* @since 3.0 * @since 3.0
*/ */
public void createOptions(IHoldsOptions superClass); 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 * 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 * @param adjustExtension - if false, modifications are to be made for the non-extension element
* (only for some particular configuration associated with some eclipse project) * (only for some particular configuration associated with some eclipse project)
* This is the most common use of this method. * This is the most common use of this method.
@ -167,7 +165,6 @@ public interface IHoldsOptions extends IBuildObject {
/** /**
* sets the holder rebuild state * sets the holder rebuild state
* @param rebuild
*/ */
public void setRebuildState(boolean rebuild); public void setRebuildState(boolean rebuild);
} }

View file

@ -45,8 +45,6 @@ public interface IInputOrder {
/** /**
* Sets the relative or absolute path of the resource to which this element applies. * Sets the relative or absolute path of the resource to which this element applies.
*
* @param path
*/ */
public void setPath(String 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. * Sets the comma-separated list of integer values that specify the order of this resource.
*
* @param order
*/ */
public void setOrder(String 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. * Sets whether this resource is not used as an input for the tool.
*
* @param excluded
*/ */
public void setExcluded(boolean excluded); public void setExcluded(boolean excluded);
@ -95,8 +89,6 @@ public interface IInputOrder {
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);

View file

@ -303,8 +303,6 @@ public interface IInputType extends IBuildObject {
* Sets the id of the option that is associated with this input type on * 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 * 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. * this input type are taken from the value specified for the option.
*
* @param optionId
*/ */
public void setOptionId(String 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 * option value is only updated during build file generation and therefore
* could be out of sync with the project until build file generation * could be out of sync with the project until build file generation
* occurs. * occurs.
*
* @param optionId
*/ */
public void setAssignToOptionId(String optionId); public void setAssignToOptionId(String optionId);
@ -345,8 +341,6 @@ public interface IInputType extends IBuildObject {
/** /**
* Sets whether this inputType can contain multiple input resources * Sets whether this inputType can contain multiple input resources
*
* @param multiple
*/ */
public void setMultipleOfType(boolean 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 * Sets whether this inputType is considered the primary input of the tool
*
* @param primary
*/ */
public void setPrimaryInput(boolean 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);

View file

@ -72,9 +72,6 @@ public interface IManagedBuildInfo {
* @param sourceExtension - source extension * @param sourceExtension - source extension
* @param flags - build flags * @param flags - build flags
* @param outputFlag - output flag for build tool * @param outputFlag - output flag for build tool
* @param outputPrefix
* @param outputName
* @param inputResources
* @return IManagedCommandLineInfo * @return IManagedCommandLineInfo
* *
* @deprecated - use generateToolCommandLineInfo instead * @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 * 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, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * 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, public IManagedCommandLineInfo generateToolCommandLineInfo( String sourceExtension, String[] flags,
String outputFlag, String outputPrefix, String outputName, String[] inputResources, IPath inputLocation, IPath outputLocation ); 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 * Answers the command needed to remove files on the build machine
*
* @return
*/ */
public String getCleanCommand(); public String getCleanCommand();
@ -195,10 +180,6 @@ public interface IManagedBuildInfo {
*/ */
public IConfiguration getDefaultConfiguration(); public IConfiguration getDefaultConfiguration();
/**
* @param sourceExtension
* @return
*/
public IManagedDependencyGeneratorType getDependencyGenerator(String sourceExtension); public IManagedDependencyGeneratorType getDependencyGenerator(String sourceExtension);
/** /**
@ -212,9 +193,6 @@ public interface IManagedBuildInfo {
* the environment macro references converted to the buildfile variable format, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
* *
* @param extension
* @return
*
* @deprecated - use getToolFlagsForConfiguration * @deprecated - use getToolFlagsForConfiguration
*/ */
@Deprecated @Deprecated
@ -230,11 +208,6 @@ public interface IManagedBuildInfo {
* chosen to keep the environment build macros unresolved, the string contains * chosen to keep the environment build macros unresolved, the string contains
* the environment macro references converted to the buildfile variable format, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
*
* @param extension
* @param inputLocation
* @param outputLocation
* @return
*/ */
public String getToolFlagsForConfiguration(String extension, IPath inputLocation, IPath outputLocation); 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, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
* *
* @param extension
* @return
*
* @deprecated - use getToolFlagsForSource * @deprecated - use getToolFlagsForSource
*/ */
@Deprecated @Deprecated
@ -267,19 +237,11 @@ public interface IManagedBuildInfo {
* chosen to keep the environment build macros unresolved, the string contains * chosen to keep the environment build macros unresolved, the string contains
* the environment macro references converted to the buildfile variable format, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
*
* @param extension
* @param inputLocation
* @param outputLocation
* @return
*/ */
public String getToolFlagsForSource(String extension, IPath inputLocation, IPath outputLocation); public String getToolFlagsForSource(String extension, IPath inputLocation, IPath outputLocation);
/** /**
* Answers the libraries the project links in. * Answers the libraries the project links in.
*
* @param extension
* @return
*/ */
public String[] getLibsForConfiguration(String extension); public String[] getLibsForConfiguration(String extension);
@ -293,9 +255,6 @@ public interface IManagedBuildInfo {
/** /**
* Answers the extension that will be built by the current configuration * Answers the extension that will be built by the current configuration
* for the extension passed in the argument or <code>null</code>. * for the extension passed in the argument or <code>null</code>.
*
* @param resourceExtension
* @return
*/ */
public String getOutputExtension(String resourceExtension); public String getOutputExtension(String resourceExtension);
@ -304,9 +263,6 @@ public interface IManagedBuildInfo {
* or an empty <code>String</code> if there is no special flag. For example, the * or an empty <code>String</code> if there is no special flag. For example, the
* GCC tools use the '-o' flag to produce a named output, for example * GCC tools use the '-o' flag to produce a named output, for example
* gcc -c foo.c -o foo.o * gcc -c foo.c -o foo.o
*
* @param outputExt
* @return
*/ */
public String getOutputFlag(String outputExt); public String getOutputFlag(String outputExt);
@ -315,7 +271,6 @@ public interface IManagedBuildInfo {
* artifact. For example, a library foo, should have the prefix 'lib' and * artifact. For example, a library foo, should have the prefix 'lib' and
* the extension '.a', so the final goal would be 'libfoo.a' * the extension '.a', so the final goal would be 'libfoo.a'
* *
* @param outputExtension
* @return the prefix or an empty string * @return the prefix or an empty string
*/ */
public String getOutputPrefix(String outputExtension); public String getOutputPrefix(String outputExtension);
@ -457,36 +412,27 @@ public interface IManagedBuildInfo {
public void setDefaultConfiguration(IConfiguration configuration); public void setDefaultConfiguration(IConfiguration configuration);
/** /**
* @param configName
* @return boolean indicating if setDefaultConfiguration was successful * @return boolean indicating if setDefaultConfiguration was successful
*/ */
public boolean setDefaultConfiguration(String configName); public boolean setDefaultConfiguration(String configName);
/** /**
* Sets the dirty flag for the build model to the value of the argument. * Sets the dirty flag for the build model to the value of the argument.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
/** /**
* Sets the valid flag for the build model to the value of the argument. * Sets the valid flag for the build model to the value of the argument.
*
* @param isValid
*/ */
public void setValid(boolean isValid); public void setValid(boolean isValid);
/** /**
* Sets the ManagedProject associated with this build info * Sets the ManagedProject associated with this build info
*
* @param project
*/ */
public void setManagedProject(IManagedProject project); public void setManagedProject(IManagedProject project);
/** /**
* sets the read only status of Managed Build Info * sets the read only status of Managed Build Info
*
* @param readOnly
*/ */
public void setReadOnly(boolean readOnly); public void setReadOnly(boolean readOnly);

View file

@ -11,18 +11,6 @@
package org.eclipse.cdt.managedbuilder.core; package org.eclipse.cdt.managedbuilder.core;
public interface IManagedCommandLineGenerator { 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, public IManagedCommandLineInfo generateCommandLineInfo( ITool tool, String commandName, String[] flags,
String outputFlag, String outputPrefix, String outputName, String[] inputResources, String commandLinePattern ); String outputFlag, String outputPrefix, String outputName, String[] inputResources, String commandLinePattern );
} }

View file

@ -23,43 +23,36 @@ public interface IManagedCommandLineInfo {
/** /**
* give command line pattern * give command line pattern
* @return
*/ */
public String getCommandLinePattern(); public String getCommandLinePattern();
/** /**
* provide tool name * provide tool name
* @return
*/ */
public String getCommandName(); public String getCommandName();
/** /**
* give command flags * give command flags
* @return
*/ */
public String getFlags(); public String getFlags();
/** /**
* provide list of resources used by tool for transformation * provide list of resources used by tool for transformation
* @return
*/ */
public String getInputs(); public String getInputs();
/** /**
* return output file name * return output file name
* @return
*/ */
public String getOutput(); public String getOutput();
/** /**
* give command flag to generate output * give command flag to generate output
* @return
*/ */
public String getOutputFlag(); public String getOutputFlag();
/** /**
* return output prefix * return output prefix
* @return
*/ */
public String getOutputPrefix(); public String getOutputPrefix();
} }

View file

@ -13,11 +13,5 @@ package org.eclipse.cdt.managedbuilder.core;
import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPath;
public interface IManagedOutputNameProvider { public interface IManagedOutputNameProvider {
/**
*
* @param tool
* @param primaryInputNames
* @return IPath[]
*/
public IPath[] getOutputNames( ITool tool, IPath[] primaryInputNames ); public IPath[] getOutputNames( ITool tool, IPath[] primaryInputNames );
} }

View file

@ -113,8 +113,6 @@ public interface IManagedProject extends IBuildObject, IBuildObjectPropertiesCon
/** /**
* Sets the owner of the managed project. * Sets the owner of the managed project.
*
* @param resource
*/ */
public void updateOwner(IResource 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
@ -143,17 +139,15 @@ public interface IManagedProject extends IBuildObject, IBuildObjectPropertiesCon
/** /**
* Sets the element's "Valid" flag. * Sets the element's "Valid" flag.
*
* @param isValid
*/ */
public void setValid(boolean isValid); public void setValid(boolean isValid);
/** // /**
* Persist the managed project to the project file (.cdtbuild). // * Persist the managed project to the project file (.cdtbuild).
* // *
* @param doc // * @param doc
* @param element // * @param element
*/ // */
// public void serialize(Document doc, Element element); // public void serialize(Document doc, Element element);
/** /**

View file

@ -161,7 +161,6 @@ public interface IOption extends IBuildObject {
/** /**
* @return the value for a boolean option. * @return the value for a boolean option.
* @throws BuildException
*/ */
public boolean getBooleanValue() throws BuildException; public boolean getBooleanValue() throws BuildException;
@ -237,7 +236,6 @@ public interface IOption extends IBuildObject {
/** /**
* Sets the category for this option. * Sets the category for this option.
* @param category
*/ */
public void setCategory(IOptionCategory category); public void setCategory(IOptionCategory category);
@ -298,7 +296,6 @@ public interface IOption extends IBuildObject {
/** /**
* @return the user-defined preprocessor symbols. * @return the user-defined preprocessor symbols.
* @throws BuildException
*/ */
public String[] getDefinedSymbols() 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 * for the debug level option of the Gnu compiler, and the plugin
* manifest defined that as -g, then the return value would be the * manifest defined that as -g, then the return value would be the
* String "-g" * String "-g"
*
* @throws BuildException
*/ */
public String getEnumCommand (String id) throws BuildException; public String getEnumCommand (String id) throws BuildException;
/** /**
* @param id - enumeration id * @param id - enumeration id
* @return the "name" associated with the enumeration id. * @return the "name" associated with the enumeration id.
*
* @throws BuildException
*/ */
public String getEnumName (String id) throws BuildException; public String getEnumName (String id) throws BuildException;
/** /**
* @param name - a "name" associated with enumeration id * @param name - a "name" associated with enumeration id
* @return enumeration id * @return enumeration id
*
* @throws BuildException
*/ */
public String getEnumeratedId(String name) throws BuildException; public String getEnumeratedId(String name) throws BuildException;
/** /**
* @return an array of <code>String</code> containing the includes paths * @return an array of <code>String</code> containing the includes paths
* defined in the build model. * defined in the build model.
* @throws BuildException
*/ */
public String[] getIncludePaths() throws BuildException; public String[] getIncludePaths() throws BuildException;
/** /**
* @return an array or <code>String</code>s containing the libraries * @return an array or <code>String</code>s containing the libraries
* that must be linked into the project. * that must be linked into the project.
* @throws BuildException
*/ */
public String[] getLibraries() throws BuildException ; public String[] getLibraries() throws BuildException ;
@ -349,7 +338,6 @@ public interface IOption extends IBuildObject {
* @return an array or <code>String</code>s containing the library files * @return an array or <code>String</code>s containing the library files
* that must be linked into the project. * that must be linked into the project.
* *
* @throws BuildException
* @since 7.0 * @since 7.0
*/ */
public String[] getLibraryFiles() throws BuildException ; 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. * @return the current value for this option if it is a List of Strings.
* @throws BuildException
*/ */
public String [] getStringListValue() throws BuildException; public String [] getStringListValue() throws BuildException;
/** /**
* @return the current value for this option if it is a String * @return the current value for this option if it is a String
* @throws BuildException
*/ */
public String getStringValue() throws BuildException; public String getStringValue() throws BuildException;
/** /**
* @return all of the user-defined object files that must be linked with * @return all of the user-defined object files that must be linked with
* the final build target. * the final build target.
*
* @throws BuildException
*/ */
public String [] getUserObjects() 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. * @return the type for the value of the option.
*
* @throws BuildException
*/ */
public int getValueType() 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. * 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 * If the receiver is not a reference to a boolean option, method will throw an
* exception. * exception.
*
* @param value
* @throws BuildException
*/ */
public void setValue(boolean value) throws BuildException; public void setValue(boolean value) throws BuildException;
/** /**
* Sets the string value of the receiver to the value specified in the argument. * 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; 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. * Sets the value of the receiver to be an array of strings.
* *
* @param value An array of strings to place in the option reference. * @param value An array of strings to place in the option reference.
* @throws BuildException
*/ */
public void setValue(String [] value) 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. * Sets the value-type of this option. Use with care.
*
* @param type
*/ */
public void setValueType(int 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 * Sets the value handlers extra argument specified for this tool
* @param extraArgument
* @since 3.0 * @since 3.0
*/ */
public void setValueHandlerExtraArgument(String extraArgument); 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#INCLUDE_PATH}, {@link IOption#PREPROCESSOR_SYMBOLS}, {@link IOption#LIBRARIES},
* {@link IOption#OBJECTS}, {@link IOption#INCLUDE_FILES}, {@link IOption#LIBRARY_PATHS}, * {@link IOption#OBJECTS}, {@link IOption#INCLUDE_FILES}, {@link IOption#LIBRARY_PATHS},
* {@link IOption#LIBRARY_FILES}, {@link IOption#MACRO_FILES} * {@link IOption#LIBRARY_FILES}, {@link IOption#MACRO_FILES}
*
* @throws BuildException
*/ */
int getBasicValueType() throws BuildException ; int getBasicValueType() throws BuildException ;
/** /**
* @return in case the option basic value type is STRING_LIST, returns the String list value, * @return in case the option basic value type is STRING_LIST, returns the String list value,
* throws BuildException otherwise * throws BuildException otherwise
*
* @throws BuildException
*/ */
String[] getBasicStringListValue() throws BuildException; String[] getBasicStringListValue() throws BuildException;

View file

@ -31,8 +31,6 @@ public interface IOptionCategory extends IBuildObject {
/** /**
* Returns the list of children of this node in the option category tree * Returns the list of children of this node in the option category tree
*
* @return
*/ */
public IOptionCategory[] getChildCategories(); 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 * Returns an array of ITool/IOption pairs for the options in this category
* for a given configuration. * for a given configuration.
* *
* @param tool
* @return Object[][]
*
* @since 3.1 * @since 3.1
*/ */
public Object[][] getOptions(IConfiguration configuration, IHoldsOptions optHolder); public Object[][] getOptions(IConfiguration configuration, IHoldsOptions optHolder);
@ -52,21 +47,24 @@ public interface IOptionCategory extends IBuildObject {
@Deprecated @Deprecated
public Object[][] getOptions(IConfiguration configuration); 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 * Returns an array of ITool/IOption pairs for the options in this category
* for a given resource configuration. * for a given resource configuration.
* *
* @param tool
* @return Object[][]
*
* @since 3.1 * @since 3.1
*/ */
// public Object[][] getOptions(IResourceConfiguration resConfig, IHoldsOptions optHolder);
public Object[][] getOptions(IResourceInfo resInfo, 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 @Deprecated
public Object[][] getOptions(IResourceConfiguration resConfig); 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 * Returns the category that owns this category, or null if this is the
* top category for a tool. * top category for a tool.
*
* @return
*/ */
public IOptionCategory getOwner(); public IOptionCategory getOwner();
@ -83,7 +79,6 @@ public interface IOptionCategory extends IBuildObject {
* Returns the tool that ultimately owns this category. * Returns the tool that ultimately owns this category.
* If owned by a toolChain return null. * If owned by a toolChain return null.
* *
* @return
* @deprecated since 3.0 - use getOptionHolder() instead * @deprecated since 3.0 - use getOptionHolder() instead
*/ */
@Deprecated @Deprecated
@ -122,8 +117,6 @@ public interface IOptionCategory extends IBuildObject {
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
} }

View file

@ -84,8 +84,6 @@ public interface IOutputType extends IBuildObject {
* NOTE: The value of this attribute will NOT be used if a * NOTE: The value of this attribute will NOT be used if a
* output content type is specified and is registered with * output content type is specified and is registered with
* Eclipse. * Eclipse.
*
* @param String
*/ */
public void setOutputExtensionsAttribute(String extensions); 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 * Sets the id of the option that is associated with this
* output type on the command line. * output type on the command line.
*
* @param optionId
*/ */
public void setOptionId(String 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 * Sets whether this outputType can create multiple output resources in
* one invocation of the tool. * one invocation of the tool.
*
* @param multiple
*/ */
public void setMultipleOfType(boolean 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 * Sets the input type that is used in determining the default
* names of this output type. * names of this output type.
*
* @param inputType
*/ */
public void setPrimaryInputType(IInputType contentType); public void setPrimaryInputType(IInputType contentType);
@ -172,8 +164,6 @@ public interface IOutputType extends IBuildObject {
/** /**
* Sets whether this is the primary output of the tool. * Sets whether this is the primary output of the tool.
*
* @param primary
*/ */
public void setPrimaryOutput(boolean 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. * 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 * For example, a librarian usually prepends 'lib' to the target.a
* @param String
*/ */
public void setOutputPrefix(String prefix); 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 * Sets the complete set of output file names for this outputType
*
* @param names
*/ */
public void setOutputNames(String 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);

View file

@ -118,8 +118,6 @@ public interface IProjectType extends IBuildObject, IBuildObjectPropertiesContai
/** /**
* Sets the isAbstract attribute of the tool-chain. * Sets the isAbstract attribute of the tool-chain.
*
* @param b
*/ */
public void setIsAbstract(boolean b); public void setIsAbstract(boolean b);
@ -182,8 +180,6 @@ public interface IProjectType extends IBuildObject, IBuildObjectPropertiesContai
/** /**
* Sets the 'convertToId' attribute of the project type. * Sets the 'convertToId' attribute of the project type.
*
* @param convertToId
*/ */
public void setConvertToId(String convertToId); public void setConvertToId(String convertToId);

View file

@ -83,8 +83,6 @@ public interface IResourceConfiguration extends IResourceInfo {
/** /**
* Sets the new value representing the users desire for ordering the application of * Sets the new value representing the users desire for ordering the application of
* a resource custom build step tool. * a resource custom build step tool.
*
* @param int
*/ */
public void setRcbsApplicability(int value); public void setRcbsApplicability(int value);
@ -92,8 +90,6 @@ public interface IResourceConfiguration extends IResourceInfo {
* Sets the "excluded" flag for the resource. * Sets the "excluded" flag for the resource.
* If <code>true</code>, the project resource identified by the resoursePath * If <code>true</code>, the project resource identified by the resoursePath
* attribute is excluded from the build of the parent configuration. * attribute is excluded from the build of the parent configuration.
*
* @param boolean
*/ */
public void setExclude(boolean excluded); public void setExclude(boolean excluded);
@ -112,8 +108,6 @@ public interface IResourceConfiguration extends IResourceInfo {
/** /**
* Sets the element's "dirty" (have I been modified?) flag. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
@ -135,18 +129,16 @@ public interface IResourceConfiguration extends IResourceInfo {
/** /**
* Removes the Tool from the Tool list and map * Removes the Tool from the Tool list and map
*
* @param Tool
*/ */
public void removeTool(ITool tool); public void removeTool(ITool tool);
/** /**
* Creates a <code>Tool</code> child for this resource configuration. * Creates a <code>Tool</code> child for this resource configuration.
* *
* @param ITool The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new tool chain * @param Id The id for the new tool chain
* @param String The name for the new tool chain * @param name The name for the new tool chain
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return ITool * @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. * @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. * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions.
* Code assuming ITool as type, will continue to work unchanged. * 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. * @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. * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions.
* Code assuming ITool as type, will continue to work unchanged. * 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. * @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. * @since 3.0 - The type of parent has changed from ITool to IHoldsOptions.
* Code assuming ITool as type, will continue to work unchanged. * 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 * sets the resource configuration rebuild state
* @param rebuild
*/ */
void setRebuildState(boolean rebuild); void setRebuildState(boolean rebuild);

View file

@ -73,9 +73,6 @@ public interface IResourceInfo extends IBuildObject {
* @param value The value to apply to the option. * @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. * @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) public IOption setOption(IHoldsOptions parent, IOption option, boolean value)
throws BuildException; throws BuildException;
@ -88,9 +85,6 @@ public interface IResourceInfo extends IBuildObject {
* @param value The value to apply to the option. * @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. * @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) public IOption setOption(IHoldsOptions parent, IOption option, String value)
throws BuildException; throws BuildException;
@ -103,9 +97,6 @@ public interface IResourceInfo extends IBuildObject {
* @param value The values to apply to the option. * @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. * @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) public IOption setOption(IHoldsOptions parent, IOption option, String[] value)
throws BuildException; throws BuildException;

View file

@ -75,9 +75,6 @@ public interface ITarget extends IBuildObject {
*/ */
public String getArtifactName(); public String getArtifactName();
/**
* @param isDirty
*/
public void setDirty(boolean 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 * Answers the command line arguments to pass to the make utility used
* by the receiver to build a project. * by the receiver to build a project.
*
* @return
*/ */
public String getMakeArguments(); public String getMakeArguments();
@ -143,9 +138,6 @@ public interface ITarget extends IBuildObject {
/** /**
* Returns the configuration with the given id, or <code>null</code> if not found. * Returns the configuration with the given id, or <code>null</code> if not found.
*
* @param id
* @return IConfigurationV2
*/ */
public IConfigurationV2 getConfiguration(String id); 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, * Answers the tool in the receiver with the ID specified in the argument,
* or <code>null</code> * or <code>null</code>
*
* @param id
* @return
*/ */
public ITool getTool(String id); public ITool getTool(String id);
@ -236,46 +225,34 @@ public interface ITarget extends IBuildObject {
/** /**
* Removes the configuration with the ID specified in the argument. * Removes the configuration with the ID specified in the argument.
*
* @param id
*/ */
public void removeConfiguration(String id); public void removeConfiguration(String id);
/** /**
* Set (override) the extension that should be appended to the build artifact * Set (override) the extension that should be appended to the build artifact
* for the receiver. * for the receiver.
*
* @param extension
*/ */
public void setArtifactExtension(String extension); public void setArtifactExtension(String extension);
/** /**
* Set the name of the artifact that will be produced when the receiver * Set the name of the artifact that will be produced when the receiver
* is built. * is built.
*
* @param name
*/ */
public void setArtifactName(String name); public void setArtifactName(String name);
/** /**
* Sets the arguments to be passed to the make utility used by the * Sets the arguments to be passed to the make utility used by the
* receiver to produce a build goal. * receiver to produce a build goal.
*
* @param makeArgs
*/ */
public void setMakeArguments(String makeArgs); public void setMakeArguments(String makeArgs);
/** /**
* Sets the make command for the receiver to the value in the argument. * Sets the make command for the receiver to the value in the argument.
*
* @param command
*/ */
public void setMakeCommand(String command); public void setMakeCommand(String command);
/** /**
* Sets the semicolon separated list of error parser ids * Sets the semicolon separated list of error parser ids
*
* @param ids
*/ */
public void setErrorParserIds(String ids); public void setErrorParserIds(String ids);
@ -289,15 +266,12 @@ public interface ITarget extends IBuildObject {
/** /**
* Sets the resource that owns the receiver. * Sets the resource that owns the receiver.
*
* @param resource
*/ */
public void updateOwner(IResource resource); public void updateOwner(IResource resource);
/** /**
* Converts a CDT V2.0 target into a ProjectType + Configuration + Toolchain + * Converts a CDT V2.0 target into a ProjectType + Configuration + Toolchain +
* Builder + TargetPlatform. * Builder + TargetPlatform.
* @param managedBuildRevision
*/ */
public void convertToProjectType(String managedBuildRevision); public void convertToProjectType(String managedBuildRevision);

View file

@ -53,8 +53,6 @@ public interface ITargetPlatform extends IBuildObject {
/** /**
* Sets the isAbstract attribute of the target paltform. * Sets the isAbstract attribute of the target paltform.
*
* @param b
*/ */
public void setIsAbstract(boolean b); public void setIsAbstract(boolean b);
@ -76,7 +74,7 @@ public interface ITargetPlatform extends IBuildObject {
/** /**
* Sets the OS list. * Sets the OS list.
* *
* @param String[] The list of OS names * @param OSs The list of OS names
*/ */
public void setOSList(String[] OSs); public void setOSList(String[] OSs);
@ -90,7 +88,7 @@ public interface ITargetPlatform extends IBuildObject {
/** /**
* Sets the architecture list. * Sets the architecture list.
* *
* @param String[] The list of architecture names * @param archs The list of architecture names
*/ */
public void setArchList(String[] archs); 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. * Sets the string id of the binary parser for this target platform.
* *
* @param id
* @deprecated Use setBinaryParserList * @deprecated Use setBinaryParserList
*/ */
@Deprecated @Deprecated
@ -121,8 +118,6 @@ public interface ITargetPlatform extends IBuildObject {
/** /**
* Sets the string ids of the binary parsers for this target platform. * Sets the string ids of the binary parsers for this target platform.
*
* @param ids
*/ */
public void setBinaryParserList(String[] 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);

View file

@ -69,10 +69,10 @@ public interface ITool extends IHoldsOptions {
/** /**
* Creates a child InputType for this tool. * Creates a child InputType for this tool.
* *
* @param InputType The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new InputType * @param Id The id for the new InputType
* @param String The name for the new InputType * @param name The name for the new InputType
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return IInputType * @return IInputType
* @since 3.0 * @since 3.0
@ -82,7 +82,6 @@ public interface ITool extends IHoldsOptions {
/** /**
* Removes an InputType from the tool's list. * Removes an InputType from the tool's list.
* *
* @param type
* @since 3.0 * @since 3.0
*/ */
public void removeInputType(IInputType type); public void removeInputType(IInputType type);
@ -159,10 +158,10 @@ public interface ITool extends IHoldsOptions {
/** /**
* Creates a child OutputType for this tool. * Creates a child OutputType for this tool.
* *
* @param OutputType The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new OutputType * @param Id The id for the new OutputType
* @param String The name for the new OutputType * @param name The name for the new OutputType
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return IOutputType * @return IOutputType
* @since 3.0 * @since 3.0
@ -172,7 +171,6 @@ public interface ITool extends IHoldsOptions {
/** /**
* Removes an OutputType from the tool's list. * Removes an OutputType from the tool's list.
* *
* @param type
* @since 3.0 * @since 3.0
*/ */
public void removeOutputType(IOutputType type); public void removeOutputType(IOutputType type);
@ -244,8 +242,6 @@ public interface ITool extends IHoldsOptions {
/** /**
* Sets the isAbstract attribute of the tool-chain. * Sets the isAbstract attribute of the tool-chain.
*
* @param b
*/ */
public void setIsAbstract(boolean b); public void setIsAbstract(boolean b);
@ -275,8 +271,6 @@ public interface ITool extends IHoldsOptions {
/** /**
* Sets the semicolon separated list of error parser ids * Sets the semicolon separated list of error parser ids
*
* @param ids
*/ */
public void setErrorParserIds(String 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, * Sets all of the output extensions that the receiver can build,
* into the outputs attribute. Note that the outputs attribute is * into the outputs attribute. Note that the outputs attribute is
* ignored when one or more outputTypes are specified. * ignored when one or more outputTypes are specified.
*
* @param String
*/ */
public void setOutputsAttribute(String extensions); 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 * 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 * control the name of the output artifact. For example, the GCC compile and
* linker use '-o', while the archiver does not. * linker use '-o', while the archiver does not.
*
* @param String
*/ */
public void setOutputFlag(String flag); 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. * 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 * 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); 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 * Sets whether the Tool wants the MBS to display the Advanced
* Input category that allows the user to specify additional input resources and * Input category that allows the user to specify additional input resources and
* dependencies. * dependencies.
*
* @param display
*/ */
public void setAdvancedInputCategory(boolean 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. * Sets whether the Tool represents a user-define custom build step.
*
* @param customBuildStep
*/ */
public void setCustomBuildStep(boolean customBuildStep); public void setCustomBuildStep(boolean customBuildStep);
@ -471,7 +457,6 @@ public interface ITool extends IHoldsOptions {
/** /**
* Sets the announcement string for this tool * Sets the announcement string for this tool
* @param announcement
*/ */
public void setAnnouncement(String 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. * Sets the command-line invocation command defined for this tool.
* *
* @param String
*
* @return boolean if <code>true</code>, then the tool command was modified * @return boolean if <code>true</code>, then the tool command was modified
*/ */
public boolean setToolCommand(String command); public boolean setToolCommand(String command);
@ -499,7 +482,6 @@ public interface ITool extends IHoldsOptions {
/** /**
* Sets the command line pattern for this tool * Sets the command line pattern for this tool
* @param String
*/ */
public void setCommandLinePattern(String pattern); public void setCommandLinePattern(String pattern);
@ -544,9 +526,6 @@ public interface ITool extends IHoldsOptions {
* the environment macro references converted to the buildfile variable format, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
* *
* @return String[]
* @throws BuildException
*
* @deprecated - use getToolCommandFlags instead * @deprecated - use getToolCommandFlags instead
*/ */
@Deprecated @Deprecated
@ -578,11 +557,6 @@ public interface ITool extends IHoldsOptions {
* chosen to keep the environment build macros unresolved, the flags contain * chosen to keep the environment build macros unresolved, the flags contain
* the environment macro references converted to the buildfile variable format, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
*
* @param inputFileLocation
* @param outputFileLocation
* @return
* @throws BuildException
*/ */
public String[] getToolCommandFlags(IPath inputFileLocation, IPath outputFileLocation) 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 * chosen to keep the environment build macros unresolved, the string contains
* the environment macro references converted to the buildfile variable format, * the environment macro references converted to the buildfile variable format,
* all other macro references are resolved * all other macro references are resolved
*
* @param inputFileLocation
* @param outputFileLocation
* @return
* @throws BuildException
*/ */
public String getToolCommandFlagsString(IPath inputFileLocation, IPath outputFileLocation) 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);
@ -689,15 +656,11 @@ public interface ITool extends IHoldsOptions {
/** /**
* Sets the 'versionsSupported' attribute of the tool. * Sets the 'versionsSupported' attribute of the tool.
*
* @param versionsSupported
*/ */
public void setVersionsSupported(String versionsSupported); public void setVersionsSupported(String versionsSupported);
/** /**
* Sets the 'convertToId' attribute of the tool. * Sets the 'convertToId' attribute of the tool.
*
* @param convertToId
*/ */
public void setConvertToId(String convertToId); public void setConvertToId(String convertToId);

View file

@ -63,10 +63,10 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Creates the <code>TargetPlatform</code> child of this tool-chain. * Creates the <code>TargetPlatform</code> child of this tool-chain.
* *
* @param ITargetPlatform The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new tool chain * @param Id The id for the new tool chain
* @param String The name for the new tool chain * @param name The name for the new tool chain
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return ITargetPlatform * @return ITargetPlatform
*/ */
@ -102,26 +102,22 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Sets the 'versionsSupported' attribute of the tool-chain. * Sets the 'versionsSupported' attribute of the tool-chain.
*
* @param versionsSupported
*/ */
public void setVersionsSupported(String versionsSupported); public void setVersionsSupported(String versionsSupported);
/** /**
* Sets the 'convertToId' attribute of the tool-chain. * Sets the 'convertToId' attribute of the tool-chain.
*
* @param convertToId
*/ */
public void setConvertToId(String convertToId); public void setConvertToId(String convertToId);
/** /**
* Creates the <code>Builder</code> child of this tool-chain. * Creates the <code>Builder</code> child of this tool-chain.
* *
* @param IBuilder The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new tool chain * @param Id The id for the new tool chain
* @param String The name for the new tool chain * @param name The name for the new tool chain
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return IBuilder * @return IBuilder
*/ */
@ -143,10 +139,10 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Creates a <code>Tool</code> child of this tool-chain. * Creates a <code>Tool</code> child of this tool-chain.
* *
* @param ITool The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new tool chain * @param Id The id for the new tool chain
* @param String The name for the new tool chain * @param name The name for the new tool chain
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
* *
* @return ITool * @return ITool
*/ */
@ -199,8 +195,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Sets the isAbstract attribute of the tool-chain. * Sets the isAbstract attribute of the tool-chain.
*
* @param b
*/ */
public void setIsAbstract(boolean b); public void setIsAbstract(boolean b);
@ -222,7 +216,7 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Sets the OS list. * Sets the OS list.
* *
* @param String[] The list of OS names * @param OSs The list of OS names
*/ */
public void setOSList(String[] OSs); public void setOSList(String[] OSs);
@ -236,7 +230,7 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Sets the architecture list. * Sets the architecture list.
* *
* @param String[] The list of architecture names * @param archs The list of architecture names
*/ */
public void setArchList(String[] archs); 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 * Returns the semicolon separated list of unique IDs of the error parsers associated
* with the tool-chain, filtered for the specified configuration. * with the tool-chain, filtered for the specified configuration.
*
* @param config
* @return String
*/ */
public String getErrorParserIds(IConfiguration config); public String getErrorParserIds(IConfiguration config);
@ -267,8 +258,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Sets the semicolon separated list of error parser ids. * Sets the semicolon separated list of error parser ids.
*
* @param ids
*/ */
public void setErrorParserIds(String ids); public void setErrorParserIds(String ids);
@ -281,8 +270,6 @@ public interface IToolChain extends IBuildObject, IHoldsOptions {
/** /**
* Sets the scanner config discovery profile id. * Sets the scanner config discovery profile id.
*
* @param profileId
*/ */
public void setScannerConfigDiscoveryProfileId(String 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 * Sets the sem-colon separated list of Tool ids containing each
* tool that can create the final build artifact (the end target of * tool that can create the final build artifact (the end target of
* the build). * the build).
*
* @param targetToolIds
*/ */
public void setTargetToolIds(String 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 * Sets the semicolon separated list of OutputType identifiers in
* this tool-chain, besides the primary output of the targetTool, * this tool-chain, besides the primary output of the targetTool,
* that are also considered to be build artifacts. * that are also considered to be build artifacts.
*
* @param ids
*/ */
public void setSecondaryOutputs(String 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. * Sets the element's "dirty" (have I been modified?) flag.
*
* @param isDirty
*/ */
public void setDirty(boolean isDirty); public void setDirty(boolean isDirty);

View file

@ -26,9 +26,6 @@ public interface IToolReference extends ITool {
/** /**
* Answers a reference to the option. If the reference does not exist, * Answers a reference to the option. If the reference does not exist,
* a new reference is created. * a new reference is created.
*
* @param option
* @return OptionReference
*/ */
public OptionReference createOptionReference(IOption option); public OptionReference createOptionReference(IOption option);
@ -41,8 +38,6 @@ public interface IToolReference extends ITool {
/** /**
* Answers the tool that the reference has been created for. * Answers the tool that the reference has been created for.
*
* @return
*/ */
public ITool getTool(); public ITool getTool();
@ -57,7 +52,7 @@ public interface IToolReference extends ITool {
* Answers <code>true</code> if the reference is a reference to the * Answers <code>true</code> if the reference is a reference to the
* tool specified in the argument. * tool specified in the argument.
* *
* @param target the tool that should be tested * @param tool the tool that should be tested
* @return boolean * @return boolean
*/ */
public boolean references(ITool tool); 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. * Set the tool command in the receiver to be the argument.
* *
* @param cmd
* @return <code>true</code> if the command is changed, else <code>false</code> * @return <code>true</code> if the command is changed, else <code>false</code>
*/ */
public boolean setToolCommand(String cmd); public boolean setToolCommand(String cmd);

View file

@ -4485,7 +4485,6 @@ public class ManagedBuildManager extends AbstractCExtension {
* Build the specified build configurations * Build the specified build configurations
* @param configs - configurations to build * @param configs - configurations to build
* @param monitor - progress monitor * @param monitor - progress monitor
* @throws CoreException
*/ */
public static void buildConfigurations(IConfiguration[] configs, IProgressMonitor monitor) throws CoreException{ public static void buildConfigurations(IConfiguration[] configs, IProgressMonitor monitor) throws CoreException{
buildConfigurations(configs, null, monitor); buildConfigurations(configs, null, monitor);
@ -4496,7 +4495,6 @@ public class ManagedBuildManager extends AbstractCExtension {
* @param configs - configurations to build * @param configs - configurations to build
* @param builder - builder to retrieve build arguments * @param builder - builder to retrieve build arguments
* @param monitor - progress monitor * @param monitor - progress monitor
* @throws CoreException
*/ */
public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor) throws CoreException{ public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor) throws CoreException{
buildConfigurations(configs, builder, monitor, true); buildConfigurations(configs, builder, monitor, true);
@ -4510,8 +4508,6 @@ public class ManagedBuildManager extends AbstractCExtension {
* @param monitor - progress monitor * @param monitor - progress monitor
* @param allBuilders - {@code true} if all builders need to be building * @param allBuilders - {@code true} if all builders need to be building
* or {@code false} to build with {@link CommonBuilder} * or {@code false} to build with {@link CommonBuilder}
*
* @throws CoreException
*/ */
public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor, boolean allBuilders) throws CoreException{ public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor, boolean allBuilders) throws CoreException{
buildConfigurations(configs, builder, monitor, allBuilders, IncrementalProjectBuilder.FULL_BUILD); buildConfigurations(configs, builder, monitor, allBuilders, IncrementalProjectBuilder.FULL_BUILD);
@ -4530,8 +4526,6 @@ public class ManagedBuildManager extends AbstractCExtension {
* <li>{@link IncrementalProjectBuilder#INCREMENTAL_BUILD}</li> * <li>{@link IncrementalProjectBuilder#INCREMENTAL_BUILD}</li>
* <li>{@link IncrementalProjectBuilder#FULL_BUILD}</li> * <li>{@link IncrementalProjectBuilder#FULL_BUILD}</li>
* *
* @throws CoreException
*
* @since 7.0 * @since 7.0
*/ */
public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor, public static void buildConfigurations(IConfiguration[] configs, IBuilder builder, IProgressMonitor monitor,

View file

@ -39,7 +39,7 @@ public class ManagedCProjectNature implements IProjectNature {
/** /**
* Utility method for adding a managed nature to a project. * 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 * @param monitor a progress monitor to indicate the duration of the operation, or
* <code>null</code> if progress reporting is not required. * <code>null</code> if progress reporting is not required.
*/ */
@ -91,7 +91,7 @@ public class ManagedCProjectNature implements IProjectNature {
/** /**
* Utility method for adding a nature to a project. * 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 natureId the id of the nature to assign to the project
* @param monitor a progress monitor to indicate the duration of the operation, or * @param monitor a progress monitor to indicate the duration of the operation, or
* <code>null</code> if progress reporting is not required. * <code>null</code> if progress reporting is not required.
@ -190,7 +190,6 @@ public class ManagedCProjectNature implements IProjectNature {
* @param project to remove the managed nature from * @param project to remove the managed nature from
* @param mon progress monitor to indicate the duration of the operation, or * @param mon progress monitor to indicate the duration of the operation, or
* <code>null</code> if progress reporting is not required. * <code>null</code> if progress reporting is not required.
* @throws CoreException
*/ */
public static void removeManagedNature(IProject project, IProgressMonitor mon) throws CoreException { public static void removeManagedNature(IProject project, IProgressMonitor mon) throws CoreException {
removeNature(project, MNG_NATURE_ID, mon); 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. * 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 natureId the nature id to remove
* @param monitor a progress monitor to indicate the duration of the operation, or * @param monitor a progress monitor to indicate the duration of the operation, or
* <code>null</code> if progress reporting is not required. * <code>null</code> if progress reporting is not required.

View file

@ -72,12 +72,6 @@ public final class OptionStringValue {
/** /**
* source path settings are applicable for the {@link IOption#LIBRARY_FILES} only * 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){ public OptionStringValue(String value, boolean isBuiltIn, String srcPath, String srcRootPath, String srcPrefixMapping){
if(value == null) if(value == null)
@ -112,8 +106,6 @@ public final class OptionStringValue {
* source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only * source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only
* added to fully support the {@link ICLibraryFileEntry} settings * added to fully support the {@link ICLibraryFileEntry} settings
* *
* @return
*
* @see ICLibraryFileEntry * @see ICLibraryFileEntry
* @see ICLibraryFileEntry#getSourceAttachmentPath() * @see ICLibraryFileEntry#getSourceAttachmentPath()
* @see ICLibraryFileEntry#getSourceAttachmentRootPath() * @see ICLibraryFileEntry#getSourceAttachmentRootPath()
@ -128,8 +120,6 @@ public final class OptionStringValue {
* source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only * source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only
* added to fully support the {@link ICLibraryFileEntry} settings * added to fully support the {@link ICLibraryFileEntry} settings
* *
* @return
*
* @see ICLibraryFileEntry * @see ICLibraryFileEntry
* @see ICLibraryFileEntry#getSourceAttachmentPath() * @see ICLibraryFileEntry#getSourceAttachmentPath()
* @see ICLibraryFileEntry#getSourceAttachmentRootPath() * @see ICLibraryFileEntry#getSourceAttachmentRootPath()
@ -144,8 +134,6 @@ public final class OptionStringValue {
* source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only * source attachment settings are applicable for the {@link IOption#LIBRARY_FILES} only
* added to fully support the {@link ICLibraryFileEntry} settings * added to fully support the {@link ICLibraryFileEntry} settings
* *
* @return
*
* @see ICLibraryFileEntry * @see ICLibraryFileEntry
* @see ICLibraryFileEntry#getSourceAttachmentPath() * @see ICLibraryFileEntry#getSourceAttachmentPath()
* @see ICLibraryFileEntry#getSourceAttachmentRootPath() * @see ICLibraryFileEntry#getSourceAttachmentRootPath()

View file

@ -151,8 +151,7 @@ public class BuildProcessManager {
} }
/** /**
* * @return Number of processors detected
* @return
*/ */
static public int checkCPUNumber() { static public int checkCPUNumber() {
if (procNumber > 0) return procNumber; if (procNumber > 0) return procNumber;

View file

@ -104,9 +104,6 @@ public class ParallelBuilder {
/** /**
* Updates level value * Updates level value
*
* @param _step
* @param _level
*/ */
public boolean check(IBuildStep _step, int _level) { public boolean check(IBuildStep _step, int _level) {
if (level < _level && step.equals(_step)) { if (level < _level && step.equals(_step)) {
@ -464,7 +461,6 @@ public class ParallelBuilder {
/** /**
* Updates info about generated files (after step completed) * Updates info about generated files (after step completed)
* @param step
*/ */
protected void refreshOutputs(IBuildStep step){ protected void refreshOutputs(IBuildStep step){
IProgressMonitor mon = new NullProgressMonitor(); IProgressMonitor mon = new NullProgressMonitor();

View file

@ -58,8 +58,8 @@ public class AdditionalInput implements IAdditionalInput {
* This constructor is called to create an AdditionalInput whose attributes and children will be * This constructor is called to create an AdditionalInput whose attributes and children will be
* added by separate calls. * added by separate calls.
* *
* @param InputType The parent of the an AdditionalInput * @param parent The parent of the an AdditionalInput
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
*/ */
public AdditionalInput(InputType parent, boolean isExtensionElement) { public AdditionalInput(InputType parent, boolean isExtensionElement) {
this.parent = parent; this.parent = parent;
@ -162,9 +162,6 @@ public class AdditionalInput implements IAdditionalInput {
/** /**
* Persist the AdditionalInput to the project file. * Persist the AdditionalInput to the project file.
*
* @param doc
* @param element
*/ */
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {

View file

@ -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 * This constructor is called to create a Builder whose attributes and children will be
* added by separate calls. * added by separate calls.
* *
* @param ToolChain The parent of the builder, if any * @param parent The parent of the builder, if any
* @param Builder The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new Builder * @param Id The id for the new Builder
* @param String The name for the new Builder * @param name The name for the new Builder
* @param boolean Indicates whether this is an extension element or a managed project element * @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) { public Builder(ToolChain parent, IBuilder superClass, String Id, String name, boolean isExtensionElement) {
this.parent = parent; this.parent = parent;
@ -754,9 +754,6 @@ public class Builder extends BuildObject implements IBuilder, IMatchKeyProvider,
/** /**
* Persist the builder to the project file. * Persist the builder to the project file.
*
* @param doc
* @param element
*/ */
public void serialize(ICStorageElement element, boolean resetDirtyState) { public void serialize(ICStorageElement element, boolean resetDirtyState) {
if (superClass != null) if (superClass != null)

View file

@ -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$ 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) { private boolean isGeneratedResource(IResource resource) {
// Is this a generated directory ... // Is this a generated directory ...
IPath path = resource.getFullPath(); IPath path = resource.getFullPath();
@ -288,10 +284,6 @@ public class CommonBuilder extends ACBuilder {
return false; return false;
} }
/**
* @param resource
* @return
*/
private boolean isProjectFile(IResource resource) { private boolean isProjectFile(IResource resource) {
return reservedNames.contains(resource.getName()); return reservedNames.contains(resource.getName());
} }
@ -1985,7 +1977,6 @@ public class CommonBuilder extends ACBuilder {
/** /**
* Check whether the build has been canceled. * Check whether the build has been canceled.
* @param monitor
*/ */
public void checkCancel(IProgressMonitor monitor) { public void checkCancel(IProgressMonitor monitor) {
if (monitor != null && monitor.isCanceled()) if (monitor != null && monitor.isCanceled())
@ -2049,8 +2040,6 @@ public class CommonBuilder extends ACBuilder {
/** /**
* Parsing arguments in a shell style * Parsing arguments in a shell style
* @param builder
* @return
*/ */
private String[] argumentsToArray(String args) { private String[] argumentsToArray(String args) {
return CommandLineUtil.argumentsToArray(args); return CommandLineUtil.argumentsToArray(args);

View file

@ -195,9 +195,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 {
/** /**
* A fresh new configuration for a target. * A fresh new configuration for a target.
*
* @param target
* @param id
*/ */
public ConfigurationV2(Target target, String id) { public ConfigurationV2(Target target, String id) {
this.id = id; this.id = id;
@ -219,8 +216,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 {
/** /**
* Adds a tool reference to the receiver. * Adds a tool reference to the receiver.
*
* @param toolRef
*/ */
public void addToolReference(ToolReference toolRef) { public void addToolReference(ToolReference toolRef) {
getLocalToolReferences().add(toolRef); getLocalToolReferences().add(toolRef);
@ -534,9 +529,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 {
return null; return null;
} }
/**
* @param targetElement
*/
public void reset(IManagedConfigElement element) { public void reset(IManagedConfigElement element) {
// I just need to reset the tool references // I just need to reset the tool references
getLocalToolReferences().clear(); getLocalToolReferences().clear();
@ -553,9 +545,6 @@ public class ConfigurationV2 extends BuildObject implements IConfigurationV2 {
/** /**
* Persist receiver to project file. * Persist receiver to project file.
*
* @param doc
* @param element
*/ */
public void serialize(Document doc, Element element) { public void serialize(Document doc, Element element) {
element.setAttribute(IConfigurationV2.ID, id); element.setAttribute(IConfigurationV2.ID, id);

View file

@ -24,9 +24,6 @@ public class DefaultManagedConfigElement implements IManagedConfigElement {
private IConfigurationElement element; private IConfigurationElement element;
private IExtension extension; private IExtension extension;
/**
* @param element
*/
public DefaultManagedConfigElement(IConfigurationElement element, IExtension extension) { public DefaultManagedConfigElement(IConfigurationElement element, IExtension extension) {
this.element = element; this.element = element;
this.extension = extension; this.extension = extension;
@ -67,9 +64,6 @@ public class DefaultManagedConfigElement implements IManagedConfigElement {
return extension; return extension;
} }
/**
* @return
*/
public IConfigurationElement getConfigurationElement() { public IConfigurationElement getConfigurationElement() {
return element; return element;
} }

View file

@ -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$ 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) { private boolean isGeneratedResource(IResource resource) {
// Is this a generated directory ... // Is this a generated directory ...
IPath path = resource.getProjectRelativePath(); IPath path = resource.getProjectRelativePath();
@ -138,10 +134,6 @@ public class GeneratedMakefileBuilder extends ACBuilder {
return false; return false;
} }
/**
* @param resource
* @return
*/
private boolean isProjectFile(IResource resource) { private boolean isProjectFile(IResource resource) {
return reservedNames.contains(resource.getName()); return reservedNames.contains(resource.getName());
} }
@ -335,9 +327,6 @@ public class GeneratedMakefileBuilder extends ACBuilder {
public GeneratedMakefileBuilder() { public GeneratedMakefileBuilder() {
} }
/**
* @param epm
*/
private void addBuilderMarkers(ErrorParserManager epm) { private void addBuilderMarkers(ErrorParserManager epm) {
IWorkspaceRoot root = CCorePlugin.getWorkspace().getRoot(); IWorkspaceRoot root = CCorePlugin.getWorkspace().getRoot();
Iterator<IStatus> iter = getGenerationProblems().iterator(); Iterator<IStatus> iter = getGenerationProblems().iterator();
@ -569,7 +558,6 @@ public class GeneratedMakefileBuilder extends ACBuilder {
/** /**
* Check whether the build has been canceled. Cancellation requests * Check whether the build has been canceled. Cancellation requests
* propagated to the caller by throwing <code>OperationCanceledException</code>. * propagated to the caller by throwing <code>OperationCanceledException</code>.
* @param monitor
* *
* @see org.eclipse.core.runtime.OperationCanceledException#OperationCanceledException() * @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 { private void initNewBuildConsole(IProject currentProject) throws CoreException {
// Get a build console for the project // Get a build console for the project
console = CCorePlugin.getDefault().getConsole(); console = CCorePlugin.getDefault().getConsole();

View file

@ -191,7 +191,6 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
* class only, thus do not handle exceptions. * class only, thus do not handle exceptions.
* *
* @param element where to serialize the tool * @param element where to serialize the tool
* @throws BuildException
*/ */
protected void serialize(ICStorageElement element) throws BuildException { protected void serialize(ICStorageElement element) throws BuildException {
if (childOptionCategories != null) { 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 * 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 * Memory-safe way to access the vector of category IDs
*/ */
private Vector<String> getCategoryIds() { private Vector<String> getCategoryIds() {
@ -406,23 +405,17 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
return categoryIds; return categoryIds;
} }
/**
* @param category
*/
public void addChildCategory(IOptionCategory category) { public void addChildCategory(IOptionCategory category) {
if (childOptionCategories == null) if (childOptionCategories == null)
childOptionCategories = new ArrayList<IOptionCategory>(); childOptionCategories = new ArrayList<IOptionCategory>();
childOptionCategories.add(category); childOptionCategories.add(category);
} }
/**
* @param option
*/
public void addOption(Option option) { public void addOption(Option option) {
getOptionMap().put(option.getId(), 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<String, IOptionCategory> getCategoryMap() { private Map<String, IOptionCategory> getCategoryMap() {
if (categoryMap == null) { if (categoryMap == null) {
@ -431,7 +424,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
return categoryMap; return categoryMap;
} }
/* (non-Javadoc) /**
* Memory-safe way to access the list of options * Memory-safe way to access the list of options
*/ */
private Collection<Option> getOptionCollection() { private Collection<Option> getOptionCollection() {
@ -441,7 +434,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
else return Collections.emptyList(); else return Collections.emptyList();
} }
/* (non-Javadoc) /**
* Memory-safe way to access the list of IDs to options * Memory-safe way to access the list of IDs to options
*/ */
private Map<String, Option> getOptionMap() { private Map<String, Option> getOptionMap() {
@ -477,7 +470,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
* O B J E C T S T A T E M A I N T E N A N C E * O B J E C T S T A T E M A I N T E N A N C E
*/ */
/* (non-Javadoc) /**
* Implements isDirty() for children of HoldsOptions. Intended to be * Implements isDirty() for children of HoldsOptions. Intended to be
* called by derived class. * called by derived class.
*/ */
@ -493,7 +486,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
return isDirty; return isDirty;
} }
/* (non-Javadoc) /**
* Implements setDirty() for children of HoldsOptions. Intended to be * Implements setDirty() for children of HoldsOptions. Intended to be
* called by derived class. * called by derived class.
*/ */
@ -507,7 +500,7 @@ public abstract class HoldsOptions extends BuildObject implements IHoldsOptions,
} }
} }
/* (non-Javadoc) /**
* Resolve the element IDs to interface references. Intended to be * Resolve the element IDs to interface references. Intended to be
* called by derived class. * called by derived class.
*/ */

View file

@ -16,9 +16,6 @@ import org.eclipse.cdt.managedbuilder.core.IInputType;
import org.eclipse.cdt.managedbuilder.core.IManagedConfigElement; import org.eclipse.cdt.managedbuilder.core.IManagedConfigElement;
public class InputOrder implements IInputOrder { public class InputOrder implements IInputOrder {
private static final String EMPTY_STRING = new String();
// Superclass // Superclass
// Parent and children // Parent and children
private IInputType parent; private IInputType parent;
@ -58,8 +55,8 @@ public class InputOrder implements IInputOrder {
* This constructor is called to create an InputOrder whose attributes and children will be * This constructor is called to create an InputOrder whose attributes and children will be
* added by separate calls. * added by separate calls.
* *
* @param InputType The parent of the an InputOrder * @param parent The parent of the an InputOrder
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
*/ */
public InputOrder(InputType parent, boolean isExtensionElement) { public InputOrder(InputType parent, boolean isExtensionElement) {
this.parent = parent; this.parent = parent;
@ -165,9 +162,6 @@ public class InputOrder implements IInputOrder {
/** /**
* Persist the InputOrder to the project file. * Persist the InputOrder to the project file.
*
* @param doc
* @param element
*/ */
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {

View file

@ -619,8 +619,6 @@ public class InputType extends BuildObject implements IInputType {
/** /**
* Persist the InputType to the project file. * Persist the InputType to the project file.
*
* @param element
*/ */
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {
if (superClass != null) if (superClass != null)

View file

@ -94,9 +94,7 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
/** /**
* Basic contructor used when the project is brand new. * Basic constructor used when the project is brand new.
*
* @param owner
*/ */
public ManagedBuildInfo(IResource owner) { public ManagedBuildInfo(IResource owner) {
this.owner = owner; this.owner = owner;
@ -110,11 +108,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
/** /**
* Reads the build information from the project file and creates the * Reads the build information from the project file and creates the
* internal representation of the build settings for the project. * internal representation of the build settings for the project.
*
* @param owner
* @param element
* @param loadConfigs
* @param managedBuildRevision
*/ */
public ManagedBuildInfo(IResource owner, ICStorageElement element, boolean loadConfigs, String managedBuildRevision) { public ManagedBuildInfo(IResource owner, ICStorageElement element, boolean loadConfigs, String managedBuildRevision) {
this(owner); this(owner);
@ -723,9 +716,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
/** /**
* Write the contents of the build model to the persistent store * Write the contents of the build model to the persistent store
* specified in the argument. * specified in the argument.
*
* @param doc
* @param element
* @deprecated as of CDT 7.0 * @deprecated as of CDT 7.0
*/ */
@Deprecated @Deprecated
@ -865,9 +855,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
rebuildNeeded = rebuild; rebuildNeeded = rebuild;
} }
/**
* @param version
*/
public void setVersion(String version) { public void setVersion(String version) {
updateRevision(version); updateRevision(version);
if (version != null && !version.equals(this.version)) if (version != null && !version.equals(this.version))
@ -875,9 +862,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
//setDirty(true); - It is primarily up to the ManagedProject to maintain the dirty state //setDirty(true); - It is primarily up to the ManagedProject to maintain the dirty state
} }
/**
* @param bInited
*/
public void setContainerInited(boolean bInited) { public void setContainerInited(boolean bInited) {
bIsContainerInited = bInited; bIsContainerInited = bInited;
} }
@ -891,8 +875,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
/** /**
* Sets the owner of the receiver to be the <code>IResource</code> specified * Sets the owner of the receiver to be the <code>IResource</code> specified
* in the argument. * in the argument.
*
* @param resource
*/ */
public void updateOwner(IResource resource) { public void updateOwner(IResource resource) {
// Check to see if the owner is the same as the argument // Check to see if the owner is the same as the argument
@ -983,10 +965,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
return targetList; return targetList;
} }
/**
*
* @return
*/
private String getCWD() { private String getCWD() {
String cwd = ""; //$NON-NLS-1$ String cwd = ""; //$NON-NLS-1$
IBuildEnvironmentVariable cwdvar = ManagedBuildManager.getEnvironmentVariableProvider().getVariable("CWD", getDefaultConfiguration(), false, true); //$NON-NLS-1$ IBuildEnvironmentVariable cwdvar = ManagedBuildManager.getEnvironmentVariableProvider().getVariable("CWD", getDefaultConfiguration(), false, true); //$NON-NLS-1$
@ -1090,11 +1068,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
return entries.toArray(new IPathEntry[entries.size()]); return entries.toArray(new IPathEntry[entries.size()]);
} }
/**
*
* @param entryType
* @return IPathEntry[]
*/
public IPathEntry[] getManagedBuildValues(int entryType) { public IPathEntry[] getManagedBuildValues(int entryType) {
// obtain option values // obtain option values
List<IPathEntry> entries = getOptionValues(entryType, false); List<IPathEntry> entries = getOptionValues(entryType, false);
@ -1107,10 +1080,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
return entries.toArray(new IPathEntry[entries.size()]); return entries.toArray(new IPathEntry[entries.size()]);
} }
/**
* @param entryType
* @return IPathEntry[]
*/
public IPathEntry[] getManagedBuildBuiltIns(int entryType) { public IPathEntry[] getManagedBuildBuiltIns(int entryType) {
List<IPathEntry> entries = getOptionValues(entryType, true); List<IPathEntry> entries = getOptionValues(entryType, true);
return entries.toArray(new IPathEntry[entries.size()]); return entries.toArray(new IPathEntry[entries.size()]);
@ -1159,7 +1128,7 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
/** /**
* *
* @param optionType - data type: include | library | symbols * @param entryType - data type: include | library | symbols
* @param entries - list to be affected * @param entries - list to be affected
* @param builtIns - whether get actual values or builtins * @param builtIns - whether get actual values or builtins
* @param obj - object to be processed (ResCfg | Cfg) * @param obj - object to be processed (ResCfg | Cfg)
@ -1220,15 +1189,6 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
return entries; return entries;
} }
/**
*
* @param entries
* @param values
* @param resPath
* @param context
* @param obj
* @return List<IPathEntry>
*/
protected List<IPathEntry> addIncludes(List<IPathEntry> entries, String[] values, IPath resPath, int context ,Object obj) { protected List<IPathEntry> addIncludes(List<IPathEntry> entries, String[] values, IPath resPath, int context ,Object obj) {
return addPaths(entries, values, resPath, context, obj, IPathEntry.CDT_INCLUDE); return addPaths(entries, values, resPath, context, obj, IPathEntry.CDT_INCLUDE);
} }
@ -1257,28 +1217,10 @@ public class ManagedBuildInfo implements IManagedBuildInfo, IScannerInfo {
return entries; return entries;
} }
/**
*
* @param entries
* @param values
* @param resPath
* @param context
* @param obj
* @return List<IPathEntry>
*/
protected List<IPathEntry> addLibraries(List<IPathEntry> entries, String[] values, IPath resPath, int context, Object obj) { protected List<IPathEntry> addLibraries(List<IPathEntry> entries, String[] values, IPath resPath, int context, Object obj) {
return addPaths(entries, values, resPath, context, obj, IPathEntry.CDT_LIBRARY); return addPaths(entries, values, resPath, context, obj, IPathEntry.CDT_LIBRARY);
} }
/**
*
* @param entries
* @param values
* @param resPath
* @param context
* @param obj
* @return List<IPathEntry>
*/
protected List<IPathEntry> addSymbols(List<IPathEntry> entries, String[] values, IPath resPath, int context, Object obj) { protected List<IPathEntry> addSymbols(List<IPathEntry> entries, String[] values, IPath resPath, int context, Object obj) {
if (values == null) return entries; if (values == null) return entries;
for (int i=0; i<values.length; i++) { for (int i=0; i<values.length; i++) {

View file

@ -74,7 +74,6 @@ public class ManagedProject extends BuildObject implements IManagedProject, IBui
* that is owned by the specified Eclipse project. * that is owned by the specified Eclipse project.
* *
* @param owner the Eclipse project that owns the Managed Project * @param owner the Eclipse project that owns the Managed Project
* @param projectType
*/ */
public ManagedProject(IResource owner, IProjectType projectType) { public ManagedProject(IResource owner, IProjectType projectType) {
// Make the owner of the ProjectType the project resource // Make the owner of the ProjectType the project resource
@ -115,8 +114,6 @@ public class ManagedProject extends BuildObject implements IManagedProject, IBui
/** /**
* Create the project instance from project file. * Create the project instance from project file.
* *
* @param buildInfo
* @param element
* @param managedBuildRevision the fileVersion of Managed Build System * @param managedBuildRevision the fileVersion of Managed Build System
*/ */
public ManagedProject(ManagedBuildInfo buildInfo, ICStorageElement element, boolean loadConfigs, String managedBuildRevision) { public ManagedProject(ManagedBuildInfo buildInfo, ICStorageElement element, boolean loadConfigs, String managedBuildRevision) {

View file

@ -1163,7 +1163,6 @@ public class MultiConfiguration extends MultiItemsHolder implements
/** /**
* Returns "default" configuration. * Returns "default" configuration.
* @return
*/ */
private IConfiguration curr() { private IConfiguration curr() {
return fCfgs[curr]; return fCfgs[curr];

View file

@ -704,7 +704,6 @@ public class Option extends BuildObject implements IOption, IBuildPropertiesRest
* Persist the option to the {@link ICStorageElement}. * Persist the option to the {@link ICStorageElement}.
* *
* @param element - storage element to persist the option * @param element - storage element to persist the option
* @throws BuildException
*/ */
public void serialize(ICStorageElement element) throws BuildException { public void serialize(ICStorageElement element) throws BuildException {
if (superClass != null) if (superClass != null)

View file

@ -184,9 +184,6 @@ public class OptionCategory extends BuildObject implements IOptionCategory {
/** /**
* Persist the OptionCategory to the project file. * Persist the OptionCategory to the project file.
*
* @param doc
* @param element
*/ */
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {
element.setAttribute(IBuildObject.ID, id); element.setAttribute(IBuildObject.ID, id);
@ -490,7 +487,7 @@ public class OptionCategory extends BuildObject implements IOptionCategory {
* a concatenation of the tool and categories, e.g. Tool->Cat1->Cat2 * a concatenation of the tool and categories, e.g. Tool->Cat1->Cat2
* maps onto the string "Tool|Cat1|Cat2|" * maps onto the string "Tool|Cat1|Cat2|"
* *
* @param category or tool for which to build the match name * @param catOrTool category or tool for which to build the match name
* @return match name * @return match name
*/ */
static public String makeMatchName(IBuildObject catOrTool) { static public String makeMatchName(IBuildObject catOrTool) {
@ -515,7 +512,7 @@ public class OptionCategory extends BuildObject implements IOptionCategory {
* e.g. Tool->Cat1->Cat2 maps onto the string "Tool|Cat1|Cat2|" * e.g. Tool->Cat1->Cat2 maps onto the string "Tool|Cat1|Cat2|"
* *
* @param matchName an identifier to search * @param matchName an identifier to search
* @param categories as returned by getChildCategories(), i.e. non-flattened * @param cats as returned by getChildCategories(), i.e. non-flattened
* @return category or tool, if found and null otherwise * @return category or tool, if found and null otherwise
*/ */
static public Object findOptionCategoryByMatchName(String matchName, IOptionCategory[] cats) { static public Object findOptionCategoryByMatchName(String matchName, IOptionCategory[] cats) {

View file

@ -57,9 +57,6 @@ public class OptionReference implements IOption {
/** /**
* This constructor will be called when the receiver is created from * This constructor will be called when the receiver is created from
* the settings found in an extension point. * the settings found in an extension point.
*
* @param owner
* @param element
*/ */
public OptionReference(ToolReference owner, IManagedConfigElement element) { public OptionReference(ToolReference owner, IManagedConfigElement element) {
// setup for resolving // setup for resolving
@ -75,9 +72,6 @@ public class OptionReference implements IOption {
/** /**
* Constructor called when the option reference is created from an * Constructor called when the option reference is created from an
* existing <code>IOption</code> * existing <code>IOption</code>
*
* @param owner
* @param option
*/ */
public OptionReference(ToolReference owner, IOption option) { public OptionReference(ToolReference owner, IOption option) {
this.owner = owner; this.owner = owner;
@ -89,9 +83,6 @@ public class OptionReference implements IOption {
/** /**
* Created from project file. * Created from project file.
*
* @param owner
* @param element
*/ */
public OptionReference(ToolReference owner, Element element) { public OptionReference(ToolReference owner, Element element) {
this.owner = owner; this.owner = owner;
@ -234,9 +225,6 @@ public class OptionReference implements IOption {
/** /**
* Persist receiver to project file. * Persist receiver to project file.
*
* @param doc
* @param element
*/ */
public void serialize(Document doc, Element element) { public void serialize(Document doc, Element element) {
element.setAttribute(ID, option.getId()); element.setAttribute(ID, option.getId());
@ -653,9 +641,6 @@ public class OptionReference implements IOption {
/** /**
* Answers <code>true</code> if the receiver is a reference to the * Answers <code>true</code> if the receiver is a reference to the
* <code>IOption</code> specified in the argument, esle answers <code>false</code>. * <code>IOption</code> specified in the argument, esle answers <code>false</code>.
*
* @param target
* @return boolean
*/ */
public boolean references(IOption target) { public boolean references(IOption target) {
if (equals(target)) { if (equals(target)) {
@ -674,9 +659,6 @@ public class OptionReference implements IOption {
* Sets the boolean value of the receiver to the value specified in the argument. * Sets the boolean value of the receiver to the value specified in the argument.
* If the receive is not a reference to a boolean option, method will throw an * If the receive is not a reference to a boolean option, method will throw an
* exception. * exception.
*
* @param value
* @throws BuildException
*/ */
public void setValue(boolean value) throws BuildException { public void setValue(boolean value) throws BuildException {
if (getValueType() == BOOLEAN) if (getValueType() == BOOLEAN)
@ -685,10 +667,6 @@ public class OptionReference implements IOption {
throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$ throw new BuildException(ManagedMakeMessages.getResourceString("Option.error.bad_value_type")); //$NON-NLS-1$
} }
/**
* @param value
* @throws BuildException
*/
public void setValue(String value) throws BuildException { public void setValue(String value) throws BuildException {
// Note that we can still set the human-readable value here // Note that we can still set the human-readable value here
if (getValueType() == STRING || getValueType() == ENUMERATED) { if (getValueType() == STRING || getValueType() == ENUMERATED) {
@ -702,7 +680,6 @@ public class OptionReference implements IOption {
* Sets the value of the receiver to be an array of items. * Sets the value of the receiver to be an array of items.
* *
* @param value An array of strings to place in the option reference. * @param value An array of strings to place in the option reference.
* @throws BuildException
*/ */
public void setValue(String [] value) throws BuildException { public void setValue(String [] value) throws BuildException {
if (getValueType() == STRING_LIST if (getValueType() == STRING_LIST

View file

@ -95,11 +95,11 @@ public class OutputType extends BuildObject implements IOutputType {
* This constructor is called to create an OutputType whose attributes will be * This constructor is called to create an OutputType whose attributes will be
* set by separate calls. * set by separate calls.
* *
* @param Tool The parent of the an OutputType * @param parent The parent of the an OutputType
* @param OutputType The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new OutputType * @param Id The id for the new OutputType
* @param String The name for the new OutputType * @param name The name for the new OutputType
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
*/ */
public OutputType(Tool parent, IOutputType superClass, String Id, String name, boolean isExtensionElement) { public OutputType(Tool parent, IOutputType superClass, String Id, String name, boolean isExtensionElement) {
this.parent = parent; this.parent = parent;
@ -357,9 +357,6 @@ public class OutputType extends BuildObject implements IOutputType {
/** /**
* Persist the OutputType to the project file. * Persist the OutputType to the project file.
*
* @param doc
* @param element
*/ */
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {
if (superClass != null) if (superClass != null)

View file

@ -78,9 +78,6 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
/** /**
* This constructor is called to create a projectType defined by an extension point in * This constructor is called to create a projectType defined by an extension point in
* a plugin manifest file. * a plugin manifest file.
*
* @param element
* @param managedBuildRevision
*/ */
public ProjectType(IManagedConfigElement element, String managedBuildRevision) { public ProjectType(IManagedConfigElement element, String managedBuildRevision) {
// setup for resolving // setup for resolving
@ -119,9 +116,9 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
* This constructor is called to create a project type whose attributes and children will be * This constructor is called to create a project type whose attributes and children will be
* added by separate calls. * added by separate calls.
* *
* @param ProjectType The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new project type * @param Id The id for the new project type
* @param String The name for the new project type * @param managedBuildRevision The name for the new project type
*/ */
public ProjectType(ProjectType superClass, String Id, String name, String managedBuildRevision) { public ProjectType(ProjectType superClass, String Id, String name, String managedBuildRevision) {
// setup for resolving // setup for resolving
@ -145,7 +142,7 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
* E L E M E N T A T T R I B U T E R E A D E R S A N D W R I T E R S * E L E M E N T A T T R I B U T E R E A D E R S A N D W R I T E R S
*/ */
/* (non-Javadoc) /**
* Load the project-type information from the XML element specified in the * Load the project-type information from the XML element specified in the
* argument * argument
* @param element An XML element containing the project type information * @param element An XML element containing the project type information
@ -268,10 +265,8 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
} }
} }
/* (non-Javadoc) /**
* Adds the Configuration to the Configuration list and map * Adds the Configuration to the Configuration list and map
*
* @param Tool
*/ */
public void addConfiguration(Configuration configuration) { public void addConfiguration(Configuration configuration) {
if(!configuration.isTemporary()){ if(!configuration.isTemporary()){
@ -280,7 +275,7 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
} }
} }
/* (non-Javadoc) /**
* Safe accessor for the list of configurations. * Safe accessor for the list of configurations.
* *
* @return List containing the configurations * @return List containing the configurations
@ -292,10 +287,8 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
return configList; return configList;
} }
/* (non-Javadoc) /**
* Safe accessor for the map of configuration ids to configurations * Safe accessor for the map of configuration ids to configurations
*
* @return
*/ */
private Map getConfigurationMap() { private Map getConfigurationMap() {
if (configMap == null) { if (configMap == null) {
@ -379,14 +372,14 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
return isTest.booleanValue(); return isTest.booleanValue();
} }
/* (non-Javadoc) /**
* Sets the isAbstract attribute * Sets the isAbstract attribute
*/ */
public void setIsAbstract(boolean b) { public void setIsAbstract(boolean b) {
isAbstract = new Boolean(b); isAbstract = new Boolean(b);
} }
/* (non-Javadoc) /**
* Sets the isTest attribute * Sets the isTest attribute
*/ */
public void setIsTest(boolean b) { public void setIsTest(boolean b) {
@ -397,7 +390,7 @@ public class ProjectType extends BuildObject implements IProjectType, IBuildProp
* O B J E C T S T A T E M A I N T E N A N C E * O B J E C T S T A T E M A I N T E N A N C E
*/ */
/* (non-Javadoc) /**
* Resolve the element IDs to interface references * Resolve the element IDs to interface references
*/ */
public void resolveReferences() { public void resolveReferences() {

View file

@ -69,7 +69,6 @@ public class ResourceConfiguration extends ResourceInfo implements IFileInfo {
* @param parent The IConfiguration parent of this resource configuration * @param parent The IConfiguration parent of this resource configuration
* @param element The resource configuration definition from the manifest file * @param element The resource configuration definition from the manifest file
* or a dynamic element provider * or a dynamic element provider
* @param managedBuildRevision
*/ */
public ResourceConfiguration(IConfiguration parent, IManagedConfigElement element, String managedBuildRevision) { public ResourceConfiguration(IConfiguration parent, IManagedConfigElement element, String managedBuildRevision) {
super(parent, element, true); super(parent, element, true);
@ -101,7 +100,6 @@ public class ResourceConfiguration extends ResourceInfo implements IFileInfo {
* *
* @param parent The <code>IConfiguration</code> the resource configuration will be added to. * @param parent The <code>IConfiguration</code> the resource configuration will be added to.
* @param element The XML element that contains the resource configuration settings. * @param element The XML element that contains the resource configuration settings.
* @param managedBuildRevision
*/ */
public ResourceConfiguration(IConfiguration parent, ICStorageElement element, String managedBuildRevision) { public ResourceConfiguration(IConfiguration parent, ICStorageElement element, String managedBuildRevision) {
super(parent, element, true); super(parent, element, true);
@ -171,9 +169,9 @@ public class ResourceConfiguration extends ResourceInfo implements IFileInfo {
/** /**
* Create a new resource configuration based on one already defined. * Create a new resource configuration based on one already defined.
* *
* @param managedProject The <code>ManagedProject</code> the configuration will be added to. * @param cfg The <code>IConfiguration</code> the resource configuration will be added to.
* @param parentConfig The <code>IConfiguration</code> to copy the settings from. * @param cloneConfig The <code>ResourceConfiguration</code> to copy the settings from.
* @param id A unique ID for the new configuration. * @param id A unique ID for the new resource configuration.
*/ */
public ResourceConfiguration(IConfiguration cfg, ResourceConfiguration cloneConfig, String id, Map superClassIdMap, boolean cloneChildren) { public ResourceConfiguration(IConfiguration cfg, ResourceConfiguration cloneConfig, String id, Map superClassIdMap, boolean cloneChildren) {
super(cfg, cloneConfig, id); super(cfg, cloneConfig, id);
@ -400,9 +398,6 @@ public class ResourceConfiguration extends ResourceInfo implements IFileInfo {
/** /**
* Persist the resource configuration to the project file. * Persist the resource configuration to the project file.
*
* @param doc
* @param element
*/ */
@Override @Override
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {

View file

@ -69,7 +69,6 @@ public class Target extends BuildObject implements ITarget {
* This constructor is called to create a target defined by an extension point in * This constructor is called to create a target defined by an extension point in
* a plugin manifest file. * a plugin manifest file.
* *
* @param element
* @param managedBuildRevision the fileVersion of Managed Build System * @param managedBuildRevision the fileVersion of Managed Build System
*/ */
public Target(IManagedConfigElement element, String managedBuildRevision) { public Target(IManagedConfigElement element, String managedBuildRevision) {
@ -159,10 +158,8 @@ public class Target extends BuildObject implements ITarget {
} }
} }
/* (non-Javadoc) /**
* Set the resource that owns the target. * Set the resource that owns the target.
*
* @param owner
*/ */
protected Target(IResource owner) { protected Target(IResource owner) {
this.owner = owner; this.owner = owner;
@ -171,9 +168,6 @@ public class Target extends BuildObject implements ITarget {
/** /**
* Create a copy of the target specified in the argument, * Create a copy of the target specified in the argument,
* that is owned by the owned by the specified resource. * that is owned by the owned by the specified resource.
*
* @param owner
* @param parent
*/ */
public Target(IResource owner, ITarget parent) { public Target(IResource owner, ITarget parent) {
// Make the owner of the target the project resource // Make the owner of the target the project resource
@ -202,9 +196,6 @@ public class Target extends BuildObject implements ITarget {
/** /**
* Create target from project file. * Create target from project file.
*
* @param buildInfo
* @param element
*/ */
public Target(ManagedBuildInfo buildInfo, Element element) { public Target(ManagedBuildInfo buildInfo, Element element) {
this(buildInfo.getOwner()); this(buildInfo.getOwner());
@ -266,9 +257,6 @@ public class Target extends BuildObject implements ITarget {
} }
} }
/**
* @param configuration
*/
public void addConfiguration(IConfigurationV2 configuration) { public void addConfiguration(IConfigurationV2 configuration) {
getConfigurationList().add(configuration); getConfigurationList().add(configuration);
getConfigurationMap().put(configuration.getId(), configuration); getConfigurationMap().put(configuration.getId(), configuration);
@ -277,8 +265,6 @@ public class Target extends BuildObject implements ITarget {
/** /**
* Adds a tool specification to the receiver. This tool is defined * Adds a tool specification to the receiver. This tool is defined
* only for the receiver, and cannot be shared by other targets. * only for the receiver, and cannot be shared by other targets.
*
* @param tool
*/ */
public void addTool(ITool tool) { public void addTool(ITool tool) {
getToolList().add(tool); getToolList().add(tool);
@ -287,19 +273,15 @@ public class Target extends BuildObject implements ITarget {
/** /**
* Adds a tool reference to the receiver. * Adds a tool reference to the receiver.
*
* @param toolRef
*/ */
public void addToolReference(ToolReference toolRef) { public void addToolReference(ToolReference toolRef) {
getLocalToolReferences().add(toolRef); getLocalToolReferences().add(toolRef);
} }
/* (non-Javadoc) /**
* Tail-recursion method that creates a lits of tools and tool reference * Tail-recursion method that creates a lits of tools and tool reference
* walking the receiver's parent hierarchy. * walking the receiver's parent hierarchy.
*
* @param toolArray
*/ */
private void addToolsToArray(Vector<ITool> toolArray) { private void addToolsToArray(Vector<ITool> toolArray) {
if (parent != null) { if (parent != null) {
@ -411,7 +393,7 @@ public class Target extends BuildObject implements ITarget {
return getConfigurationMap().get(id); return getConfigurationMap().get(id);
} }
/* (non-Javadoc) /**
* Safe accessor for the list of configurations. * Safe accessor for the list of configurations.
* *
* @return List containing the configurations * @return List containing the configurations
@ -423,10 +405,8 @@ public class Target extends BuildObject implements ITarget {
return configList; return configList;
} }
/* (non-Javadoc) /**
* Safe accessor for the map of configuration ids to configurations * Safe accessor for the map of configuration ids to configurations
*
* @return
*/ */
private Map<String, IConfigurationV2> getConfigurationMap() { private Map<String, IConfigurationV2> getConfigurationMap() {
if (configMap == null) { if (configMap == null) {
@ -496,7 +476,7 @@ public class Target extends BuildObject implements ITarget {
return errorParsers; return errorParsers;
} }
/* (non-javadoc) /**
* A safe accesor method. It answers the tool reference list in the * A safe accesor method. It answers the tool reference list in the
* receiver. * receiver.
* *
@ -559,11 +539,6 @@ public class Target extends BuildObject implements ITarget {
} }
} }
/* (non-javadoc)
*
* @param tool
* @return List
*/
protected List<OptionReference> getOptionReferences(ITool tool) { protected List<OptionReference> getOptionReferences(ITool tool) {
List<OptionReference> references = new ArrayList<OptionReference>(); List<OptionReference> references = new ArrayList<OptionReference>();
@ -654,7 +629,7 @@ public class Target extends BuildObject implements ITarget {
return result; return result;
} }
/* (non-Javadoc) /**
* A safe accessor method for the list of tools maintained by the * A safe accessor method for the list of tools maintained by the
* target * target
* *
@ -666,7 +641,7 @@ public class Target extends BuildObject implements ITarget {
return toolList; return toolList;
} }
/* (non-Javadoc) /**
* A safe accessor for the tool map * A safe accessor for the tool map
* *
*/ */
@ -677,12 +652,9 @@ public class Target extends BuildObject implements ITarget {
return toolMap; return toolMap;
} }
/* (non-Javadoc) /**
* Returns the reference for a given tool or <code>null</code> if one is not * Returns the reference for a given tool or <code>null</code> if one is not
* found. * found.
*
* @param tool
* @return ToolReference
*/ */
private ToolReference getToolReference(ITool tool) { private ToolReference getToolReference(ITool tool) {
// See if the receiver has a reference to the tool // See if the receiver has a reference to the tool
@ -830,9 +802,6 @@ public class Target extends BuildObject implements ITarget {
/** /**
* Persist receiver to project file. * Persist receiver to project file.
*
* @param doc
* @param element
*/ */
public void serialize(Document doc, Element element) { public void serialize(Document doc, Element element) {
element.setAttribute(ID, getId()); element.setAttribute(ID, getId());

View file

@ -80,11 +80,11 @@ public class TargetPlatform extends BuildObject implements ITargetPlatform {
* This constructor is called to create a TargetPlatform whose attributes and children will be * This constructor is called to create a TargetPlatform whose attributes and children will be
* added by separate calls. * added by separate calls.
* *
* @param ToolChain The parent of the builder, if any * @param parent The parent of the builder, if any
* @param TargetPlatform The superClass, if any * @param superClass The superClass, if any
* @param String The id for the new tool chain * @param Id The id for the new tool chain
* @param String The name for the new tool chain * @param name The name for the new tool chain
* @param boolean Indicates whether this is an extension element or a managed project element * @param isExtensionElement Indicates whether this is an extension element or a managed project element
*/ */
public TargetPlatform(ToolChain parent, ITargetPlatform superClass, String Id, String name, boolean isExtensionElement) { public TargetPlatform(ToolChain parent, ITargetPlatform superClass, String Id, String name, boolean isExtensionElement) {
this.parent = parent; this.parent = parent;
@ -128,7 +128,7 @@ public class TargetPlatform extends BuildObject implements ITargetPlatform {
* Create a <code>TargetPlatform</code> based upon an existing TargetPlatform. * Create a <code>TargetPlatform</code> based upon an existing TargetPlatform.
* *
* @param parent The <code>IToolChain</code> the TargetPlatform will be added to. * @param parent The <code>IToolChain</code> the TargetPlatform will be added to.
* @param builder The existing TargetPlatform to clone. * @param targetPlatform The existing TargetPlatform to clone.
*/ */
public TargetPlatform(IToolChain parent, String Id, String name, TargetPlatform targetPlatform) { public TargetPlatform(IToolChain parent, String Id, String name, TargetPlatform targetPlatform) {
this.parent = parent; this.parent = parent;
@ -310,9 +310,6 @@ public class TargetPlatform extends BuildObject implements ITargetPlatform {
/** /**
* Persist the target platform to the project file. * Persist the target platform to the project file.
*
* @param doc
* @param element
*/ */
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {
if (superClass != null) if (superClass != null)

View file

@ -975,8 +975,6 @@ public class Tool extends HoldsOptions implements ITool, IOptionCategory, IMatch
/** /**
* Persist the tool to the project file. * Persist the tool to the project file.
*
* @param element
*/ */
@Override @Override
public void serialize(ICStorageElement element) { public void serialize(ICStorageElement element) {
@ -1546,9 +1544,6 @@ public class Tool extends HoldsOptions implements ITool, IOptionCategory, IMatch
return inputTypeMap; return inputTypeMap;
} }
/**
* @param type
*/
public void addInputType(InputType type) { public void addInputType(InputType type) {
getInputTypeList().add(type); getInputTypeList().add(type);
getInputTypeMap().put(type.getId(), type); getInputTypeMap().put(type.getId(), type);
@ -1574,9 +1569,6 @@ public class Tool extends HoldsOptions implements ITool, IOptionCategory, IMatch
return outputTypeMap; return outputTypeMap;
} }
/**
* @param type
*/
public void addOutputType(OutputType type) { public void addOutputType(OutputType type) {
getOutputTypeList().add(type); getOutputTypeList().add(type);
getOutputTypeMap().put(type.getId(), type); getOutputTypeMap().put(type.getId(), type);
@ -2500,9 +2492,6 @@ public class Tool extends HoldsOptions implements ITool, IOptionCategory, IMatch
* but could be also used by other MBS components to adjust the tool flags resolution * but could be also used by other MBS components to adjust the tool flags resolution
* behavior by passing the method some custom macro substitutor * behavior by passing the method some custom macro substitutor
* *
* @param inputFileLocation
* @param outputFileLocation
* @param macroSubstitutor
* @return the command flags with the build macros resolved * @return the command flags with the build macros resolved
*/ */
public String[] getToolCommandFlags(IPath inputFileLocation, IPath outputFileLocation, public String[] getToolCommandFlags(IPath inputFileLocation, IPath outputFileLocation,

View file

@ -1098,8 +1098,6 @@ public class ToolChain extends HoldsOptions implements IToolChain, IBuildPropert
/** /**
* Safe accessor for the map of tool ids to tools * Safe accessor for the map of tool ids to tools
*
* @return
*/ */
private Map<String, Tool> getToolMap() { private Map<String, Tool> getToolMap() {
if (toolMap == null) { if (toolMap == null) {

View file

@ -271,8 +271,6 @@ public class ToolReference implements IToolReference {
/** /**
* Adds the option reference specified in the argument to the receiver. * Adds the option reference specified in the argument to the receiver.
*
* @param optionRef
*/ */
public void addOptionReference(OptionReference optionRef) { public void addOptionReference(OptionReference optionRef) {
getOptionReferenceList().add(optionRef); getOptionReferenceList().add(optionRef);
@ -699,9 +697,6 @@ public class ToolReference implements IToolReference {
/** /**
* Answers <code>true</code> if the owner of the receiver matches * Answers <code>true</code> if the owner of the receiver matches
* the argument. * the argument.
*
* @param config
* @return
*/ */
public boolean ownedByConfiguration(IConfigurationV2 config) { public boolean ownedByConfiguration(IConfigurationV2 config) {
if (owner instanceof ConfigurationV2) { if (owner instanceof ConfigurationV2) {

View file

@ -335,13 +335,11 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
/** /**
* sets whether the environment macros are to be expanded in the buildfile or not * sets whether the environment macros are to be expanded in the buildfile or not
* If a bulder does not support treating environment variables as its own ones this method * If a builder does not support treating environment variables as its own ones this method
* has no effect * has no effect
* Returns the result of this set operation. That is whether the environment macros are to be expanded in the buildfile * Returns the result of this set operation. That is whether the environment macros are to be expanded in the buildfile
* *
* @param cfg * @return whether the environment macros are to be expanded in the buildfile
* @param expand
* @return
*/ */
public boolean expandMacrosInBuildfile(IConfiguration cfg, boolean expand){ public boolean expandMacrosInBuildfile(IConfiguration cfg, boolean expand){
if(expand || canKeepMacrosInBuildfile(cfg)){ if(expand || canKeepMacrosInBuildfile(cfg)){
@ -386,11 +384,8 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
} }
/** /**
* answers whether the builder used for the given configuration is capable * @return whether the builder used for the given configuration is capable
* of handling macros in the buildfile * of handling macros in the buildfile
*
* @param cfg
* @return
*/ */
public static boolean canKeepMacrosInBuildfile(IConfiguration cfg){ public static boolean canKeepMacrosInBuildfile(IConfiguration cfg){
if(cfg != null){ if(cfg != null){
@ -402,11 +397,8 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
} }
/** /**
* answers whether the given builder is capable * @return whether the given builder is capable
* of handling macros in the buildfile * of handling macros in the buildfile
*
* @param builder
* @return
*/ */
public static boolean canKeepMacrosInBuildfile(IBuilder builder){ public static boolean canKeepMacrosInBuildfile(IBuilder builder){
if(builder != null){ if(builder != null){
@ -420,9 +412,6 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
/** /**
* creates a macro reference in the buildfile format for the given builder. * creates a macro reference in the buildfile format for the given builder.
* If the builder can not treat macros, returns null * If the builder can not treat macros, returns null
* @param name
* @param builder
* @return String
*/ */
public static String createBuildfileMacroReference(String name, IBuilder builder){ public static String createBuildfileMacroReference(String name, IBuilder builder){
String ref = null; String ref = null;
@ -438,9 +427,6 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
* creates a macro reference in the buildfile format for the builder used for * creates a macro reference in the buildfile format for the builder used for
* the given configuration. * the given configuration.
* If the builder can not treat macros, returns null * If the builder can not treat macros, returns null
* @param name
* @param cfg
* @return String
*/ */
public static String createBuildfileMacroReference(String name, IConfiguration cfg){ public static String createBuildfileMacroReference(String name, IConfiguration cfg){
String ref = null; String ref = null;
@ -453,13 +439,10 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
} }
/** /**
* Returns the array of the explicit file macros, referenced in the tool's options * @return the array of the explicit file macros, referenced in the tool's options
* (Explicit file macros are the file-specific macros, whose values are not provided * (Explicit file macros are the file-specific macros, whose values are not provided
* by the tool-integrator. As a result these macros contain explicit values, but not the values * by the tool-integrator. As a result these macros contain explicit values, but not the values
* specified in the format of the builder automatic variables and text functions) * specified in the format of the builder automatic variables and text functions)
*
* @param tool
* @return
*/ */
public static IBuildMacro[] getReferencedExplitFileMacros(ITool tool){ public static IBuildMacro[] getReferencedExplitFileMacros(ITool tool){
if(tool instanceof Tool){ if(tool instanceof Tool){
@ -483,15 +466,10 @@ public class BuildMacroProvider implements IBuildMacroProvider, IMacroContextInf
/** /**
* Returns the array of the explicit file macros, referenced in the given string * @return the array of the explicit file macros, referenced in the given string
* (Explicit file macros are the file-specific macros, whose values are not provided * (Explicit file macros are the file-specific macros, whose values are not provided
* by the tool-integrator. As a result these macros contain explicit values, but not the values * by the tool-integrator. As a result these macros contain explicit values, but not the values
* specified in the format of the builder automatic variables and text functions) * specified in the format of the builder automatic variables and text functions)
*
* @param expression
* @param contextType
* @param contextData
* @return
*/ */
public static IBuildMacro[] getReferencedExplitFileMacros(String expression, int contextType, Object contextData){ public static IBuildMacro[] getReferencedExplitFileMacros(String expression, int contextType, Object contextData){
ExplicitFileMacroCollector collector = new ExplicitFileMacroCollector(getDefault().getMacroContextInfo(contextType, contextData)); ExplicitFileMacroCollector collector = new ExplicitFileMacroCollector(getDefault().getMacroContextInfo(contextType, contextData));

View file

@ -43,7 +43,7 @@ import org.eclipse.core.resources.IResource;
* If a user has chosen to keep those macros in the buildfile, the environment macro references * If a user has chosen to keep those macros in the buildfile, the environment macro references
* are converted to the buildfile variable references, otherwise those macros are also resolved * are converted to the buildfile variable references, otherwise those macros are also resolved
* *
* @see org.eclipse.cdt.managedbuilder.internal.macros.IMacroSubstitutor * @see org.eclipse.cdt.managedbuilder.internal.macros#IMacroSubstitutor
* @since 3.0 * @since 3.0
*/ */
public class BuildfileMacroSubstitutor extends SupplierBasedCdtVariableSubstitutor { public class BuildfileMacroSubstitutor extends SupplierBasedCdtVariableSubstitutor {

View file

@ -37,20 +37,20 @@ public class BuildMacroException extends CdtVariableException {
super(status); super(status);
} }
/** // /**
* Creates an exception containing a single IBuildMacroStatus status with the IStatus.ERROR severity // * Creates an exception containing a single IBuildMacroStatus status with the IStatus.ERROR severity
* // *
* @param code one of the IBuildMacroStatus.TYPE_xxx statusses // * @param code one of the IBuildMacroStatus.TYPE_xxx statusses
* @param message message, can be null. In this case the default message will // * @param message message, can be null. In this case the default message will
* be generated base upon the other status info // * be generated base upon the other status info
* @param exception a low-level exception, or <code>null</code> if not // * @param exception a low-level exception, or <code>null</code> if not
* applicable // * applicable
* @param macroName the name of the build macro whose resolution caused this status creation or null if none // * @param macroName the name of the build macro whose resolution caused this status creation or null if none
* @param expression the string whose resolutinon caused caused this status creation or null if none // * @param expression the string whose resolutinon caused caused this status creation or null if none
* @param referencedName the macro name referenced in the resolution string that caused this this status creation or null if none // * @param referencedName the macro name referenced in the resolution string that caused this this status creation or null if none
* @param contextType the context type used in the operation // * @param contextType the context type used in the operation
* @param contextData the context data used in the operation // * @param contextData the context data used in the operation
*/ // */
// public BuildMacroException(int code, // public BuildMacroException(int code,
// String message, // String message,
// Throwable exception, // Throwable exception,
@ -62,18 +62,18 @@ public class BuildMacroException extends CdtVariableException {
// super(new BuildMacroStatus(code, message, exception, macroName, expression, referencedName, contextType, contextData)); // super(new BuildMacroStatus(code, message, exception, macroName, expression, referencedName, contextType, contextData));
// } // }
/** // /**
* Creates an exception containing a single IBuildMacroStatus status with the IStatus.ERROR severity and with the default message // * Creates an exception containing a single IBuildMacroStatus status with the IStatus.ERROR severity and with the default message
* // *
* @param code one of the IBuildMacroStatus.TYPE_xxx statusses // * @param code one of the IBuildMacroStatus.TYPE_xxx statusses
* @param exception a low-level exception, or <code>null</code> if not // * @param exception a low-level exception, or <code>null</code> if not
* applicable // * applicable
* @param macroName the name of the build macro whose resolution caused this status creation or null if none // * @param macroName the name of the build macro whose resolution caused this status creation or null if none
* @param expression the string whose resolutinon caused caused this status creation or null if none // * @param expression the string whose resolutinon caused caused this status creation or null if none
* @param referencedName the macro name referenced in the resolution string that caused this this status creation or null if none // * @param referencedName the macro name referenced in the resolution string that caused this this status creation or null if none
* @param contextType the context type used in the operation // * @param contextType the context type used in the operation
* @param contextData the context data used in the operation // * @param contextData the context data used in the operation
*/ // */
// public BuildMacroException(int code, // public BuildMacroException(int code,
// String macroName, // String macroName,
// String expression, // String expression,

View file

@ -40,7 +40,7 @@ public interface IBuildMacroProvider{
* differs depending on the context type and can be one of the following: * differs depending on the context type and can be one of the following:
* 1. IFileContextData interface used to represent currently selected file context * 1. IFileContextData interface used to represent currently selected file context
* the IFileContextData interface is defined as follows: * the IFileContextData interface is defined as follows:
* pulic interface IFileContextData{ * public interface IFileContextData{
* IFile getFile(); * IFile getFile();
* IOption getOption(); * IOption getOption();
* } * }
@ -53,7 +53,7 @@ public interface IBuildMacroProvider{
* 5. IWorkspace used to represent current workspace context * 5. IWorkspace used to represent current workspace context
* 6. null to represent the CDT and Eclipse installation context * 6. null to represent the CDT and Eclipse installation context
* 7. null to represent process environment context * 7. null to represent process environment context
* @param includeParentContext specifies whether lower-precedence context macros should * @param includeParentContexts specifies whether lower-precedence context macros should
* be included * be included
*/ */
public IBuildMacro getMacro(String macroName, public IBuildMacro getMacro(String macroName,
@ -123,7 +123,7 @@ public interface IBuildMacroProvider{
* *
* if the string contains a value that can be treated as a StringList resolves it to arrays of strings * if the string contains a value that can be treated as a StringList resolves it to arrays of strings
* otherwise throws the BuildMacroException exception * otherwise throws the BuildMacroException exception
* @see isStringListValue * @see #isStringListValue
*/ */
public String[] resolveStringListValue(String value, public String[] resolveStringListValue(String value,
String nonexistentMacrosValue, String nonexistentMacrosValue,
@ -135,7 +135,7 @@ public interface IBuildMacroProvider{
* *
* resolves macros in the array of string-list values * resolves macros in the array of string-list values
* *
* @see isStringListValue * @see #isStringListValue
*/ */
public String[] resolveStringListValues(String value[], public String[] resolveStringListValues(String value[],
String nonexistentMacrosValue, String nonexistentMacrosValue,
@ -176,7 +176,7 @@ public interface IBuildMacroProvider{
* each string of the returned array will contain all macro references resolved in case of * each string of the returned array will contain all macro references resolved in case of
* a user has specified to resolve the build macros, and will contain the string with the * a user has specified to resolve the build macros, and will contain the string with the
* environment macro references unresolved and converted to the buildfile format otherwise * environment macro references unresolved and converted to the buildfile format otherwise
* @see isStringListValue * @see #isStringListValue
*/ */
public String[] resolveStringListValueToMakefileFormat(String value, public String[] resolveStringListValueToMakefileFormat(String value,
String nonexistentMacrosValue, String nonexistentMacrosValue,
@ -188,7 +188,7 @@ public interface IBuildMacroProvider{
* resolves macros in the array of string-list values * resolves macros in the array of string-list values
* macros are resolved to the makefile format * macros are resolved to the makefile format
* *
* @see isStringListValue * @see #isStringListValue
*/ */
public String[] resolveStringListValuesToMakefileFormat(String value[], public String[] resolveStringListValuesToMakefileFormat(String value[],
String nonexistentMacrosValue, String nonexistentMacrosValue,

View file

@ -65,18 +65,12 @@ public interface IManagedBuilderMakefileGenerator {
public static final int NO_SOURCE_FOLDERS = 1; public static final int NO_SOURCE_FOLDERS = 1;
/**
* @throws CoreException
*/
public void generateDependencies() throws CoreException; public void generateDependencies() throws CoreException;
/** /**
* Clients call this method when an incremental rebuild is required. The argument * Clients call this method when an incremental rebuild is required. The argument
* contains a set of resource deltas that will be used to determine which * contains a set of resource deltas that will be used to determine which
* subdirectories need a new makefile and dependency list (if any). * subdirectories need a new makefile and dependency list (if any).
*
* @param delta
* @throws CoreException
*/ */
public MultiStatus generateMakefiles(IResourceDelta delta) throws CoreException ; public MultiStatus generateMakefiles(IResourceDelta delta) throws CoreException ;
@ -97,29 +91,16 @@ public interface IManagedBuilderMakefileGenerator {
/** /**
* This method initializes the makefile generator * This method initializes the makefile generator
*
* @param project
* @param info
* @param monitor
*/ */
public void initialize(IProject project, IManagedBuildInfo info, IProgressMonitor monitor); public void initialize(IProject project, IManagedBuildInfo info, IProgressMonitor monitor);
/** /**
* Answers <code>true</code> if the argument is a resource created by the generator * Answers <code>true</code> if the argument is a resource created by the generator
* @param resource
* @return
*/ */
public boolean isGeneratedResource(IResource resource); public boolean isGeneratedResource(IResource resource);
/**
* @param force
* @throws CoreException
*/
public void regenerateDependencies(boolean force) throws CoreException; public void regenerateDependencies(boolean force) throws CoreException;
/**
* @throws CoreException
*/
public MultiStatus regenerateMakefiles() throws CoreException; public MultiStatus regenerateMakefiles() throws CoreException;
} }

View file

@ -153,7 +153,7 @@ public class DefaultGCCDependencyCalculator3Commands implements
* working directory for the tool. This IPath is relative to the * working directory for the tool. This IPath is relative to the
* project directory. * project directory.
* *
* @see DefaultGCCDependencyCalculator3Commands(IPath source, IResource resource, IBuildObject buildContext, ITool tool, IPath topBuildDirectory) * @see #DefaultGCCDependencyCalculator3Commands(IPath source, IResource resource, IBuildObject buildContext, ITool tool, IPath topBuildDirectory)
*/ */
public DefaultGCCDependencyCalculator3Commands(IPath source, IBuildObject buildContext, ITool tool, IPath topBuildDirectory) public DefaultGCCDependencyCalculator3Commands(IPath source, IBuildObject buildContext, ITool tool, IPath topBuildDirectory)
{ {

View file

@ -146,7 +146,7 @@ public class DefaultGCCDependencyCalculatorPreBuildCommands implements IManagedD
* working directory for the tool. This IPath is relative to the * working directory for the tool. This IPath is relative to the
* project directory. * project directory.
* *
* @see DefaultGCCDependencyCalculatorPreBuildCommands(IPath source, IResource resource, IBuildObject buildContext, ITool tool, IPath topBuildDirectory) * @see #DefaultGCCDependencyCalculatorPreBuildCommands(IPath source, IResource resource, IBuildObject buildContext, ITool tool, IPath topBuildDirectory)
*/ */
public DefaultGCCDependencyCalculatorPreBuildCommands(IPath source, IBuildObject buildContext, ITool tool, IPath topBuildDirectory) public DefaultGCCDependencyCalculatorPreBuildCommands(IPath source, IBuildObject buildContext, ITool tool, IPath topBuildDirectory)
{ {

View file

@ -383,11 +383,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
************************************************************************/ ************************************************************************/
/* (non-Javadoc) /* (non-Javadoc)
* @see org.eclipse.cdt.managedbuilder.makegen.IManagedBuilderMakefileGenerator#initialize() * @see org.eclipse.cdt.managedbuilder.makegen.IManagedBuilderMakefileGenerator#initialize(IProject, IManagedBuildInfo, IProgressMonitor)
*
* @param project
* @param info
* @param monitor
*/ */
public void initialize(IProject project, IManagedBuildInfo info, IProgressMonitor monitor) { public void initialize(IProject project, IManagedBuildInfo info, IProgressMonitor monitor) {
// Save the project so we can get path and member information // Save the project so we can get path and member information
@ -948,13 +944,10 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* M A K E F I L E S P O P U L A T I O N M E T H O D S * M A K E F I L E S P O P U L A T I O N M E T H O D S
************************************************************************/ ************************************************************************/
/* (non-javadoc) /**
* This method generates a "fragment" make file (subdir.mk). * This method generates a "fragment" make file (subdir.mk).
* One of these is generated for each project directory/subdirectory * One of these is generated for each project directory/subdirectory
* that contains source files. * that contains source files.
*
* @param module
* @throws CoreException
*/ */
protected void populateFragmentMakefile(IContainer module) throws CoreException { protected void populateFragmentMakefile(IContainer module) throws CoreException {
// Calculate the new directory relative to the build output // Calculate the new directory relative to the build output
@ -980,12 +973,11 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
Util.save(makeBuf, modMakefile); Util.save(makeBuf, modMakefile);
} }
/* (non-Javadoc) /**
* The makefile generator generates a Macro for each type of output, other than final artifact, * The makefile generator generates a Macro for each type of output, other than final artifact,
* created by the build. * created by the build.
* *
* @param fileHandle The file that should be populated with the output * @param fileHandle The file that should be populated with the output
* @throws CoreException
*/ */
protected void populateObjectsMakefile(IFile fileHandle) throws CoreException { protected void populateObjectsMakefile(IFile fileHandle) throws CoreException {
@ -1042,10 +1034,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
/* (non-Javadoc)
* @param fileHandle
* @throws CoreException
*/
protected void populateSourcesMakefile(IFile fileHandle) throws CoreException { protected void populateSourcesMakefile(IFile fileHandle) throws CoreException {
// Add the comment // Add the comment
StringBuffer buffer = addDefaultHeader(); StringBuffer buffer = addDefaultHeader();
@ -1130,12 +1118,11 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
Util.save(buffer, fileHandle); Util.save(buffer, fileHandle);
} }
/* (non-Javadoc) /**
* Create the entire contents of the makefile. * Create the entire contents of the makefile.
* *
* @param fileHandle The file to place the contents in. * @param fileHandle The file to place the contents in.
* @param rebuild FLag signalling that the user is doing a full rebuild * @param rebuild FLag signaling that the user is doing a full rebuild
* @throws CoreException
*/ */
protected void populateTopMakefile(IFile fileHandle, boolean rebuild) throws CoreException { protected void populateTopMakefile(IFile fileHandle, boolean rebuild) throws CoreException {
StringBuffer buffer = new StringBuffer(); StringBuffer buffer = new StringBuffer();
@ -1167,7 +1154,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* M A I N (makefile) M A K E F I L E M E T H O D S * M A I N (makefile) M A K E F I L E M E T H O D S
************************************************************************/ ************************************************************************/
/* (non-Javadoc) /**
* Answers a <code>StringBuffer</code> containing the comment(s) * Answers a <code>StringBuffer</code> containing the comment(s)
* for the top-level makefile. * for the top-level makefile.
*/ */
@ -1175,7 +1162,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return addDefaultHeader(); return addDefaultHeader();
} }
/* (non-javadoc) /**
*/ */
private StringBuffer addMacros() { private StringBuffer addMacros() {
StringBuffer buffer = new StringBuffer(); StringBuffer buffer = new StringBuffer();
@ -1249,13 +1236,11 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return (buffer.append(NEWLINE)); return (buffer.append(NEWLINE));
} }
/* (non-javadoc) /**
* Answers a <code>StringBuffer</code> containing all of the required targets to * Answers a <code>StringBuffer</code> containing all of the required targets to
* properly build the project. * properly build the project.
* *
* @param outputVarsAdditionsList list to add needed build output variables to * @param outputVarsAdditionsList list to add needed build output variables to
* @param rebuild
* @return StringBuffer
*/ */
private StringBuffer addTargets(List<String> outputVarsAdditionsList, boolean rebuild) { private StringBuffer addTargets(List<String> outputVarsAdditionsList, boolean rebuild) {
StringBuffer buffer = new StringBuffer(); StringBuffer buffer = new StringBuffer();
@ -1489,7 +1474,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return buffer; return buffer;
} }
/* (non-javadoc) /**
* Returns the targets rules. The targets make file (top makefile) contains: * Returns the targets rules. The targets make file (top makefile) contains:
* 1 the rule for the final target tool * 1 the rule for the final target tool
* 2 the rules for all of the tools that use multipleOfType in their primary input type * 2 the rules for all of the tools that use multipleOfType in their primary input type
@ -1573,17 +1558,16 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return buffer; return buffer;
} }
/* (non-Javadoc) /**
* Create the rule * Create the rule
* *
* @param tool
* @param buffer Buffer to add makefile rules to * @param buffer Buffer to add makefile rules to
* @param bTargetTool True if this is the target tool * @param bTargetTool True if this is the target tool
* @param targetName If this is the "targetTool", the target file name, else <code>null</code> * @param targetName If this is the "targetTool", the target file name, else <code>null</code>
* @param targetName If this is the "targetTool", the target file extension, else <code>null</code> * @param targetExt If this is the "targetTool", the target file extension, else <code>null</code>
* @param outputVarsAdditionsList list to add needed build output variables to * @param outputVarsAdditionsList list to add needed build output variables to
* @param managedProjectOutputs Other projects in the workspace that this project depends upon * @param managedProjectOutputs Other projects in the workspace that this project depends upon
* @param bPostBuildStep Emit post-build step invocation * @param bEmitPostBuildStepCall Emit post-build step invocation
*/ */
protected boolean addRuleForTool(ITool tool, StringBuffer buffer, boolean bTargetTool, String targetName, String targetExt, protected boolean addRuleForTool(ITool tool, StringBuffer buffer, boolean bTargetTool, String targetName, String targetExt,
List<String> outputVarsAdditionsList, Vector<String> managedProjectOutputs, boolean bEmitPostBuildStepCall) { List<String> outputVarsAdditionsList, Vector<String> managedProjectOutputs, boolean bEmitPostBuildStepCall) {
@ -1754,7 +1738,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return true; return true;
} }
/* (non-Javadoc) /**
* @param outputVarsAdditionsList list to add needed build output variables to * @param outputVarsAdditionsList list to add needed build output variables to
* @param buffer buffer to add rules to * @param buffer buffer to add rules to
*/ */
@ -1834,10 +1818,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return true; return true;
} }
/* (non-Javadoc)
* @param fileHandle
* @throws CoreException
*/
protected Vector<String> calculateSecondaryOutputs(IOutputType[] secondaryOutputs) { protected Vector<String> calculateSecondaryOutputs(IOutputType[] secondaryOutputs) {
ToolInfoHolder h = (ToolInfoHolder)toolInfos.getValue(); ToolInfoHolder h = (ToolInfoHolder)toolInfos.getValue();
ITool[] buildTools = h.buildTools; ITool[] buildTools = h.buildTools;
@ -1897,9 +1877,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* S O U R C E S (sources.mk) M A K E F I L E M E T H O D S * S O U R C E S (sources.mk) M A K E F I L E M E T H O D S
************************************************************************/ ************************************************************************/
/* (non-javadoc)
* @return
*/
private StringBuffer addSubdirectories() { private StringBuffer addSubdirectories() {
StringBuffer buffer = new StringBuffer(); StringBuffer buffer = new StringBuffer();
// Add the comment // Add the comment
@ -1928,7 +1905,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* F R A G M E N T (subdir.mk) M A K E F I L E M E T H O D S * F R A G M E N T (subdir.mk) M A K E F I L E M E T H O D S
************************************************************************/ ************************************************************************/
/* (non-Javadoc) /**
* Returns a <code>StringBuffer</code> containing the comment(s) * Returns a <code>StringBuffer</code> containing the comment(s)
* for a fragment makefile (subdir.mk). * for a fragment makefile (subdir.mk).
*/ */
@ -1936,7 +1913,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return addDefaultHeader(); return addDefaultHeader();
} }
/* (non-javadoc) /**
* Returns a <code>StringBuffer</code> containing makefile text for all of the sources * Returns a <code>StringBuffer</code> containing makefile text for all of the sources
* contributed by a container (project directory/subdirectory) to the fragement makefile * contributed by a container (project directory/subdirectory) to the fragement makefile
* *
@ -2177,7 +2154,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return new Path(resource.getLocationURI().getPath()); return new Path(resource.getLocationURI().getPath());
} }
/* (non-Javadoc) /**
* Adds the source file to the appropriate build variable * Adds the source file to the appropriate build variable
* *
* @param buildVarToRuleStringMap map of build variable names to the list of files assigned to the variable * @param buildVarToRuleStringMap map of build variable names to the list of files assigned to the variable
@ -2261,7 +2238,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
/* (non-Javadoc) /**
* Create a rule for this source file. We create a pattern rule if possible. * Create a rule for this source file. We create a pattern rule if possible.
* *
* This is an example of a pattern rule: * This is an example of a pattern rule:
@ -2283,7 +2260,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* @echo Building file: $< * @echo Building file: $<
* @echo Invoking tool xxx * @echo Invoking tool xxx
* @echo g++ -g -O2 -c -I/cygdrive/c/eclipse/workspace/Project/headers -o$@ $< * @echo g++ -g -O2 -c -I/cygdrive/c/eclipse/workspace/Project/headers -o$@ $<
* @ g++ -g -O2 -c -I/cygdrive/c/eclipse/workspace/Project/headers -o$@ $< && \ * @g++ -g -O2 -c -I/cygdrive/c/eclipse/workspace/Project/headers -o$@ $< && \
* echo -n $(@:%.o=%.d) ' source1/' >> $(@:%.o=%.d) && \ * echo -n $(@:%.o=%.d) ' source1/' >> $(@:%.o=%.d) && \
* g++ -P -MM -MG -g -O2 -c -I/cygdrive/c/eclipse/workspace/Project/headers $< >> $(@:%.o=%.d) * g++ -P -MM -MG -g -O2 -c -I/cygdrive/c/eclipse/workspace/Project/headers $< >> $(@:%.o=%.d)
* @echo Finished building: $< * @echo Finished building: $<
@ -2293,9 +2270,8 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* @param buffer buffer to populate with the build rule * @param buffer buffer to populate with the build rule
* @param resource the source file for this invocation of the tool * @param resource the source file for this invocation of the tool
* @param sourceLocation the full path of the source * @param sourceLocation the full path of the source
* @param resConfig the IResourceConfiguration associated with this file or null * @param rcInfo the IResourceInfo associated with this file or null
* @param generatedSource <code>true</code> if the resource is a generated output * @param generatedSource <code>true</code> if the resource is a generated output
* @param generatedDepFile build directory relative paths of the dependency files generated by the rule
* @param enumeratedOutputs vector of the filenames that are the output of this rule * @param enumeratedOutputs vector of the filenames that are the output of this rule
*/ */
protected void addRuleForSource(String relativePath, StringBuffer buffer, IResource resource, protected void addRuleForSource(String relativePath, StringBuffer buffer, IResource resource,
@ -2921,7 +2897,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
/* (non-Javadoc) /**
* Returns any additional resources specified for the tool in other InputType elements and AdditionalInput elements * Returns any additional resources specified for the tool in other InputType elements and AdditionalInput elements
*/ */
protected IPath[] getAdditionalResourcesForSource(ITool tool) { protected IPath[] getAdditionalResourcesForSource(ITool tool) {
@ -3031,9 +3007,9 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
/* (non-Javadoc) /**
* Returns the output <code>IPath</code>s for this invocation of the tool with the specified source file * Returns the output <code>IPath</code>s for this invocation of the tool with the specified source file
/* *
* The priorities for determining the names of the outputs of a tool are: * The priorities for determining the names of the outputs of a tool are:
* 1. If the tool is the build target and primary output, use artifact name & extension - * 1. If the tool is the build target and primary output, use artifact name & extension -
* This case does not apply here... * This case does not apply here...
@ -3044,9 +3020,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* so that the source names can be transformed into the target names * so that the source names can be transformed into the target names
* using the built-in string substitution functions of <code>make</code>. * using the built-in string substitution functions of <code>make</code>.
* *
* @param tool
* @param relativePath build output directory relative path of the current output directory * @param relativePath build output directory relative path of the current output directory
* @param resource
* @param ruleOutputs Vector of rule IPaths that are relative to the build directory * @param ruleOutputs Vector of rule IPaths that are relative to the build directory
* @param enumeratedPrimaryOutputs Vector of IPaths of primary outputs * @param enumeratedPrimaryOutputs Vector of IPaths of primary outputs
* that are relative to the build directory * that are relative to the build directory
@ -3365,7 +3339,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
} }
/* (non-Javadoc) /**
* If the path contains a %, returns the path resolved using the resource name * If the path contains a %, returns the path resolved using the resource name
* *
*/ */
@ -3378,7 +3352,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return DOT_SLASH_PATH.isPrefixOf(outPath) ? DOT_SLASH_PATH.append(result) : result; return DOT_SLASH_PATH.isPrefixOf(outPath) ? DOT_SLASH_PATH.append(result) : result;
} }
/* (non-Javadoc) /**
* Returns the dependency <code>IPath</code>s for this invocation of the tool with the specified source file * Returns the dependency <code>IPath</code>s for this invocation of the tool with the specified source file
* *
* @param depGen the dependency calculator * @param depGen the dependency calculator
@ -3419,7 +3393,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return deps.toArray(new IPath[deps.size()]); return deps.toArray(new IPath[deps.size()]);
} }
/* (non-Javadoc) /**
* Returns the dependency <code>IPath</code>s relative to the build directory * Returns the dependency <code>IPath</code>s relative to the build directory
* *
* @param depCalculator the dependency calculator * @param depCalculator the dependency calculator
@ -3444,7 +3418,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* M A K E F I L E G E N E R A T I O N C O M M O N M E T H O D S * M A K E F I L E G E N E R A T I O N C O M M O N M E T H O D S
************************************************************************/ ************************************************************************/
/* (non-Javadoc) /**
* Generates a source macro name from a file extension * Generates a source macro name from a file extension
*/ */
public StringBuffer getSourceMacroName(String extensionName) { public StringBuffer getSourceMacroName(String extensionName) {
@ -3466,7 +3440,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return macroName; return macroName;
} }
/* (non-Javadoc) /**
* Generates a generated dependency file macro name from a file extension * Generates a generated dependency file macro name from a file extension
*/ */
public StringBuffer getDepMacroName(String extensionName) { public StringBuffer getDepMacroName(String extensionName) {
@ -3488,7 +3462,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return macroName; return macroName;
} }
/* (non-Javadoc) /**
* Answers all of the output extensions that the target * Answers all of the output extensions that the target
* of the build has tools defined to work on. * of the build has tools defined to work on.
* *
@ -3712,8 +3686,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
/** /**
* prepend all instanced of '\' or '"' with a backslash * prepend all instanced of '\' or '"' with a backslash
* *
* @param string * @return resulting string
* @return
*/ */
static public String escapedEcho(String string) { static public String escapedEcho(String string) {
String escapedString = string.replaceAll("'", "'\"'\"'"); //$NON-NLS-1$ //$NON-NLS-2$ String escapedString = string.replaceAll("'", "'\"'\"'"); //$NON-NLS-1$ //$NON-NLS-2$
@ -3722,7 +3695,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
static public String ECHO_BLANK_LINE = ECHO + WHITESPACE + SINGLE_QUOTE + WHITESPACE + SINGLE_QUOTE + NEWLINE; static public String ECHO_BLANK_LINE = ECHO + WHITESPACE + SINGLE_QUOTE + WHITESPACE + SINGLE_QUOTE + NEWLINE;
/* (non-Javadoc) /**
* Outputs a comment formatted as follows: * Outputs a comment formatted as follows:
* ##### ....... ##### * ##### ....... #####
* # <Comment message> * # <Comment message>
@ -3737,7 +3710,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return buffer; return buffer;
} }
/* (non-Javadoc) /**
* Put COLS_PER_LINE comment charaters in the argument. * Put COLS_PER_LINE comment charaters in the argument.
*/ */
static protected void outputCommentLine(StringBuffer buffer) { static protected void outputCommentLine(StringBuffer buffer) {
@ -3752,10 +3725,8 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return path.matches(".*(\\s|[\\{\\}\\(\\)\\$\\@%=;]).*"); //$NON-NLS-1$ return path.matches(".*(\\s|[\\{\\}\\(\\)\\$\\@%=;]).*"); //$NON-NLS-1$
} }
/* (non-Javadoc) /**
* Answers the argument with all whitespaces replaced with an escape sequence. * Answers the argument with all whitespaces replaced with an escape sequence.
*
* @param path
*/ */
static public String escapeWhitespaces(String path) { static public String escapeWhitespaces(String path) {
// Escape the spaces in the path/filename if it has any // Escape the spaces in the path/filename if it has any
@ -3774,7 +3745,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
} }
/* (non-Javadoc) /**
* Adds a macro addition prefix to a map of macro names to entries. * Adds a macro addition prefix to a map of macro names to entries.
* Entry prefixes look like: * Entry prefixes look like:
* C_SRCS += \ * C_SRCS += \
@ -3793,7 +3764,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
map.put(macroName, tempBuffer.toString()); map.put(macroName, tempBuffer.toString());
} }
/* (non-Javadoc) /**
* Adds a file to an entry in a map of macro names to entries. * Adds a file to an entry in a map of macro names to entries.
* File additions look like: * File additions look like:
* example.c, \ * example.c, \
@ -3810,7 +3781,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
map.put(macroName, buffer.toString()); map.put(macroName, buffer.toString());
} }
/* (non-Javadoc) /**
* Adds a file to an entry in a map of macro names to entries. * Adds a file to an entry in a map of macro names to entries.
* File additions look like: * File additions look like:
* example.c, \ * example.c, \
@ -3842,7 +3813,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
addMacroAdditionFile(map, macroName, srcName); addMacroAdditionFile(map, macroName, srcName);
} }
/* (non-Javadoc) /**
* Adds file(s) to an entry in a map of macro names to entries. * Adds file(s) to an entry in a map of macro names to entries.
* File additions look like: * File additions look like:
* example.c, \ * example.c, \
@ -3860,7 +3831,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
map.put(macroName, buffer.toString()); map.put(macroName, buffer.toString());
} }
/* (non-Javadoc) /**
* Write all macro addition entries in a map to the buffer * Write all macro addition entries in a map to the buffer
*/ */
protected StringBuffer writeAdditionMacros(LinkedHashMap<String, String> map) { protected StringBuffer writeAdditionMacros(LinkedHashMap<String, String> map) {
@ -3892,7 +3863,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return buffer.append(NEWLINE); return buffer.append(NEWLINE);
} }
/* (non-Javadoc) /**
* Write all macro addition entries in a map to the buffer * Write all macro addition entries in a map to the buffer
*/ */
protected StringBuffer writeTopAdditionMacros(List<String> varList, HashMap<String, ?> varMap) { protected StringBuffer writeTopAdditionMacros(List<String> varList, HashMap<String, ?> varMap) {
@ -3912,7 +3883,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return buffer.append(NEWLINE); return buffer.append(NEWLINE);
} }
/* (non-Javadoc) /**
* Calculates the inputs and outputs for tools that will be generated in the top makefile. * Calculates the inputs and outputs for tools that will be generated in the top makefile.
* This information is used by the top level makefile generation methods. * This information is used by the top level makefile generation methods.
*/ */
@ -4057,7 +4028,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
}); });
} }
/* (non-javadoc) /**
* Returns the (String) list of files associated with the build variable * Returns the (String) list of files associated with the build variable
* *
* @param variable the variable name * @param variable the variable name
@ -4109,7 +4080,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return fileList; return fileList;
} }
/* (non-javadoc) /**
* Returns the list of files associated with the build variable in the top makefile * Returns the list of files associated with the build variable in the top makefile
* *
* @param variable the variable name * @param variable the variable name
@ -4119,7 +4090,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return (List)topBuildOutVars.get(variable); return (List)topBuildOutVars.get(variable);
} }
/* (non-javadoc) /**
* Returns the map of build variables to list of files * Returns the map of build variables to list of files
* *
* @return HashMap * @return HashMap
@ -4128,7 +4099,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return buildOutVars; return buildOutVars;
} }
/* (non-javadoc) /**
* Returns the map of build variables used in the top makefile to list of files * Returns the map of build variables used in the top makefile to list of files
* *
* @return HashMap * @return HashMap
@ -4137,7 +4108,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return topBuildOutVars; return topBuildOutVars;
} }
/* (non-javadoc) /**
* Returns the list of known build rules. This keeps me from generating duplicate * Returns the list of known build rules. This keeps me from generating duplicate
* rules for known file extensions. * rules for known file extensions.
* *
@ -4150,7 +4121,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return ruleList; return ruleList;
} }
/* (non-javadoc) /**
* Returns the list of known dependency lines. This keeps me from generating duplicate * Returns the list of known dependency lines. This keeps me from generating duplicate
* lines. * lines.
* *
@ -4163,7 +4134,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return depLineList; return depLineList;
} }
/* (non-javadoc) /**
* Returns the list of known dependency file generation lines. This keeps me from * Returns the list of known dependency file generation lines. This keeps me from
* generating duplicate lines. * generating duplicate lines.
* *
@ -4185,8 +4156,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* contribute source files to the build. The resource visitor has already established * contribute source files to the build. The resource visitor has already established
* that the build model knows how to build the files. It has also checked that * that the build model knows how to build the files. It has also checked that
* the resource is not generated as part of the build. * the resource is not generated as part of the build.
*
* @param resource
*/ */
protected void appendBuildSubdirectory(IResource resource) { protected void appendBuildSubdirectory(IResource resource) {
IContainer container = resource.getParent(); IContainer container = resource.getParent();
@ -4200,8 +4169,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* Adds the container of the argument to a list of subdirectories that are to be * Adds the container of the argument to a list of subdirectories that are to be
* deleted. As a result, the directories that are generated for the output * deleted. As a result, the directories that are generated for the output
* should be removed as well. * should be removed as well.
*
* @param container
*/ */
protected void appendDeletedSubdirectory(IContainer container) { protected void appendDeletedSubdirectory(IContainer container) {
// No point in adding a folder if the parent is already there // No point in adding a folder if the parent is already there
@ -4216,8 +4183,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* If a file is removed from a source folder (either because of a delete * If a file is removed from a source folder (either because of a delete
* or move action on the part of the user), the makefilegenerator has to * or move action on the part of the user), the makefilegenerator has to
* remove the dependency makefile along with the old build goal * remove the dependency makefile along with the old build goal
*
* @param resource
*/ */
protected void appendDeletedFile(IResource resource) { protected void appendDeletedFile(IResource resource) {
// Cache this for now // Cache this for now
@ -4228,8 +4193,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* Adds the container of the argument to a list of subdirectories that are part * Adds the container of the argument to a list of subdirectories that are part
* of an incremental rebuild of the project. The makefile fragments for these * of an incremental rebuild of the project. The makefile fragments for these
* directories will be regenerated as a result of the build. * directories will be regenerated as a result of the build.
*
* @param resource
*/ */
protected void appendModifiedSubdirectory(IResource resource) { protected void appendModifiedSubdirectory(IResource resource) {
IContainer container = resource.getParent(); IContainer container = resource.getParent();
@ -4244,16 +4207,13 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
* O T H E R M E T H O D S * O T H E R M E T H O D S
************************************************************************/ ************************************************************************/
/* (non-Javadoc)
* @param message
*/
protected void cancel(String message) { protected void cancel(String message) {
if (monitor != null && !monitor.isCanceled()) { if (monitor != null && !monitor.isCanceled()) {
throw new OperationCanceledException(message); throw new OperationCanceledException(message);
} }
} }
/* (non-Javadoc) /**
* Check whether the build has been cancelled. Cancellation requests * Check whether the build has been cancelled. Cancellation requests
* propagated to the caller by throwing <code>OperationCanceledException</code>. * propagated to the caller by throwing <code>OperationCanceledException</code>.
* *
@ -4265,14 +4225,11 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
} }
/* (non-Javadoc) /**
* Return or create the folder needed for the build output. If we are * Return or create the folder needed for the build output. If we are
* creating the folder, set the derived bit to true so the CM system * creating the folder, set the derived bit to true so the CM system
* ignores the contents. If the resource exists, respect the existing * ignores the contents. If the resource exists, respect the existing
* derived setting. * derived setting.
*
* @param string
* @return IPath
*/ */
private IPath createDirectory(String dirName) throws CoreException { private IPath createDirectory(String dirName) throws CoreException {
// Create or get the handle for the build directory // Create or get the handle for the build directory
@ -4308,14 +4265,11 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return folder.getFullPath(); return folder.getFullPath();
} }
/* (non-Javadoc) /**
* Return or create the makefile needed for the build. If we are creating * Return or create the makefile needed for the build. If we are creating
* the resource, set the derived bit to true so the CM system ignores * the resource, set the derived bit to true so the CM system ignores
* the contents. If the resource exists, respect the existing derived * the contents. If the resource exists, respect the existing derived
* setting. * setting.
*
* @param makefilePath
* @return IFile
*/ */
private IFile createFile(IPath makefilePath) throws CoreException { private IFile createFile(IPath makefilePath) throws CoreException {
// Create or get the handle for the makefile // Create or get the handle for the makefile
@ -4345,9 +4299,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return newFile; return newFile;
} }
/**
* @param deletedFile
*/
private void deleteBuildTarget(IResource deletedFile) { private void deleteBuildTarget(IResource deletedFile) {
// Get the project relative path of the file // Get the project relative path of the file
String fileName = getFileName(deletedFile); String fileName = getFileName(deletedFile);
@ -4387,9 +4338,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return inPath; return inPath;
} }
/**
* @param deletedFile
*/
private void deleteDepFile(IResource deletedFile) { private void deleteDepFile(IResource deletedFile) {
// Calculate the top build directory relative paths of the dependency files // Calculate the top build directory relative paths of the dependency files
IPath[] depFilePaths = null; IPath[] depFilePaths = null;
@ -4461,9 +4409,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return deletedDirList; return deletedDirList;
} }
/* (non-Javadoc)
* @return
*/
private Vector<IResource> getDeletedFileList() { private Vector<IResource> getDeletedFileList() {
if (deletedFileList == null) { if (deletedFileList == null) {
deletedFileList = new Vector<IResource>(); deletedFileList = new Vector<IResource>();
@ -4471,9 +4416,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return deletedFileList; return deletedFileList;
} }
/* (non-Javadoc)
* @return
*/
private List<IPath> getDependencyMakefiles(ToolInfoHolder h) { private List<IPath> getDependencyMakefiles(ToolInfoHolder h) {
if (h.dependencyMakefiles == null) { if (h.dependencyMakefiles == null) {
h.dependencyMakefiles = new ArrayList<IPath>(); h.dependencyMakefiles = new ArrayList<IPath>();
@ -4481,12 +4423,9 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return h.dependencyMakefiles; return h.dependencyMakefiles;
} }
/* (non-Javadoc) /**
* Strips off the file extension from the argument and returns * Strips off the file extension from the argument and returns
* the name component in a <code>String</code> * the name component in a <code>String</code>
*
* @param file
* @return
*/ */
private String getFileName(IResource file) { private String getFileName(IResource file) {
String answer = new String(); String answer = new String();
@ -4498,7 +4437,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return answer; return answer;
} }
/* (non-Javadoc) /**
* Answers a Vector containing a list of directories that are invalid for the * Answers a Vector containing a list of directories that are invalid for the
* build for some reason. At the moment, the only reason a directory would * build for some reason. At the moment, the only reason a directory would
* not be considered for the build is if it contains a space in the relative * not be considered for the build is if it contains a space in the relative
@ -4513,7 +4452,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return invalidDirList; return invalidDirList;
} }
/* (non-javadoc) /**
* *
* @return Vector * @return Vector
*/ */
@ -4524,7 +4463,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return modifiedList; return modifiedList;
} }
/* (non-javadoc) /**
* Answers the list of subdirectories (IContainer's) contributing source code to the build * Answers the list of subdirectories (IContainer's) contributing source code to the build
* *
* @return List * @return List
@ -4536,9 +4475,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
return subdirList; return subdirList;
} }
/* (non-Javadoc)
* @param subDir
*/
private void removeGeneratedDirectory(IContainer subDir) { private void removeGeneratedDirectory(IContainer subDir) {
try { try {
// The source directory isn't empty // The source directory isn't empty
@ -4564,9 +4500,6 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
} }
} }
/* (non-Javadoc)
* @param msg
*/
protected void updateMonitor(String msg) { protected void updateMonitor(String msg) {
if (monitor!= null && !monitor.isCanceled()) { if (monitor!= null && !monitor.isCanceled()) {
monitor.subTask(msg); monitor.subTask(msg);
@ -4601,7 +4534,7 @@ public class GnuMakefileGenerator implements IManagedBuilderMakefileGenerator2 {
/** /**
* Strips outermost quotes of Strings of the form "a" and 'a' or returns the original * Strips outermost quotes of Strings of the form "a" and 'a' or returns the original
* string if the input is not of this form. * string if the input is not of this form.
* @param path *
* @throws NullPointerException if path is null * @throws NullPointerException if path is null
* @return a String without the outermost quotes (if the input has them) * @return a String without the outermost quotes (if the input has them)
*/ */

View file

@ -62,7 +62,6 @@ class UpdateManagedProject20 {
/** /**
* @param monitor the monitor to allow users to cancel the long-running operation * @param monitor the monitor to allow users to cancel the long-running operation
* @param project the <code>IProject</code> that needs to be upgraded * @param project the <code>IProject</code> that needs to be upgraded
* @throws CoreException
*/ */
static void doProjectUpdate(IProgressMonitor monitor, final IProject project) throws CoreException { static void doProjectUpdate(IProgressMonitor monitor, final IProject project) throws CoreException {
String[] projectName = new String[]{project.getName()}; String[] projectName = new String[]{project.getName()};

View file

@ -49,7 +49,6 @@ class UpdateManagedProject21 {
/** /**
* @param monitor the monitor to allow users to cancel the long-running operation * @param monitor the monitor to allow users to cancel the long-running operation
* @param project the <code>IProject</code> that needs to be upgraded * @param project the <code>IProject</code> that needs to be upgraded
* @throws CoreException
*/ */
static void doProjectUpdate(IProgressMonitor monitor, final IProject project) throws CoreException { static void doProjectUpdate(IProgressMonitor monitor, final IProject project) throws CoreException {
String[] projectName = new String[]{project.getName()}; String[] projectName = new String[]{project.getName()};

View file

@ -29,7 +29,6 @@ public class UpdateManagedProject30 {
/** /**
* @param monitor the monitor to allow users to cancel the long-running operation * @param monitor the monitor to allow users to cancel the long-running operation
* @param project the <code>IProject</code> that needs to be upgraded * @param project the <code>IProject</code> that needs to be upgraded
* @throws CoreException
*/ */
static void doProjectUpdate(IProgressMonitor monitor, final IProject project) throws CoreException { static void doProjectUpdate(IProgressMonitor monitor, final IProject project) throws CoreException {
String[] projectName = new String[]{project.getName()}; String[] projectName = new String[]{project.getName()};

View file

@ -21,7 +21,6 @@ public interface IApplicableModification extends IModification {
/** /**
* applies the settings made to the given modification to the underlying * applies the settings made to the given modification to the underlying
* resource info * resource info
* @throws CoreException
*/ */
void apply() throws CoreException; void apply() throws CoreException;
} }

View file

@ -18,41 +18,34 @@ import org.eclipse.cdt.managedbuilder.core.IBuilder;
*/ */
public interface IConfigurationModification extends IFolderInfoModification { public interface IConfigurationModification extends IFolderInfoModification {
/** /**
* returns a builder currently assigned to this Configuration Modification * @return a builder currently assigned to this Configuration Modification
* @return
*/ */
IBuilder getBuilder(); IBuilder getBuilder();
IBuilder getRealBuilder(); IBuilder getRealBuilder();
/** /**
* returns a set of compatible builders * @return a set of compatible builders
* @return
*/ */
IBuilder[] getCompatibleBuilders(); IBuilder[] getCompatibleBuilders();
/** /**
* returns the compatibility status for the builder * @return the compatibility status for the builder
*
* @return
*/ */
CompatibilityStatus getBuilderCompatibilityStatus(); CompatibilityStatus getBuilderCompatibilityStatus();
/** /**
* returns the compatibility status for the builder, * @return the compatibility status for the builder,
* i.e. true when the getCompatibilityStatus() returns an non-ERROR status, * i.e. true when the getCompatibilityStatus() returns an non-ERROR status,
* and false otherwise * and false otherwise
* */
* @return boolean isBuilderCompatible();
*/ boolean isBuilderCompatible();
/** /**
* sets the builder to this Configuration Modification * sets the builder to this Configuration Modification
* Note that this does NOT apply the builder to the underlying configuration * Note that this does NOT apply the builder to the underlying configuration
* For applying the Modification settings the {@link IApplicableModification#apply()} * For applying the Modification settings the {@link IApplicableModification#apply()}
* method should be called * method should be called
*
* @param builder
*/ */
void setBuilder(IBuilder builder); void setBuilder(IBuilder builder);
} }

View file

@ -19,29 +19,24 @@ import org.eclipse.cdt.managedbuilder.core.IToolChain;
public interface IFolderInfoModification extends IToolListModification { public interface IFolderInfoModification extends IToolListModification {
/** /**
* returns a set of tool-chains compatible with the current one * @return a set of tool-chains compatible with the current one
* @return
*/ */
IToolChain[] getCompatibleToolChains(); IToolChain[] getCompatibleToolChains();
/** /**
* returns compatibility status for the current tool-chain * @return compatibility status for the current tool-chain
* @return
*/ */
CompatibilityStatus getToolChainCompatibilityStatus(); CompatibilityStatus getToolChainCompatibilityStatus();
/** /**
* answers whether the current tool-chain is compatible, * @return whether the current tool-chain is compatible,
* i.e. whether the {@link #getToolChainCompatibilityStatus()} returns a * i.e. whether the {@link #getToolChainCompatibilityStatus()} returns a
* non-ERROR status * non-ERROR status
*
* @return
*/ */
boolean isToolChainCompatible(); boolean isToolChainCompatible();
/** /**
* returns the current tool-chain * @return the current tool-chain
* @return
*/ */
IToolChain getToolChain(); IToolChain getToolChain();
@ -49,8 +44,6 @@ public interface IFolderInfoModification extends IToolListModification {
* sets the current tool-chain * sets the current tool-chain
* once the tool-chain is changed all child Tool and Builder Modifications * once the tool-chain is changed all child Tool and Builder Modifications
* become invalid, i.e. one should re-query the modifications needed * become invalid, i.e. one should re-query the modifications needed
*
* @param tc
*/ */
void setToolChain(IToolChain tc); void setToolChain(IToolChain tc);
} }

View file

@ -24,14 +24,11 @@ public interface IModificationOperation {
* that is to replace the project tool * that is to replace the project tool
* For system IToolModification the replacement tool is a project tool * For system IToolModification the replacement tool is a project tool
* to be replaced with the system tool * to be replaced with the system tool
*
* @return
*/ */
ITool getReplacementTool(); ITool getReplacementTool();
/** /**
* returns the containing {@link IToolModification} * returns the containing {@link IToolModification}
* @return
*/ */
IToolModification getToolModification(); IToolModification getToolModification();
} }

View file

@ -29,17 +29,11 @@ public interface IToolChainModificationManager {
* returns the modification info calculator for the given folder info * returns the modification info calculator for the given folder info
* if the folder info is a root folder info, * if the folder info is a root folder info,
* returns the {@link IConfigurationModification} * returns the {@link IConfigurationModification}
*
* @param rcInfo
* @return
*/ */
IFolderInfoModification createModification(IFolderInfo rcInfo); IFolderInfoModification createModification(IFolderInfo rcInfo);
/** /**
* returns the modification info calculator for the given file info * returns the modification info calculator for the given file info
*
* @param rcInfo
* @return
*/ */
IFileInfoModification createModification(IFileInfo rcInfo); IFileInfoModification createModification(IFileInfo rcInfo);

View file

@ -24,8 +24,6 @@ public interface IToolListModification extends IApplicableModification {
* i.e. one should re-query the ToolModification for each tool needed * i.e. one should re-query the ToolModification for each tool needed
* Note that this method does NOT apply the tools to the underlying resource info * Note that this method does NOT apply the tools to the underlying resource info
* For applying the settings the {@link IApplicableModification#apply()} method should be called * For applying the settings the {@link IApplicableModification#apply()} method should be called
*
* @param tools
*/ */
void changeProjectTools(ITool removeTools, ITool addTool); void changeProjectTools(ITool removeTools, ITool addTool);
@ -33,9 +31,7 @@ public interface IToolListModification extends IApplicableModification {
* returns the list of tools assigned to the given resource info * returns the list of tools assigned to the given resource info
* on the ToolListModificatrion creation the tool-list is the one * on the ToolListModificatrion creation the tool-list is the one
* contained by the given resource info * contained by the given resource info
* the list can be changed by calling the {@link #setProjectTools(ITool[])} method * the list can be changed by calling the {@code #setProjectTools(ITool[])} method
*
* @return
*/ */
ITool[] getProjectTools(); ITool[] getProjectTools();
@ -59,9 +55,6 @@ public interface IToolListModification extends IApplicableModification {
* the returned ToolModification is a project modification for that tool * the returned ToolModification is a project modification for that tool
* otherwise the returned ToolModification tool is a system tool modification for the * otherwise the returned ToolModification tool is a system tool modification for the
* given system tool * given system tool
*
* @param tool
* @return
*/ */
IToolModification getToolModification(ITool tool); IToolModification getToolModification(ITool tool);

View file

@ -23,8 +23,6 @@ public interface IToolModification extends IModification {
* with the configuration * with the configuration
* for system tools specifies whether the tool can be added to the * for system tools specifies whether the tool can be added to the
* configuration * configuration
*
* @return
*/ */
CompatibilityStatus getCompatibilityStatus(); CompatibilityStatus getCompatibilityStatus();
@ -37,26 +35,21 @@ public interface IToolModification extends IModification {
* with the configuration * with the configuration
* for system tools specifies whether the tool can be added to the * for system tools specifies whether the tool can be added to the
* configuration * configuration
*
* @return
*/ */
boolean isCompatible(); boolean isCompatible();
/** /**
* returns the tool of the given Modification * returns the tool of the given Modification
* @return
*/ */
ITool getTool(); ITool getTool();
/** /**
* specifies whether the current tools belongs to the resource configuration * specifies whether the current tools belongs to the resource configuration
* @return
*/ */
boolean isProjectTool(); boolean isProjectTool();
/** /**
* returns the list of supported operations * returns the list of supported operations
* @return
*/ */
IModificationOperation[] getSupportedOperations(); IModificationOperation[] getSupportedOperations();
} }

View file

@ -75,13 +75,7 @@ public class ProjectCreatedActions {
* </ul> * </ul>
* <p> * <p>
* *
* @param project the IProject to turn into a CDT MBS project
* @param projType
* @param configs
* @param artifactExtn
* @return an IManagedBuildInfo instance (from which the IManagedProject can be retrieved) * @return an IManagedBuildInfo instance (from which the IManagedProject can be retrieved)
* @throws CoreException
* @throws BuildException
*/ */
public IManagedBuildInfo createProject(IProgressMonitor monitor, String indexerId, boolean isCProject) throws CoreException, BuildException { public IManagedBuildInfo createProject(IProgressMonitor monitor, String indexerId, boolean isCProject) throws CoreException, BuildException {
if(!areFieldsValid()) { if(!areFieldsValid()) {

View file

@ -110,10 +110,6 @@ public class NewManagedProject extends ProcessRunner {
/** /**
* setOptionValue * setOptionValue
* @param config
* @param option
* @param val
* @throws BuildException
*/ */
protected void setOptionValue(IConfiguration config, IOption option, String val) throws BuildException { protected void setOptionValue(IConfiguration config, IOption option, String val) throws BuildException {
if (val != null) { if (val != null) {

View file

@ -171,10 +171,8 @@ public class MakeScannerProvider extends ScannerProvider {
/** /**
* The build model manager for standard builds only caches the build information for a resource on a per-session basis. This * The build model manager for standard builds only caches the build information for a resource on a per-session basis. This
* method allows clients of the build model manager to programmatically remove the association between the resource and the * method allows clients of the build model manager to programmatically remove the association between the resource and the
* information while the reource is still open or in the workspace. The Eclipse core will take care of removing it if a resource * information while the resource is still open or in the workspace. The Eclipse core will take care of removing it if a resource
* is closed or deleted. * is closed or deleted.
*
* @param resource
*/ */
public static void removeScannerInfo(IResource resource) { public static void removeScannerInfo(IResource resource) {
try { try {
@ -186,8 +184,6 @@ public class MakeScannerProvider extends ScannerProvider {
/** /**
* Persists build-specific information in the build file. Build information for standard make projects consists of preprocessor * Persists build-specific information in the build file. Build information for standard make projects consists of preprocessor
* symbols and includes paths. Other project-related information is stored in the persistent properties of the project. * symbols and includes paths. Other project-related information is stored in the persistent properties of the project.
*
* @param project
*/ */
public static void updateScannerInfo(final MakeScannerInfo scannerInfo) throws CoreException { public static void updateScannerInfo(final MakeScannerInfo scannerInfo) throws CoreException {
ResourcesPlugin.getWorkspace().run(new IWorkspaceRunnable() { ResourcesPlugin.getWorkspace().run(new IWorkspaceRunnable() {