From 67634ea7a882285671f6cee39ff94504a35f3cb8 Mon Sep 17 00:00:00 2001 From: Andrew Gvozdev Date: Fri, 12 Aug 2011 13:17:50 -0400 Subject: [PATCH] bug 352166: Cosmetics --- .../eclipse/cdt/core/ErrorParserManager.java | 3 ++- .../eclipse/cdt/core/ProblemMarkerInfo.java | 26 ++++++++++++------- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java index 8556ed529f4..33b7302e2bd 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ErrorParserManager.java @@ -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 * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -569,6 +569,7 @@ outer: /** * Add the given marker to the list of error markers. + * * @param problemMarkerInfo - The marker to be added. * @since 5.4 */ diff --git a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ProblemMarkerInfo.java b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ProblemMarkerInfo.java index 7e3b9ea4f87..b33287aac0f 100644 --- a/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ProblemMarkerInfo.java +++ b/core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/ProblemMarkerInfo.java @@ -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 * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -22,11 +22,12 @@ import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.IPath; /** - * {@link 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) + * {@code ProblemMarkerInfo} is an object used to pass error properties to {@link ErrorParserManager}. * 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. */ public class ProblemMarkerInfo { @@ -42,11 +43,12 @@ public class ProblemMarkerInfo { /** * Create a new {@link ProblemMarkerInfo} object. + * * @param file - the file where the problem has occurred. * @param lineNumber - the line number of the problem. * @param description - a description of the problem. - * @param severity - the severity of the problem @see {@link IMarkerGenerator} - * for acceptable severity values + * @param severity - the severity of the problem, see {@link IMarkerGenerator} + * for acceptable severity values. * @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) { @@ -62,10 +64,11 @@ public class ProblemMarkerInfo { /** * Create a new {@link ProblemMarkerInfo} object. + * * @param file - the file where the problem has occurred. * @param lineNumber - the line number 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 * @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 @@ -88,11 +91,12 @@ public class ProblemMarkerInfo { /** * Return the value of the attribute with the given key, * or null if no such attribute exists. + * * @param key - attribute key. * @return attribute value * @since 5.4 */ - public String getAttribute (String key){ + public String getAttribute(String key){ return this.attributes.get(key); } @@ -100,11 +104,12 @@ public class ProblemMarkerInfo { * Set the value of the attribute with the given key * to the given value, or add one if one does not already * exist. + * * @param key - attribute key. * @param value - new attribute value. * @since 5.4 */ - public void setAttribute (String key, String value){ + public void setAttribute(String key, String value){ this.attributes.put(key, value); } @@ -120,6 +125,7 @@ public class ProblemMarkerInfo { /** * Set the type of this problem marker. + * * @param type - the new type. * @since 5.4 */