From b73e485897b0d92aba5de6a677213d9251f316b6 Mon Sep 17 00:00:00 2001
From: Alena Laskavaia <elaskavaia.cdt@gmail.com>
Date: Sat, 9 May 2009 01:54:38 +0000
Subject: [PATCH] added comments

---
 .../cdt/codan/core/model/IProblemProfile.java | 29 ++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

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();
 }