Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlena Laskavaia2009-05-09 01:54:38 +0000
committerAlena Laskavaia2009-05-09 01:54:38 +0000
commitb73e485897b0d92aba5de6a677213d9251f316b6 (patch)
tree744765ca77c9ef227df76bd990ca658975000ccc
parent46c0442b8506e56eb5e82267396bcea2c0d17e62 (diff)
downloadorg.eclipse.cdt-b73e485897b0d92aba5de6a677213d9251f316b6.tar.gz
org.eclipse.cdt-b73e485897b0d92aba5de6a677213d9251f316b6.tar.xz
org.eclipse.cdt-b73e485897b0d92aba5de6a677213d9251f316b6.zip
added comments
-rw-r--r--codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemProfile.java29
1 files changed, 28 insertions, 1 deletions
diff --git a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemProfile.java b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemProfile.java
index 6b4a9c6d875..9dc465e9b22 100644
--- a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemProfile.java
+++ b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemProfile.java
@@ -11,15 +11,42 @@
package org.eclipse.cdt.codan.core.model;
/**
- * @author Alena
+ * Problem Profile contains tree of categories and problems. Profiles can have
+ * different categories and different problems set, problems with the same id
+ * can have different severities/enablement in different profiles. To obtain
+ * profile use class {@link CheckersRegisry#getResourceProfile,
+ * CheckersRegisry#getDefaultProfile() or CheckersRegisry#getWorkspaceProfile()}
+ * .
*
*/
public interface IProblemProfile extends IProblemElement {
+ /**
+ * @return root category in profile
+ */
IProblemCategory getRoot();
+ /**
+ * Find and return problem by id
+ *
+ * @param id
+ * - problem id
+ * @return problem instance
+ */
IProblem findProblem(String id);
+ /**
+ * Find and return category by id
+ *
+ * @param id
+ * - category id
+ * @return category instance
+ */
IProblemCategory findCategory(String id);
+ /**
+ * Get all defined problems
+ *
+ * @return array of problems defined in profile
+ */
IProblem[] getProblems();
}

Back to the top