mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

bug 352166: Cosmetics

Browse source
This commit is contained in:
Andrew Gvozdev 2011-08-12 13:17:50 -04:00
parent e34011c34b
commit 67634ea7a8
2 changed files with 18 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java
View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2005, 2010 IBM Corporation and others. * Copyright (c) 2005, 2011 IBM Corporation and others.
* 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
@ -569,6 +569,7 @@ outer:
/** /**
* Add the given marker to the list of error markers. * Add the given marker to the list of error markers.
*
* @param problemMarkerInfo - The marker to be added. * @param problemMarkerInfo - The marker to be added.
* @since 5.4 * @since 5.4
*/ */

22
core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ProblemMarkerInfo.java
View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2009, 2011 Siemens AG and others. * Copyright (c) 2006, 2011 Siemens AG and others.
* All rights reserved. This content and the accompanying materials * All rights reserved. This content 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
@ -22,11 +22,12 @@ import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPath;
/** /**
* {@link ProblemMarkerInfo} is an object used to pass error properties to {@link ErrorParserManager}. * {@code ProblemMarkerInfo} is an object used to pass error properties to {@link ErrorParserManager}.
* @see ErrorParserManager#addProblemMarker(ProblemMarkerInfo) and
* @see ErrorParserManager#generateMarker(IResource, int, String, int, String) and
* @see ErrorParserManager#generateExternalMarker(IResource, int, String, int, String, IPath)
* The information stored in this object will later be used to create an {@link IMarker} by {@link ACBuilder} * The information stored in this object will later be used to create an {@link IMarker} by {@link ACBuilder}
* @see ErrorParserManager#addProblemMarker(ProblemMarkerInfo)
* @see ErrorParserManager#generateMarker(IResource, int, String, int, String)
* @see ErrorParserManager#generateExternalMarker(IResource, int, String, int, String, IPath)
*
* @noextend This class is not intended to be subclassed by clients. * @noextend This class is not intended to be subclassed by clients.
*/ */
public class ProblemMarkerInfo { public class ProblemMarkerInfo {
@ -42,11 +43,12 @@ public class ProblemMarkerInfo {
/** /**
* Create a new {@link ProblemMarkerInfo} object. * Create a new {@link ProblemMarkerInfo} object.
*
* @param file - the file where the problem has occurred. * @param file - the file where the problem has occurred.
* @param lineNumber - the line number of the problem. * @param lineNumber - the line number of the problem.
* @param description - a description of the problem. * @param description - a description of the problem.
* @param severity - the severity of the problem @see {@link IMarkerGenerator} * @param severity - the severity of the problem, see {@link IMarkerGenerator}
* for acceptable severity values * for acceptable severity values.
* @param variableName - the name of the variable involved in the error if any. * @param variableName - the name of the variable involved in the error if any.
*/ */
public ProblemMarkerInfo(IResource file, int lineNumber, String description, int severity, String variableName) { public ProblemMarkerInfo(IResource file, int lineNumber, String description, int severity, String variableName) {
@ -62,10 +64,11 @@ public class ProblemMarkerInfo {
/** /**
* Create a new {@link ProblemMarkerInfo} object. * Create a new {@link ProblemMarkerInfo} object.
*
* @param file - the file where the problem has occurred. * @param file - the file where the problem has occurred.
* @param lineNumber - the line number of the problem. * @param lineNumber - the line number of the problem.
* @param description - a description of the problem. * @param description - a description of the problem.
* @param severity - the severity of the problem @see {@link IMarkerGenerator} * @param severity - the severity of the problem, see {@link IMarkerGenerator}
* for acceptable severity values * for acceptable severity values
* @param variableName - the name of the variable involved in the error if any. * @param variableName - the name of the variable involved in the error if any.
* @param externalPath - if this error involves a file outside the workspace this parameter should * @param externalPath - if this error involves a file outside the workspace this parameter should
@ -88,6 +91,7 @@ public class ProblemMarkerInfo {
/** /**
* Return the value of the attribute with the given key, * Return the value of the attribute with the given key,
* or null if no such attribute exists. * or null if no such attribute exists.
*
* @param key - attribute key. * @param key - attribute key.
* @return attribute value * @return attribute value
* @since 5.4 * @since 5.4
@ -100,6 +104,7 @@ public class ProblemMarkerInfo {
* Set the value of the attribute with the given key * Set the value of the attribute with the given key
* to the given value, or add one if one does not already * to the given value, or add one if one does not already
* exist. * exist.
*
* @param key - attribute key. * @param key - attribute key.
* @param value - new attribute value. * @param value - new attribute value.
* @since 5.4 * @since 5.4
@ -120,6 +125,7 @@ public class ProblemMarkerInfo {
/** /**
* Set the type of this problem marker. * Set the type of this problem marker.
*
* @param type - the new type. * @param type - the new type.
* @since 5.4 * @since 5.4
*/ */