From eadd67178c3ad9650626f2e1654aeb3be77cea40 Mon Sep 17 00:00:00 2001
From: Alena Laskavaia <elaskavaia.cdt@gmail.com>
Date: Thu, 18 Mar 2010 15:01:55 +0000
Subject: [PATCH] - added javadoc

---
 .../cdt/codan/core/model/IChecker.java        | 29 ++++++++++++-------
 .../core/model/IRunnableInEditorChecker.java  |  7 +++--
 2 files changed, 24 insertions(+), 12 deletions(-)

diff --git a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
index e3a143703ac..394b55f4b8b 100644
--- a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
+++ b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IChecker.java
@@ -13,38 +13,47 @@ 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.
+ * Interface that checker must implement. CDT Checker must be able to process a
+ * resource.
  * 
  * 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.
+ * <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.
+ * @noimplement This interface is not intended to be implemented by clients.
+ *              Extend AbstractChecker class instead.
  */
 public interface IChecker {
 	/**
 	 * 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
 	 */
 	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 - resource to run on
+	 * Implement this method to trim down type of resource you are interested
+	 * in, usually it will be c/c++ files only
+	 * 
+	 * @param resource
+	 *            - resource to run on
 	 * @return
 	 */
 	boolean enabledInContext(IResource resource);
 
 	/**
 	 * 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
 	 *         otherwise
diff --git a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IRunnableInEditorChecker.java b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IRunnableInEditorChecker.java
index f77b90885e0..780bd87afba 100644
--- a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IRunnableInEditorChecker.java
+++ b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IRunnableInEditorChecker.java
@@ -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
  * 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.
- * @noimplement This interface is not intended to be implemented by clients.
- *              Extend AbstractChecker class instead.
  */
 public interface IRunnableInEditorChecker {
 	/**