JavaDoc warnings

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/ICommand.java

@@ -39,7 +39,7 @@ public interface ICommand extends IDirective {
 	final public static char TAB = '\t';
 
 	/**
-	 *   -    If the command prefix contains a hyphen, or the -i option is
+	 * -    If the command prefix contains a hyphen, or the -i option is
 	 * present, or the special target .IGNORE has either the current
 	 * target as a prerequisite or has no prerequisites, any error
 	 * found while executing the command will be ignored.

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IDirective.java

@@ -20,22 +20,19 @@ package org.eclipse.cdt.make.core.makefile;
 public interface IDirective {
 
 	/**
-	 * Returns the parent of this directive, null if none.
+	 * @return the parent of this directive, null if none.
-	 * @return
 	 */
 	IDirective getParent();
 
 	/**
-	 * The starting line number of this directive.
+	 * @return the starting line number of this directive.
 	 * The numbering starts at 1 .i.e the first line is not 0
-	 * @return
 	 */
 	int getStartLine();
 
 	/**
-	 * The ending line number of this directive.
+	 * @return the ending line number of this directive.
 	 * The numbering starts at 1 .i.e the first line is not 0
-	 * @return
 	 */
 	int getEndLine();
 

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IMacroDefinition.java

@@ -20,44 +20,38 @@ package org.eclipse.cdt.make.core.makefile;
 public interface IMacroDefinition  extends IDirective {
 
 	/**
-	 * Returns the name of the macro
+	 * @return the name of the macro
-	 * @return
 	 */
 	String getName();
 
 	/**
-	 * Returns the value of the macro
+	 * @return the value of the macro
-	 * @return
 	 */
 	StringBuffer getValue();
 
 	/**
-	 * The macro is a built-in
+	 * @return the macro is a built-in
-	 * @return
 	 */
 	boolean isFromDefault();
 
 	/**
-	 * The macro was found in a Makefile.
+	 * @return the macro was found in a Makefile.
-	 * @return
+	 * 
 	 */
 	boolean isFromMakefile();
 
 	/**
-	 * The macro came from the environment.
+	 * @return the macro came from the environment.
-	 * @return
 	 */
 	boolean isFromEnviroment();
 
 	/**
 	 * The macro came from the make command option -e
-	 * @return
 	 */
 	boolean isFromEnvironmentOverride();
 
 	/**
-	 * The macro was pass from an option to make.
+	 * @return the macro was pass from an option to make.
-	 * @return
 	 */
 	boolean isFromCommand();
 }

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/DiscoveredScannerInfo.java

@@ -24,7 +24,7 @@ import org.eclipse.core.runtime.CoreException;
 
 /**
  * Discovered portion of scanner configuration
- * @deprecated
+ * @deprecated as of CDT 4.0.
  * @author vhirsl
  * 
  * @noextend This class is not intended to be subclassed by clients.
@@ -44,9 +44,6 @@ public class DiscoveredScannerInfo implements IScannerInfo {
 
 	private  org.eclipse.cdt.make.core.MakeScannerInfo userInfo;
 	
-	/**
-	 * @param project
-	 */
 	public DiscoveredScannerInfo(IProject project) {
 		this.project = project;
 	}
@@ -204,16 +201,10 @@ public class DiscoveredScannerInfo implements IScannerInfo {
 		DiscoveredScannerInfoProvider.updateScannerInfo(this);
 	}
 
-	/**
-	 * @param userPaths
-	 */
 	public void setUserIncludePaths(List<String> userPaths) {
 		userInfo.setIncludePaths(userPaths.toArray(new String[userPaths.size()]));
 	}
 
-	/**
-	 * @param userSymbols
-	 */
 	public void setUserDefinedSymbols(List<String> userSymbols) {
 		userInfo.setPreprocessorSymbols(userSymbols.toArray(new String[userSymbols.size()]));
 	}

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/DiscoveredScannerInfoProvider.java

@@ -33,7 +33,8 @@ import org.eclipse.core.runtime.QualifiedName;
 /**
  * Provider of both user specified and discovered scanner info
  * 
- * @deprecated @author vhirsl
+ * @deprecated as of CDT 4.0.
+ * @author vhirsl
  * 
  * @noextend This class is not intended to be subclassed by clients.
  * @noinstantiate This class is not intended to be instantiated by clients.
@@ -131,8 +132,6 @@ public class DiscoveredScannerInfoProvider extends ScannerProvider {
 	 * 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
 	 * is closed or deleted.
-	 * 
-	 * @param resource
 	 */
 	public static void removeScannerInfo(IResource resource) {
 		try {
@@ -144,8 +143,6 @@ public class DiscoveredScannerInfoProvider extends ScannerProvider {
 	/**
 	 * 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.
-	 * 
-	 * @param scannerInfo
 	 */
 	static void updateScannerInfo(DiscoveredScannerInfo scannerInfo) throws CoreException {
 		//		 no longer supported!

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IDiscoveredPathManager.java

@@ -93,15 +93,11 @@ public interface IDiscoveredPathManager {
     interface IDiscoveredScannerInfoSerializable {
         /**
          * Serialize discovered scanner info to an XML element
-         * 
-         * @param root
          */
         public void serialize(Element root);
         
         /**
          * Deserialize discovered scanner info from an XML element
-         * 
-         * @param root
          */
         public void deserialize(Element root);
         

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IExternalScannerInfoProvider.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2004, 2007 IBM Corporation and others.
+ * Copyright (c) 2004, 2010 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -23,12 +23,6 @@ import org.eclipse.core.runtime.IProgressMonitor;
 public interface IExternalScannerInfoProvider {
     /**
      * Invokes a provider to generate scanner info.
-     * 
-     * @param monitor
-     * @param resource project - current project being built
-     * @param providerId - id of the provider 
-     * @param buildInfo - settings for ScannerConfigBuilder
-     * @param collector - scanner info collector for the resource (project)
      */
     public boolean invokeProvider(IProgressMonitor monitor, 
                                   IResource resource,
@@ -38,14 +32,6 @@ public interface IExternalScannerInfoProvider {
 
     /**
      * Alternative interface to pass down the environment.
-     * 
-     * @param monitor
-     * @param resource
-     * @param providerId
-     * @param buildInfo
-     * @param collector
-     * @param env
-     * @return
      */
     public boolean invokeProvider(IProgressMonitor monitor, 
             IResource resource,

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/makefile/Command.java

@@ -48,7 +48,7 @@ public class Command extends Directive implements ICommand {
 	}
 
 	/**
-	 * @    If the command prefix contains an at sign and the
+	 * If the command prefix contains an at sign and the
 	 * command-line -n option is not specified, or the -s option is
 	 * present, or the special target .SILENT has either the current
 	 * target as a prerequisite or has no prerequisites, the command

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/makefile/gnu/GNUMakefile.java

@@ -412,10 +412,6 @@ public class GNUMakefile extends AbstractMakefile implements IGNUMakefile {
 		return stmt;
 	}
 
-	/**
-	 * @param line
-	 * @return
-	 */
 	protected SpecialRule parseSpecialRule(String line) {
 		line = line.trim();
 		String keyword =  null;
@@ -469,8 +465,6 @@ public class GNUMakefile extends AbstractMakefile implements IGNUMakefile {
 	 * ifneq CONDITIONAL
 	 * else
 	 *
-	 * @param line
-	 * @return
 	 */
 	protected Conditional parseConditional(String line) {
 		Conditional condition = null;
@@ -568,10 +562,6 @@ public class GNUMakefile extends AbstractMakefile implements IGNUMakefile {
 		return new VPath(this, pattern, directories);
 	}
 
-	/**
-	 * @param line
-	 * @return
-	 */
 	protected UnExport parseUnExport(String line) {
 		// Pass over "unexport"
 		for (int i = 0; i < line.length(); i++) {
@@ -780,10 +770,6 @@ public class GNUMakefile extends AbstractMakefile implements IGNUMakefile {
 		return staticRules;
 	}
 
-	/**
-	 * @param line
-	 * @return
-	 */
 	protected InferenceRule parseInferenceRule(String line) {
 		String tgt;
 		int index = Util.indexOf(line, ':');

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/makefile/gnu/GNUMakefileChecker.java

@@ -23,6 +23,7 @@ import org.eclipse.core.resources.IResource;
 import org.eclipse.core.resources.IResourceDelta;
 import org.eclipse.core.resources.IResourceDeltaVisitor;
 import org.eclipse.core.resources.IWorkspace;
+import org.eclipse.core.resources.IncrementalProjectBuilder;
 import org.eclipse.core.runtime.CoreException;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.OperationCanceledException;

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/makefile/gnu/GNUMakefileUtil.java

@@ -119,10 +119,6 @@ public class GNUMakefileUtil extends PosixMakefileUtil {
 			|| isMacroDefinition(line);
 	}
 
-	/**
-	 * @param line
-	 * @return
-	 */
 	public static boolean isStaticTargetRule(String line) {
 		line = line.trim();
 		int colon1 = Util.indexOf(line, ':');
@@ -136,10 +132,6 @@ public class GNUMakefileUtil extends PosixMakefileUtil {
 		return false;
 	}
 
-	/**
-	 * @param line
-	 * @return
-	 */
 	public static boolean isGNUTargetRule(String line) {
 		line = line.trim();
 		int colon = Util.indexOf(line, ':');

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/DiscoveredScannerInfoStore.java

@@ -196,10 +196,6 @@ public final class DiscoveredScannerInfoStore {
 		return document;
 	}
 
-	/**
-	* @param document
-	* @param project 
-	*/
 	private void upgradeDocument(Document document, IProject project) {
 		Element rootElem = (Element) document.getElementsByTagName(SI_ELEM).item(0);
 		ProcessingInstruction pi = document.createProcessingInstruction(SCD_STORE_VERSION, "version=\"2.0\""); //$NON-NLS-1$
@@ -231,11 +227,6 @@ public final class DiscoveredScannerInfoStore {
         return cfgElem;
 	}
 	
-	/**
-	* @param scannerInfo
-	* @param rootElement
-	* @param doc
-	*/
 	private void saveDiscoveredScannerInfo(InfoContext context, IDiscoveredScannerInfoSerializable serializable, Document doc) {
 		NodeList rootList = doc.getElementsByTagName(SI_ELEM);
 		if (rootList.getLength() > 0) {
@@ -350,9 +341,6 @@ public final class DiscoveredScannerInfoStore {
         return MakeCorePlugin.getWorkingDirectory().append(fileName);
     }
 
-    /**
-     * @param delta
-     */
     public void updateScannerConfigStore(IResourceDelta delta) {
         try {
             delta.accept(new IResourceDeltaVisitor() {
@@ -395,9 +383,6 @@ public final class DiscoveredScannerInfoStore {
         deletePluginStateFile(scFileName);
     }
 
-    /**
-     * @param scFileName
-     */
     private void deletePluginStateFile(String scFileName) {
         IPath path = MakeCorePlugin.getWorkingDirectory().append(scFileName);
         File file = path.toFile();
@@ -418,10 +403,6 @@ public final class DiscoveredScannerInfoStore {
         }
     }
 
-    /**
-     * @param oldFileName
-     * @param newFileName
-     */
     private void movePluginStateFile(String oldFileName, String newFileName) {
         IPath oldPath = MakeCorePlugin.getWorkingDirectory().append(oldFileName);
         IPath newPath = MakeCorePlugin.getWorkingDirectory().append(newFileName);

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/gnu/GCCPerFileBOPConsoleParserUtility.java

@@ -44,20 +44,10 @@ public class GCCPerFileBOPConsoleParserUtility extends AbstractGCCBOPConsolePars
 	private String fDefaultMacroDefinitionValue= "1"; //$NON-NLS-1$
 
 
-    /**
-     * @param markerGenerator 
-     * @param workingDirectory 
-     * @param project 
-     */
     public GCCPerFileBOPConsoleParserUtility(IProject project, IPath workingDirectory, IMarkerGenerator markerGenerator) {
         super(project, workingDirectory, markerGenerator);
     }
 
-    /**
-     * Adds a mapping filename, generic_command
-     * @param longFileName
-     * @param genericLine
-     */
     void addGenericCommandForFile(String longFileName, String genericCommand) {
         // if a file name has already been added once, return
         if (compiledFileList.contains(longFileName))
@@ -104,8 +94,6 @@ public class GCCPerFileBOPConsoleParserUtility extends AbstractGCCBOPConsolePars
 
     /**
      * Adds a mapping command line -> file, this time without a dir
-     * @param longFileName
-     * @param genericLine
      */
     void addGenericCommandForFile2(String longFileName, String genericLine) {
         // if a file name has already been added once, return
@@ -129,8 +117,6 @@ public class GCCPerFileBOPConsoleParserUtility extends AbstractGCCBOPConsolePars
     }
 
     /**
-     * @param genericLine
-     * @param cppFileType
      * @return CCommandDSC compile command description 
      */
     public CCommandDSC getNewCCommandDSC(String[] tokens, final int idxOfCompilerCommand, boolean cppFileType) {

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/jobs/BuildOutputReaderJob.java

@@ -33,10 +33,6 @@ public class BuildOutputReaderJob extends Job {
     private InfoContext context;
     private IScannerConfigBuilderInfo2 buildInfo;
 
-	/**
-     * @param project
-     * @param buildInfo
-     */
     public BuildOutputReaderJob(IProject project, IScannerConfigBuilderInfo2 buildInfo) {
     	this(project, buildInfo.getContext(), buildInfo);
     }

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/util/CCommandDSC.java

@@ -53,10 +53,7 @@ public class CCommandDSC {
     private List<String> symbols;
     private List<String> includes;
     private List<String> quoteIncludes;
-    
+
-    /**
-	 * @param cppFileType2 
-	 */
 	public CCommandDSC(boolean cppFileType) {
 		this(cppFileType, null);
 	}
@@ -92,9 +89,6 @@ public class CCommandDSC {
 		compilerCommand.add(option);
 	}
 	
-    /**
-     * @return
-     */
     public Integer getCommandIdAsInteger() {
         return new Integer(getCommandId());
     }
@@ -169,8 +163,7 @@ public class CCommandDSC {
 	}
 	
 	/**
-	 * Returns the compiler command
+	 * @return the compiler command
-	 * @return
 	 */
 	public String getCompilerName() {
 		String compiler = new String();
@@ -255,7 +248,7 @@ public class CCommandDSC {
         return makeAbsolute(project, quoteIncludes);
     }
     /**
-     * @param includes. Quote include paths (for #include "...")
+     * @param includes - quote include paths (for #include "...")
      */
     public void setQuoteIncludes(List<String> includes) {
         quoteIncludes = includes;
@@ -285,9 +278,6 @@ public class CCommandDSC {
         this.discovered = discovered;
     }
 
-    /**
-     * @param cmdElem
-     */
     public void serialize(Element cmdElem) {
         Document doc = cmdElem.getOwnerDocument();
         // serialize the command
@@ -324,9 +314,6 @@ public class CCommandDSC {
         cmdElem.appendChild(siElem);
     }
 
-    /**
-     * @param cmdElem
-     */
     public void deserialize(Element cmdElem) {
         // read command options
         NodeList descList = cmdElem.getElementsByTagName(CMD_DESCRIPTION_ELEM);

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig/util/CygpathTranslator.java

@@ -81,10 +81,6 @@ public class CygpathTranslator {
         }
     }
     
-    /**
-     * @param sumIncludes
-     * @return
-     */
     public static List<String> translateIncludePaths(IProject project, List<String> sumIncludes) {
     	// first check if cygpath translation is needed at all
     	boolean translationNeeded = false;

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig2/DefaultRunSIProvider.java

@@ -170,9 +170,6 @@ public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
     /**
      * Initialization of protected fields. 
      * Subclasses are most likely to override default implementation.
-     * 
-     * @param currentProject
-     * @return boolean
      */
     protected boolean initialize() {
     	
@@ -188,19 +185,11 @@ public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
      * Add additional arguments. For example: tso - target specific options
      * Base class implementation returns compileArguments.
      * Subclasses are most likely to override default implementation.
-     * 
-     * @param isDefaultCommand
-     * @param collector 
-     * @return
      */
     protected String[] prepareArguments(boolean isDefaultCommand) {
         return fCompileArguments;
     }
 
-    /**
-     * @param array
-     * @return
-     */
     private String coligate(String[] array) {
         StringBuffer sb = new StringBuffer(128);
         for (int i = 0; i < array.length; ++i) {
@@ -211,10 +200,6 @@ public class DefaultRunSIProvider implements IExternalScannerInfoProvider {
         return ca;
     }
 
-    /**
-     * @param launcher
-     * @return
-     */
     protected String[] setEnvironment(ICommandLauncher launcher, Properties initialEnv) {
         // Set the environmennt, some scripts may need the CWD var to be set.
         Properties props = initialEnv != null ? initialEnv : launcher.getEnvironment();

build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/scannerconfig2/DefaultSIFileReader.java

@@ -104,10 +104,6 @@ public class DefaultSIFileReader implements IExternalScannerInfoProvider {
         return rc;
 	}
 
-    /**
-     * @param inputFileName
-     * @return
-     */
     private BufferedReader getStreamReader(String inputFileName) {
         BufferedReader reader = null;
         try {
@@ -121,8 +117,6 @@ public class DefaultSIFileReader implements IExternalScannerInfoProvider {
 
     /**
      * Precondition: Neither input nor output are null
-     * @param monitor
-     * @return
      */
     private boolean readFileToOutputStream(IProgressMonitor monitor, BufferedReader reader, OutputStream ostream) {
         final String lineSeparator = System.getProperty("line.separator"); //$NON-NLS-1$