mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-08 18:26:01 +02:00
Code Issues Wiki Activity

Javadoc adjustments.

Browse source
This commit is contained in:
Sergey Prigogin 2011-02-20 00:50:56 +00:00
parent dafa751ccf
commit f1d8668d9a
1 changed files with 18 additions and 23 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/IProblemWorkingCopy.java
View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2009, 2010 Alena Laskavaia * Copyright (c) 2009, 2011 Alena Laskavaia
* All rights reserved. This program and the accompanying materials * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -15,7 +15,6 @@ import org.eclipse.cdt.codan.core.param.IProblemPreference;
/** /**
* Modifiable problem. * Modifiable problem.
* *
*
* <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
@ -30,31 +29,28 @@ public interface IProblemWorkingCopy extends IProblem {
* Set severity for this this problem instance. Severity can only be changed * Set severity for this this problem instance. Severity can only be changed
* in profile not by checker when printing problems. * in profile not by checker when printing problems.
* *
* @param sev * @param sev - codan severity
* - codan severity
*/ */
void setSeverity(CodanSeverity sev); void setSeverity(CodanSeverity sev);
/** /**
* Set checker enablement. * Sets checker enablement.
* *
* @param enabled * @param enabled - true if problem is enabled in profile
* - true if problem is enabled in profile
*/ */
void setEnabled(boolean enabled); void setEnabled(boolean enabled);
/** /**
* Set default message pattern. UI would call this method if user does not * Sets default message pattern. UI would call this method if user does not
* like default settings, checker should not use method, default message * like default settings, checker should not use method, default message
* pattern should be set in checker extension * pattern should be set in checker extension
* *
* @param messagePattern * @param messagePattern - java style message patter, e.g. "Variable {0} is never used".
* - java style message patter i.e. "Variable {0} is never used"
*/ */
void setMessagePattern(String messagePattern); void setMessagePattern(String messagePattern);
/** /**
* Set value for the checker parameter, checker may set value during * Sets value for the checker parameter, checker may set value during
* initialization only, which would the default. User control this values * initialization only, which would the default. User control this values
* through ui later. * through ui later.
* *
@ -64,10 +60,9 @@ public interface IProblemWorkingCopy extends IProblem {
public void setPreference(IProblemPreference pref); public void setPreference(IProblemPreference pref);
/** /**
* Set problem description * Sets problem description
* *
* @param desc * @param desc - problem description - short version, but longer than name
* - problem description - short version, but longer than name
*/ */
public void setDescription(String desc); public void setDescription(String desc);
} }