diff options
Diffstat (limited to 'org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemReporter.java')
| -rw-r--r-- | org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemReporter.java | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemReporter.java b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemReporter.java index 059f155..a928593 100644 --- a/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemReporter.java +++ b/org.eclipse.cdt.codan.core/src/org/eclipse/cdt/codan/core/model/IProblemReporter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2009 Alena Laskavaia + * Copyright (c) 2009, 2010 Alena Laskavaia * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -10,20 +10,32 @@ *******************************************************************************/ package org.eclipse.cdt.codan.core.model; - /** * IProblemReporter - interface to report problems - * + * + * <p> + * <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 it will remain the same. + * </p> */ public interface IProblemReporter { - public static final String GENERIC_CODE_ANALYSIS_MARKER_TYPE = "org.eclipse.cdt.codan.core.codanProblem"; /** - * Report a problem with "problemId" id on location determined by "loc", - * using problem specific error message customised by args. - * @param problemId - id of the problem registers with checker - * @param loc - location object - * @param args - custom args, can be null, in this case default message is reported + * id of generic codan problem marker + */ + public static final String GENERIC_CODE_ANALYSIS_MARKER_TYPE = "org.eclipse.cdt.codan.core.codanProblem"; //$NON-NLS-1$ + + /** + * Report a problem with "problemId" id on the location determined by "loc", + * using problem specific error message customized by args. + * + * @param problemId - id of the problem registered with a checker + * @param loc - location object, can be created using + * getRuntime().getProblemLocationFactory().createProblemLocation + * methods + * @param args - custom arguments, can be null, in this case default message + * is reported */ - public void reportProblem(String problemId, IProblemLocation loc, - Object ... args); + public void reportProblem(String problemId, IProblemLocation loc, + Object... args); }
\ No newline at end of file |