summaryrefslogtreecommitdiffstats
path: root/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
diff options
context:
space:
mode:
authorElliott Baron <ebaron@fedoraproject.org>2009-12-16 16:51:53 -0500
committerElliott Baron <ebaron@fedoraproject.org>2009-12-16 16:51:53 -0500
commitaf92b8417ae76946c7d10772d8848abbe1126209 (patch)
tree4f1f7ab3def1e2e5facd2582645f663aba399fc3 /org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
parent4baa2f35d979b4e2336431460e313e055661327f (diff)
downloadcodan-af92b8417ae76946c7d10772d8848abbe1126209.tar.gz
codan-af92b8417ae76946c7d10772d8848abbe1126209.tar.xz
codan-af92b8417ae76946c7d10772d8848abbe1126209.zip
Update codan plugins to HEAD.
* org.eclipse.cdt.codan.checkers.ui: Updated. * org.eclipse.cdt.codan.checkers: Updated. * org.eclipse.cdt.codan.core: Updated. * org.eclipse.cdt.codan.ui: Updated.
Diffstat (limited to 'org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java')
-rw-r--r--org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java16
1 files changed, 15 insertions, 1 deletions
diff --git a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
index 4f995db..60f7cb2 100644
--- a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
+++ b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
@@ -12,9 +12,23 @@ package org.eclipse.cdt.codan.core.model;
import org.eclipse.core.resources.IResource;
+/**
+ * Interface that checker must implement. CDT Checker must be able to process a resource.
+ */
public interface IChecker {
- public boolean processResource(IResource resource);
+ /**
+ * Main method that checker should implement that actually detects errors
+ * @param resource - resource to run on
+ * @return true if need to traverse children
+ */
+ boolean processResource(IResource resource);
+ /**
+ * Implement this method to trim down type of resource you are interested in,
+ * usually it will be c/c++ files only
+ * @param resource
+ * @return
+ */
boolean enabledInContext(IResource resource);
/**