mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-31 21:05:37 +02:00
Code Issues Wiki Activity

- added javadoc

Browse source
This commit is contained in:
Alena Laskavaia 2010-03-18 15:01:55 +00:00
parent e79f9bc741
commit eadd67178c
2 changed files with 24 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
View file

@ -13,38 +13,47 @@ package org.eclipse.cdt.codan.core.model;
import org.eclipse.core.resources.IResource; 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> * <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as * <strong>EXPERIMENTAL</strong>. This class or interface has been added as part
* part of a work in progress. There is no guarantee that this API will * of a work in progress. There is no guarantee that this API will work or that
* work or that it will remain the same. * it will remain the same.
* </p> * </p>
* *
* @noextend This interface is not intended to be extended by clients. * @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. * @noimplement This interface is not intended to be implemented by clients.
* Extend AbstractChecker class instead.
*/ */
public interface IChecker { public interface IChecker {
/** /**
* Main method that checker should implement that actually detects errors * Main method that checker should implement that actually detects errors
* @param resource - resource to run on *
* @param resource
* - resource to run on
* @return true if need to traverse children * @return true if need to traverse children
*/ */
boolean processResource(IResource resource); boolean processResource(IResource resource);
/** /**
* Implement this method to trim down type of resource you are interested in, * Implement this method to trim down type of resource you are interested
* usually it will be c/c++ files only * in, usually it will be c/c++ files only
* @param resource - resource to run on *
* @param resource
* - resource to run on
* @return * @return
*/ */
boolean enabledInContext(IResource resource); boolean enabledInContext(IResource resource);
/** /**
* Checker must implement this method to determine if it can run in editor * Checker must implement this method to determine if it can run in editor
* "as you type", checker must be really light weight to run in this mode * "as you type", checker must be really light weight to run in this mode.
* Checker must also must implement IRunnableInEditorChecker if it returns
* true. Checker can return false if check is non-trivial and takes a long
* time.
* *
* @return true if need to be run in editor as user types, and false * @return true if need to be run in editor as user types, and false
* otherwise * otherwise

7
codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IRunnableInEditorChecker.java
View file

@ -13,10 +13,13 @@ package org.eclipse.cdt.codan.core.model;
/** /**
* Interface for checkers that can be run when user is typing, checker has to be * Interface for checkers that can be run when user is typing, checker has to be
* very quick to run in this mode * very quick to run in this mode
* <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. * @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 IRunnableInEditorChecker { public interface IRunnableInEditorChecker {
/** /**