1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-08 10:16:03 +02:00

- added provisional comments to classes

This commit is contained in:
Alena Laskavaia 2010-03-12 19:55:10 +00:00
parent 918fa29658
commit 20b24a0ea7
14 changed files with 72 additions and 7 deletions

View file

@ -24,6 +24,12 @@ import org.eclipse.cdt.codan.internal.core.model.ProblemLocationFactory;
* Runtime singleton class to get access to Codan framework parts * Runtime singleton class to get access to Codan framework parts
* *
* Clients may extend this class to override default framework parts. * Clients may extend this class to override default framework parts.
*
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public class CodanRuntime { public class CodanRuntime {
private static CodanRuntime instance = new CodanRuntime(); private static CodanRuntime instance = new CodanRuntime();

View file

@ -12,6 +12,11 @@ package org.eclipse.cdt.codan.core;
/** /**
* Constant definitions for plug-in preferences * Constant definitions for plug-in preferences
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public class PreferenceConstants { public class PreferenceConstants {
public static final String P_RUN_ON_BUILD = "booleanPreference"; //$NON-NLS-1$ public static final String P_RUN_ON_BUILD = "booleanPreference"; //$NON-NLS-1$

View file

@ -16,22 +16,27 @@ import org.eclipse.core.resources.IFile;
* Abstract Implementation of IProblemLocation * Abstract Implementation of IProblemLocation
* *
* Clients may extend this class. * Clients may extend this class.
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public abstract class ProblemLocation implements IProblemLocation { public abstract class AbstractProblemLocation implements IProblemLocation {
protected IFile file; protected IFile file;
protected int line; protected int line;
protected int posStart; protected int posStart;
protected int posEnd; protected int posEnd;
protected Object extra; protected Object extra;
protected ProblemLocation(IFile file, int line) { protected AbstractProblemLocation(IFile file, int line) {
this.file = file; this.file = file;
this.line = line; this.line = line;
this.posStart = -1; this.posStart = -1;
this.posEnd = -1; this.posEnd = -1;
} }
protected ProblemLocation(IFile file, int startChar, int endChar) { protected AbstractProblemLocation(IFile file, int startChar, int endChar) {
this.file = file; this.file = file;
this.line = -1; this.line = -1;
this.posStart = startChar; this.posStart = startChar;

View file

@ -17,6 +17,12 @@ import org.eclipse.cdt.core.dom.ast.IASTTranslationUnit;
* Default implementation {@link AbstractIndexAstChecker} * Default implementation {@link AbstractIndexAstChecker}
* *
* Clients may implement and extend this interface. * Clients may implement and extend this interface.
*
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public interface ICAstChecker extends IChecker { public interface ICAstChecker extends IChecker {
/** /**

View file

@ -17,6 +17,11 @@ import org.eclipse.cdt.core.model.ITranslationUnit;
* Default implementation {@link AbstractCIndexChecker} * Default implementation {@link AbstractCIndexChecker}
* *
* Client may implement this interface. * Client may implement this interface.
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public interface ICIndexChecker extends IChecker { public interface ICIndexChecker extends IChecker {
/** /**

View file

@ -16,6 +16,15 @@ import org.eclipse.core.resources.IResource;
* Interface that checker must implement. CDT Checker must be able to process a resource. * Interface that checker must implement. CDT Checker must be able to process a resource.
* *
* Clients may implement and extend this interface. * Clients may implement and extend this interface.
*
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. Extend AbstractChecker class instead.
*/ */
public interface IChecker { public interface IChecker {
/** /**

View file

@ -15,6 +15,8 @@ package org.eclipse.cdt.codan.core.model;
* interface method would be called on initialization so checker has * interface method would be called on initialization so checker has
* a chance to set default values for its parameters * a chance to set default values for its parameters
* *
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ICheckerWithParameters { public interface ICheckerWithParameters {
/** /**

View file

@ -18,6 +18,9 @@ import org.eclipse.core.resources.IResource;
* This interface an API to add/remove checker and problems programmatically, * This interface an API to add/remove checker and problems programmatically,
* get problem profiles and change problem default settings * get problem profiles and change problem default settings
* *
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*
*/ */
public interface ICheckersRegistry extends Iterable<IChecker> { public interface ICheckersRegistry extends Iterable<IChecker> {
/** /**

View file

@ -18,6 +18,11 @@ package org.eclipse.cdt.codan.core.model;
* be created (i.e. one for error and one for warning). * be created (i.e. one for error and one for warning).
* *
* Clients may implement and extend this interface. * Clients may implement and extend this interface.
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
* *
*/ */
public interface IProblem extends IProblemElement { public interface IProblem extends IProblemElement {

View file

@ -12,7 +12,11 @@ package org.eclipse.cdt.codan.core.model;
/** /**
* Problem category. * Problem category.
* * <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
* Clients may extend and implement this interface. * Clients may extend and implement this interface.
*/ */
public interface IProblemCategory extends IProblemElement { public interface IProblemCategory extends IProblemElement {

View file

@ -16,6 +16,11 @@ import org.eclipse.core.resources.IFile;
* Factory interface that allows to create problem locations. * Factory interface that allows to create problem locations.
* *
* Clients may implement and extend this interface. * Clients may implement and extend this interface.
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public interface IProblemLocationFactory { public interface IProblemLocationFactory {

View file

@ -14,6 +14,11 @@ package org.eclipse.cdt.codan.core.model;
* IProblemReporter - interface to report problems * IProblemReporter - interface to report problems
* *
* Clients may implement and extend this interface * Clients may implement and extend this interface
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public interface IProblemReporter { public interface IProblemReporter {
public static final String GENERIC_CODE_ANALYSIS_MARKER_TYPE = "org.eclipse.cdt.codan.core.codanProblem"; //$NON-NLS-1$ public static final String GENERIC_CODE_ANALYSIS_MARKER_TYPE = "org.eclipse.cdt.codan.core.codanProblem"; //$NON-NLS-1$

View file

@ -11,9 +11,14 @@
package org.eclipse.cdt.codan.core.model; package org.eclipse.cdt.codan.core.model;
/** /**
* Modifiable problem * Modifiable problem.
* *
* Clients may extend and implement this interface * Clients may extend and implement this interface
* <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same.
* </p>
*/ */
public interface IProblemWorkingCopy extends IProblem { public interface IProblemWorkingCopy extends IProblem {
/** /**

View file

@ -10,14 +10,14 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.codan.internal.core.model; package org.eclipse.cdt.codan.internal.core.model;
import org.eclipse.cdt.codan.core.model.ProblemLocation; import org.eclipse.cdt.codan.core.model.AbstractProblemLocation;
import org.eclipse.core.resources.IFile; import org.eclipse.core.resources.IFile;
/** /**
* Codan Problem Location, so far same as abstract class * Codan Problem Location, so far same as abstract class
* *
*/ */
public class CodanProblemLocation extends ProblemLocation { public class CodanProblemLocation extends AbstractProblemLocation {
public CodanProblemLocation(IFile file, int startChar, int endChar) { public CodanProblemLocation(IFile file, int startChar, int endChar) {
super(file, startChar, endChar); super(file, startChar, endChar);