1 files changed, 28 insertions, 0 deletions
diff --git a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java
index 52cfff2..bbab313 100644
--- a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java
+++ b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java
@@ -12,15 +12,38 @@ package org.eclipse.cdt.codan.core.model;
 
 import java.util.Collection;
 
+/**
+ * Interface representing code analysis problem
+ *
+ */
 public interface IProblem extends IProblemElement {
+	/**
+	 * Name of the problem - user visible "title", not the message
+	 */
 	String getName();
 
+	/**
+	 * Unique problem id. Should be qualified by plugin name to maintain uniqueness. 
+	 * @return
+	 */
 	String getId();
 
+	/**
+	 * Is enabled in current context (usually within profile)
+	 * @return true if enabled
+	 */
 	boolean isEnabled();
 
+	/**
+	 * Get current severity
+	 * @return severity
+	 */
 	CodanSeverity getSeverity();
 
+	/**
+	 * Message pattern, java patter like 'Variable {0} is never used here'
+	 * @return pattern 
+	 */
 	String getMessagePattern();
 
 	void setSeverity(CodanSeverity sev);
@@ -31,6 +54,11 @@ public interface IProblem extends IProblemElement {
 
 	public void setProperty(Object key, Object value);
 
+	/**
+	 * Get custom property
+	 * @param property name
+	 * @return property object
+	 */
 	public Object getProperty(Object key);
 
 	public Collection<Object> getPropertyKeys();