1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-07 17:56:01 +02:00

JavaDoc warnings

This commit is contained in:
Andrew Gvozdev 2010-04-29 18:22:17 +00:00
parent ed4c5ff4a2
commit a3dbe6b359
9 changed files with 5 additions and 68 deletions

View file

@ -173,8 +173,6 @@ public class MakeScannerProvider extends ScannerProvider {
* 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 reource 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() {

View file

@ -21,13 +21,11 @@ public interface IGNUMakefile extends IMakefile {
/** /**
* Set the search include directories for the * Set the search include directories for the
* "include" directive * "include" directive
* @param paths
*/ */
void setIncludeDirectories(String[] paths); void setIncludeDirectories(String[] paths);
/** /**
* Get the include directories search paths. * @return the include directories search paths.
* @return
*/ */
String[] getIncludeDirectories(); String[] getIncludeDirectories();
} }

View file

@ -22,6 +22,7 @@ import org.eclipse.cdt.make.internal.core.MakeMessages;
import org.eclipse.cdt.make.internal.core.scannerconfig.jobs.SCJobsUtil; import org.eclipse.cdt.make.internal.core.scannerconfig.jobs.SCJobsUtil;
import org.eclipse.cdt.make.internal.core.scannerconfig2.ScannerConfigProfileManager; import org.eclipse.cdt.make.internal.core.scannerconfig2.ScannerConfigProfileManager;
import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.SubProgressMonitor; import org.eclipse.core.runtime.SubProgressMonitor;

View file

@ -232,10 +232,6 @@ public class PosixMakefile extends AbstractMakefile {
return builtins; return builtins;
} }
/**
* @param line
* @return
*/
protected SpecialRule processSpecialRule(String line) { protected SpecialRule processSpecialRule(String line) {
line = line.trim(); line = line.trim();
String keyword = null; String keyword = null;

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2004, 2009 IBM Corporation and others. * Copyright (c) 2004, 2010 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -295,10 +295,6 @@ public class PerFileSICollector implements IScannerInfoCollector3, IScannerInfoC
} }
} }
/**
* @param file
* @param object
*/
private void addCompilerCommand(IFile file, CCommandDSC cmd) { private void addCompilerCommand(IFile file, CCommandDSC cmd) {
assert Thread.holdsLock(fLock); assert Thread.holdsLock(fLock);
List<CCommandDSC> existingCommands = new ArrayList<CCommandDSC>(sid.commandIdCommandMap.values()); List<CCommandDSC> existingCommands = new ArrayList<CCommandDSC>(sid.commandIdCommandMap.values());
@ -323,10 +319,6 @@ public class PerFileSICollector implements IScannerInfoCollector3, IScannerInfoC
generateFileDelta(file, cmd); generateFileDelta(file, cmd);
} }
/**
* @param file
* @param cmd
*/
private void generateFileDelta(IFile file, CCommandDSC cmd) { private void generateFileDelta(IFile file, CCommandDSC cmd) {
assert Thread.holdsLock(fLock); assert Thread.holdsLock(fLock);
Integer commandId = cmd.getCommandIdAsInteger(); Integer commandId = cmd.getCommandIdAsInteger();
@ -342,10 +334,6 @@ public class PerFileSICollector implements IScannerInfoCollector3, IScannerInfoC
} }
} }
/**
* @param file
* @param cmd
*/
private void applyFileDeltas() { private void applyFileDeltas() {
assert Thread.holdsLock(fLock); assert Thread.holdsLock(fLock);
for (Iterator<IResource> i = siChangedForFileMap.keySet().iterator(); i.hasNext(); ) { for (Iterator<IResource> i = siChangedForFileMap.keySet().iterator(); i.hasNext(); ) {
@ -429,10 +417,6 @@ public class PerFileSICollector implements IScannerInfoCollector3, IScannerInfoC
} }
} }
/**
* @param type
* @param object
*/
private void addScannerInfo(ScannerInfoTypes type, List delta) { private void addScannerInfo(ScannerInfoTypes type, List delta) {
// TODO Auto-generated method stub // TODO Auto-generated method stub

View file

@ -61,10 +61,6 @@ public class SCDMakefileGenerator extends DefaultRunSIProvider {
return generateMakefile(resource.getProject().getName()); return generateMakefile(resource.getProject().getName());
} }
/**
* @param name
* @return
*/
private boolean generateMakefile(String projectName) { private boolean generateMakefile(String projectName) {
boolean rc = false; boolean rc = false;
if (collector instanceof IScannerInfoCollector2) { if (collector instanceof IScannerInfoCollector2) {

View file

@ -988,7 +988,7 @@ public class ScannerConfigInfoFactory2 {
/** /**
* @param profile element * @param profile element
* @param profile options * @param po options
*/ */
private void store(ICStorageElement profile, ProfileOptions po) { private void store(ICStorageElement profile, ProfileOptions po) {
ICStorageElement child, grandchild; ICStorageElement child, grandchild;

View file

@ -62,9 +62,6 @@ public class ScannerConfigProfile {
public final class ScannerInfoConsoleParser { public final class ScannerInfoConsoleParser {
private IConfigurationElement configElem; private IConfigurationElement configElem;
/**
* @param scannerInfoConsoleParser
*/
public ScannerInfoConsoleParser(IConfigurationElement configElem) { public ScannerInfoConsoleParser(IConfigurationElement configElem) {
this.configElem = configElem; this.configElem = configElem;
} }
@ -113,9 +110,6 @@ public class ScannerConfigProfile {
* @author vhirsl * @author vhirsl
*/ */
public final class Run extends Action { public final class Run extends Action {
/**
* @param run
*/
public Run(IConfigurationElement run) { public Run(IConfigurationElement run) {
super(run); super(run);
} }
@ -138,9 +132,6 @@ public class ScannerConfigProfile {
* @author vhirsl * @author vhirsl
*/ */
public final class Open extends Action { public final class Open extends Action {
/**
* @param open
*/
public Open(IConfigurationElement open) { public Open(IConfigurationElement open) {
super(open); super(open);
} }
@ -239,9 +230,6 @@ public class ScannerConfigProfile {
private Boolean supportsContext; private Boolean supportsContext;
/**
* @param profileId
*/
public ScannerConfigProfile(String profileId) { public ScannerConfigProfile(String profileId) {
id = profileId; id = profileId;
load(); load();

View file

@ -73,8 +73,6 @@ public final class ScannerConfigProfileManager {
/** /**
* For projects that do not have profile id specified in .project file. * For projects that do not have profile id specified in .project file.
* For example managed projects. * For example managed projects.
* @param project
* @param profile
*/ */
public void addProfile(IProject project, ScannerConfigProfile profile) { public void addProfile(IProject project, ScannerConfigProfile profile) {
addProfile(project, new InfoContext(project), profile); addProfile(project, new InfoContext(project), profile);
@ -102,9 +100,8 @@ public final class ScannerConfigProfileManager {
} }
/** /**
* @param project
* @param profileId - if null, get the one associated with the project * @param profileId - if null, get the one associated with the project
* @return Returns the scannerConfigProfile instance for a project. * @return the scannerConfigProfile instance for a project.
*/ */
public SCProfileInstance getSCProfileInstance(IProject project, String profileId) { public SCProfileInstance getSCProfileInstance(IProject project, String profileId) {
return getSCProfileInstance(project, new InfoContext(project), profileId); return getSCProfileInstance(project, new InfoContext(project), profileId);
@ -128,10 +125,6 @@ public final class ScannerConfigProfileManager {
} }
} }
/**
* @param profileId
* @return
*/
public SCProfileInstance getSCProfileInstance(String profileId) { public SCProfileInstance getSCProfileInstance(String profileId) {
SCProfileInstance profileInstance = null; SCProfileInstance profileInstance = null;
if (profileId != NULL_PROFILE_ID) { if (profileId != NULL_PROFILE_ID) {
@ -171,7 +164,6 @@ public final class ScannerConfigProfileManager {
} }
/** /**
* @param context
* @return the list of profile IDs supported for this context * @return the list of profile IDs supported for this context
*/ */
public List<String> getProfileIds(InfoContext context){ public List<String> getProfileIds(InfoContext context){
@ -203,10 +195,6 @@ public final class ScannerConfigProfileManager {
/** /**
* Set selectedProfile to profileId * Set selectedProfile to profileId
* @param project
* @param profileId
* @return
* @throws CoreException
*/ */
public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(IProject project, String profileId) throws CoreException { public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(IProject project, String profileId) throws CoreException {
return ScannerConfigInfoFactory2.create(project, profileId); return ScannerConfigInfoFactory2.create(project, profileId);
@ -214,9 +202,6 @@ public final class ScannerConfigProfileManager {
/** /**
* Use stored selectedProfile * Use stored selectedProfile
* @param project
* @return
* @throws CoreException
*/ */
public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(IProject project) throws CoreException { public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(IProject project) throws CoreException {
return ScannerConfigInfoFactory2.create(project, ScannerConfigProfileManager.NULL_PROFILE_ID); return ScannerConfigInfoFactory2.create(project, ScannerConfigProfileManager.NULL_PROFILE_ID);
@ -240,10 +225,6 @@ public final class ScannerConfigProfileManager {
/** /**
* Set selectedProfile to profileId * Set selectedProfile to profileId
* @param prefs
* @param profileId
* @param useDefaults
* @return
*/ */
public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(Preferences prefs, String profileId, boolean useDefaults) { public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(Preferences prefs, String profileId, boolean useDefaults) {
return ScannerConfigInfoFactory2.create(prefs, profileId, useDefaults); return ScannerConfigInfoFactory2.create(prefs, profileId, useDefaults);
@ -251,9 +232,6 @@ public final class ScannerConfigProfileManager {
/** /**
* Use stored selectedProfile * Use stored selectedProfile
* @param prefs
* @param useDefaults
* @return
*/ */
public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(Preferences prefs, boolean useDefaults) { public static IScannerConfigBuilderInfo2 createScannerConfigBuildInfo2(Preferences prefs, boolean useDefaults) {
return ScannerConfigInfoFactory2.create(prefs, ScannerConfigProfileManager.NULL_PROFILE_ID, useDefaults); return ScannerConfigInfoFactory2.create(prefs, ScannerConfigProfileManager.NULL_PROFILE_ID, useDefaults);