1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-23 14:42:11 +02:00

JavaDoc warnings

This commit is contained in:
Andrew Gvozdev 2010-04-29 18:44:27 +00:00
parent da8db8a30d
commit 54c487b625
10 changed files with 33 additions and 117 deletions

View file

@ -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;

View file

@ -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

View file

@ -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())

View file

@ -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
*/

View file

@ -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) {

View file

@ -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;

View file

@ -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();

View file

@ -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);
}

View file

@ -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);

View file

@ -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 {