Skip to main content
summaryrefslogtreecommitdiffstats
path: root/build
diff options
context:
space:
mode:
authorAndrew Gvozdev2010-04-29 14:44:27 -0400
committerAndrew Gvozdev2010-04-29 14:44:27 -0400
commit54c487b62564570cc0adfe2f7945d43eb29e890d (patch)
treec1db82de60acc7e2e274790fda5244c452a1eb97 /build
parentda8db8a30d9ae031697133709c351635c65e5049 (diff)
downloadorg.eclipse.cdt-54c487b62564570cc0adfe2f7945d43eb29e890d.tar.gz
org.eclipse.cdt-54c487b62564570cc0adfe2f7945d43eb29e890d.tar.xz
org.eclipse.cdt-54c487b62564570cc0adfe2f7945d43eb29e890d.zip
JavaDoc warnings
Diffstat (limited to 'build')
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeBuilderInfo.java24
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeCommonBuildInfo.java9
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilder.java3
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilderUtil.java3
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeCorePlugin.java22
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IMakefile.java65
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IRule.java7
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoCollectorCleaner.java12
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoConsoleParser.java3
-rw-r--r--build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/MakeRecon.java2
10 files changed, 33 insertions, 117 deletions
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeBuilderInfo.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeBuilderInfo.java
index 1ee3101f97..af179af0c1 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeBuilderInfo.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeBuilderInfo.java
@@ -22,10 +22,10 @@ public interface IMakeBuilderInfo extends IMakeCommonBuildInfo {
public final static String BUILD_TARGET_AUTO = ARGS_PREFIX + ".build.target.auto"; //$NON-NLS-1$
public final static String BUILD_TARGET_CLEAN = ARGS_PREFIX + ".build.target.clean"; //$NON-NLS-1$
- /** @deprecated */
+ /** @deprecated as of CDT 4.0 */
@Deprecated
public final static String BUILD_TARGET_INCREAMENTAL = BUILD_TARGET_INCREMENTAL;
- /** @deprecated */
+ /** @deprecated as of CDT 4.0 */
@Deprecated
public final static String BUILD_TARGET_FULL = ARGS_PREFIX + ".build.target.full"; //$NON-NLS-1$
@@ -35,10 +35,7 @@ public interface IMakeBuilderInfo extends IMakeCommonBuildInfo {
String getAutoBuildTarget();
/**
- * @param target
- * @throws CoreException
- *
- * @deprecated
+ * @deprecated as of CDT 3.0
*/
@Deprecated
void setAutoBuildTarget(String target) throws CoreException;
@@ -49,10 +46,7 @@ public interface IMakeBuilderInfo extends IMakeCommonBuildInfo {
String getIncrementalBuildTarget();
/**
- * @param target
- * @throws CoreException
- *
- * @deprecated
+ * @deprecated as of CDT 3.0
*/
@Deprecated
void setIncrementalBuildTarget(String target) throws CoreException;
@@ -63,10 +57,7 @@ public interface IMakeBuilderInfo extends IMakeCommonBuildInfo {
String getFullBuildTarget();
/**
- * @param target
- * @throws CoreException
- *
- * @deprecated
+ * @deprecated as of CDT 3.0
*/
@Deprecated
void setFullBuildTarget(String target) throws CoreException;
@@ -74,10 +65,7 @@ public interface IMakeBuilderInfo extends IMakeCommonBuildInfo {
String getCleanBuildTarget();
/**
- * @param target
- * @throws CoreException
- *
- * @deprecated
+ * @deprecated as of CDT 3.0
*/
@Deprecated
void setCleanBuildTarget(String target) throws CoreException;
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeCommonBuildInfo.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeCommonBuildInfo.java
index 0c1bd3d67d..9ef3ea33a4 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeCommonBuildInfo.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/IMakeCommonBuildInfo.java
@@ -33,9 +33,6 @@ public interface IMakeCommonBuildInfo {
IPath getBuildLocation();
/**
- * @param location
- * @throws CoreException
- *
* @deprecated - use setBuildString(BUILD_LOCATION...)
*/
@Deprecated
@@ -50,9 +47,6 @@ public interface IMakeCommonBuildInfo {
IPath getBuildCommand();
/**
- * @param command
- * @throws CoreException
- *
* @deprecated - use setBuildString(BUILD_COMMAND...)
*/
@Deprecated
@@ -61,9 +55,6 @@ public interface IMakeCommonBuildInfo {
String getBuildArguments();
/**
- * @param args
- * @throws CoreException
- *
* @deprecated - use setBuildString(BUILD_ARGUMENTS...)
*/
@Deprecated
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilder.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilder.java
index e7eb43cbaa..ef905917cb 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilder.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilder.java
@@ -279,7 +279,7 @@ public class MakeBuilder extends ACBuilder {
/**
* Refresh project. Can be overridden to not call actual refresh or to do something else.
* Method is called after build is complete.
- * @param project
+ *
* @since 6.0
*/
protected void refreshProject(IProject project) {
@@ -296,7 +296,6 @@ public class MakeBuilder extends ACBuilder {
/**
* Check whether the build has been canceled.
- * @param monitor
*/
public void checkCancel(IProgressMonitor monitor) {
if (monitor != null && monitor.isCanceled())
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilderUtil.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilderUtil.java
index 1464dc09be..1d36551997 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilderUtil.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeBuilderUtil.java
@@ -54,9 +54,6 @@ public class MakeBuilderUtil {
}
/**
- * Return the URI of the build directory for a prject and IMakeBuilderInfo
- * @param project
- * @param info
* @return URI of the build directory, or the Project's URI if one couldn't be found
* @since 6.0
*/
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeCorePlugin.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeCorePlugin.java
index 2da369b27d..9090be3e7b 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeCorePlugin.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/MakeCorePlugin.java
@@ -157,11 +157,7 @@ public class MakeCorePlugin extends Plugin {
}
/**
- * @deprecated
- * @param file
- * @param isGnuStyle
- * @param makefileDirs
- * @return
+ * @deprecated as of CDT 5.0
*/
@Deprecated
static public IMakefile createMakefile(File file, boolean isGnuStyle, String[] makefileDirs) {
@@ -197,12 +193,9 @@ public class MakeCorePlugin extends Plugin {
/**
* Create an IMakefile using the given IMakefileReaderProvider to fetch
* contents by name.
- * @param name URI of main file
- * @param isGnuStyle
- * @param makefileDirs
+ *
+ * @param fileURI URI of main file
* @param makefileReaderProvider may be <code>null</code> for EFS IFileStore reading
- * @return IMakefile
- * @throws CoreException
*/
public static IMakefile createMakefile(URI fileURI,
boolean isGnuStyle, String[] makefileDirs, IMakefileReaderProvider makefileReaderProvider) {
@@ -233,11 +226,8 @@ public class MakeCorePlugin extends Plugin {
/**
* Create an IMakefile using EFS to fetch contents.
- * @param name URI of main file
- * @param isGnuStyle
- * @param makefileDirs
- * @return IMakefile
- * @throws CoreException
+ *
+ * @param fileURI URI of main file
*/
public static IMakefile createMakefile(URI fileURI,
boolean isGnuStyle, String[] makefileDirs) {
@@ -327,7 +317,6 @@ public class MakeCorePlugin extends Plugin {
}
/**
- * @param commandId
* @return String[] - array of parserIds associated with the commandId or 'all'
*/
public String[] getScannerInfoConsoleParserIds(String commandId) {
@@ -355,7 +344,6 @@ public class MakeCorePlugin extends Plugin {
}
/**
- * @param parserId
* @return parser - parser object identified by the parserId
*/
public IScannerInfoConsoleParser getScannerInfoConsoleParser(String parserId) {
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IMakefile.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IMakefile.java
index f23f85c454..d7a0f43858 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IMakefile.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IMakefile.java
@@ -40,114 +40,85 @@ public interface IMakefile extends IParent {
/**
* ITargetRule | IInferenceRule | ISpecialRule
- * @return
*/
IRule[] getRules();
/**
- * Returns the IRule for target.
- *
- * @param target
- * @return
+ * @return the IRule for target.
*/
IRule[] getRules(String target);
/**
- * Returns IInferenceRule
- * @return
+ * @return IInferenceRule
+ *
*/
IInferenceRule[] getInferenceRules();
/**
- * Returns the IInferenceRules for target.
- * @param target
- * @return
+ * @return the IInferenceRules for target.
*/
IInferenceRule[] getInferenceRules(String target);
/**
- * Returns ITargetRule
- * @return
+ * @return ITargetRule
*/
ITargetRule[] getTargetRules();
/**
- * Returns the ITargetRules for name.
- *
- * @param target
- * @return
+ * @return the ITargetRules for name.
*/
ITargetRule[] getTargetRules(String target);
/**
- * Return IMacroDefinition
- * @return
+ * @return the IMacroDefinitions.
*/
IMacroDefinition[] getMacroDefinitions();
/**
- * Returns the IMacroDefinitions for name.
- *
- * @param name
- * @return
+ * @return the IMacroDefinitions for name.
*/
IMacroDefinition[] getMacroDefinitions(String name);
/**
- * Return all the builtin directives.
- * @return
+ * @return all the built-in directives.
*/
IDirective[] getBuiltins();
/**
- * Return all the buil-in MacroDefintions
- * @return
+ * @return all the built-in MacroDefintions
*/
IMacroDefinition[] getBuiltinMacroDefinitions();
/**
- * Returns the Builtin macro definition for name.
- *
- * @param name
- * @return
+ * @return the built-in macro definition for name.
*/
IMacroDefinition[] getBuiltinMacroDefinitions(String name);
/**
- * Returning after expanding any macros.
- * @return String - expanded line
+ * @return line after expanding any macros.
*/
String expandString(String line);
/**
- * Returning after expanding any macros.
- * @param String - line to expand
- * @param boolean - if true recursively expand.
- * @return String - expanded line
+ * @return line after expanding any macros.
+ *
+ * @param line - line to expand
+ * @param recursive - if true recursively expand.
*/
String expandString(String line, boolean recursive);
/**
- * Get the makefile Reader provider used to create this makefile.
- * @return IMakefileReaderProvider or <code>null</code>
+ * @return the makefile Reader provider used to create this makefile or <code>null</code>
*/
IMakefileReaderProvider getMakefileReaderProvider();
/**
* Clear all statements and (re)parse the Makefile
- *
- * @param filePath
- * @param makefile
- * @throws IOException
*/
void parse(String filePath, Reader makefile) throws IOException;
/**
* Clear all statements and (re)parse the Makefile
- *
- * @param fileURI
- * @param makefile
- * @throws IOException
*/
void parse(URI fileURI, Reader makefile) throws IOException;
@@ -155,9 +126,7 @@ public interface IMakefile extends IParent {
* Clear the all statements and (re)parse the Makefile
* using the given makefile Reader provider
*
- * @param fileURI
* @param makefileReaderProvider provider, or <code>null</code> to use a FileReader
- * @throws IOException
*/
void parse(URI fileURI, IMakefileReaderProvider makefileReaderProvider) throws IOException;
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IRule.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IRule.java
index 9471a04124..71e38f7925 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IRule.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/makefile/IRule.java
@@ -20,14 +20,13 @@ package org.eclipse.cdt.make.core.makefile;
*/
public interface IRule extends IParent {
/**
- * Array of command for the rule.
- * @return
+ * @return Array of command for the rule.
*/
ICommand[] getCommands();
/**
- * The rule target name.
- * @return
+ * @return The rule target name.
+ *
*/
ITarget getTarget();
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoCollectorCleaner.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoCollectorCleaner.java
index 65e09a3b48..64bdbdfb1d 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoCollectorCleaner.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoCollectorCleaner.java
@@ -20,38 +20,26 @@ import org.eclipse.core.resources.IResource;
public interface IScannerInfoCollectorCleaner {
/**
* Delete all discovered paths for the resource
- *
- * @param project
*/
public void deleteAllPaths(IResource resource);
/**
* Delete all discovered symbols for the resource
- *
- * @param project
*/
public void deleteAllSymbols(IResource resource);
/**
* Delete a specific include path
- *
- * @param resource
- * @param path
*/
public void deletePath(IResource resource, String path);
/**
* Delete a specific symbol definition
- *
- * @param resource
- * @param path
*/
public void deleteSymbol(IResource resource, String symbol);
/**
* Delete all discovered scanner info for the resource
- *
- * @param resource
*/
public void deleteAll(IResource resource);
}
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoConsoleParser.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoConsoleParser.java
index 7da04cbcd1..7e8cb9e0be 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoConsoleParser.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/core/scannerconfig/IScannerInfoConsoleParser.java
@@ -24,10 +24,7 @@ public interface IScannerInfoConsoleParser extends IConsoleParser {
/**
* One time initialization of a console parser.
*
- * @param project
- * @param workingDirectory
* @param collector - scanner info collector
- * @param markerGenerator
*/
public void startup(IProject project, IPath workingDirectory,
IScannerInfoCollector collector, IMarkerGenerator markerGenerator);
diff --git a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/MakeRecon.java b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/MakeRecon.java
index 1c299ee952..4c2033a74a 100644
--- a/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/MakeRecon.java
+++ b/build/org.eclipse.cdt.make.core/src/org/eclipse/cdt/make/internal/core/MakeRecon.java
@@ -141,7 +141,7 @@ public class MakeRecon extends OutputStream {
}
/**
- * @see java.io.OutputStream#write(...)
+ * @see java.io.OutputStream#write(byte[], int, int)
*/
@Override
public synchronized void write(byte[] b, int off, int len) throws IOException {

Back to the top