diff --git a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java index 07a237ae833..be2ef61d4e0 100644 --- a/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java +++ b/codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java @@ -20,20 +20,20 @@ import org.eclipse.cdt.codan.core.param.IProblemPreference; * determined by runtime. If it is the case - two Problems should be created * (i.e. one for error and one for warning). All of problem attributes are * defined in a checker extension point. - * + * *
* EXPERIMENTAL. 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. *
- * + * * @noextend This interface is not intended to be extended by clients. * @noimplement This interface is not intended to be implemented by clients. */ public interface IProblem extends IProblemElement { /** * Name of the problem - user visible "title", not the message - * + * * @return title of the problem */ String getName(); @@ -41,7 +41,7 @@ public interface IProblem extends IProblemElement { /** * Unique problem id. Should be qualified by plugin name to maintain * uniqueness. - * + * * @return unique problem id */ String getId(); @@ -49,21 +49,22 @@ public interface IProblem extends IProblemElement { /** * Returnstrue
if the problem is enabled in current context
* (usually within profile)
- *
+ *
* @return true if enabled
*/
boolean isEnabled();
/**
* Returns current severity
- *
+ *
* @return severity
*/
CodanSeverity getSeverity();
/**
- * Message pattern, java patter like 'Variable {0} is never used here'
- *
+ * Message pattern suitable for {@link java.text.MessageFormat},
+ * e.g. 'Variable {0} is never used here'.
+ *
* @return pattern
*/
String getMessagePattern();
@@ -71,21 +72,21 @@ public interface IProblem extends IProblemElement {
/**
* Returns root preference descriptor or null if not defined (used by UI to
* generate user controls for changing parameters)
- *
+ *
* @return root preference or null
*/
public IProblemPreference getPreference();
/**
* Returns short description of a problem
- *
+ *
* @return description
*/
public String getDescription();
/**
* Returns marker id for the problem
- *
+ *
* @return marker id
*/
public String getMarkerType();