mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-23 14:42:11 +02:00
Code Issues Wiki Activity

Cosmetics.

Browse source
This commit is contained in:
Sergey Prigogin 2012-04-29 19:06:50 -07:00
parent f3588cf4b0
commit 84c0d6f47c
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
codan/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblem.java
View file

@ -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 * 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 * (i.e. one for error and one for warning). All of problem attributes are
* defined in a checker extension point. * defined in a checker extension point.
* *
* <p> * <p>
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as part * <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 * of a work in progress. There is no guarantee that this API will work or that
* it will remain the same. * it will remain the same.
* </p> * </p>
* *
* @noextend This interface is not intended to be extended by clients. * @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IProblem extends IProblemElement { public interface IProblem extends IProblemElement {
/** /**
* Name of the problem - user visible "title", not the message * Name of the problem - user visible "title", not the message
* *
* @return title of the problem * @return title of the problem
*/ */
String getName(); String getName();
@ -41,7 +41,7 @@ public interface IProblem extends IProblemElement {
/** /**
* Unique problem id. Should be qualified by plugin name to maintain * Unique problem id. Should be qualified by plugin name to maintain
* uniqueness. * uniqueness.
* *
* @return unique problem id * @return unique problem id
*/ */
String getId(); String getId();
@ -49,21 +49,22 @@ public interface IProblem extends IProblemElement {
/** /**
* Returns <code>true</code> if the problem is enabled in current context * Returns <code>true</code> if the problem is enabled in current context
* (usually within profile) * (usually within profile)
* *
* @return true if enabled * @return true if enabled
*/ */
boolean isEnabled(); boolean isEnabled();
/** /**
* Returns current severity * Returns current severity
* *
* @return severity * @return severity
*/ */
CodanSeverity getSeverity(); 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 * @return pattern
*/ */
String getMessagePattern(); String getMessagePattern();
@ -71,21 +72,21 @@ public interface IProblem extends IProblemElement {
/** /**
* Returns root preference descriptor or null if not defined (used by UI to * Returns root preference descriptor or null if not defined (used by UI to
* generate user controls for changing parameters) * generate user controls for changing parameters)
* *
* @return root preference or null * @return root preference or null
*/ */
public IProblemPreference getPreference(); public IProblemPreference getPreference();
/** /**
* Returns short description of a problem * Returns short description of a problem
* *
* @return description * @return description
*/ */
public String getDescription(); public String getDescription();
/** /**
* Returns marker id for the problem * Returns marker id for the problem
* *
* @return marker id * @return marker id
*/ */
public String getMarkerType(); public String getMarkerType();