diff options
author | Michael Rennie | 2011-07-06 16:12:23 +0000 |
---|---|---|
committer | Michael Rennie | 2011-07-06 16:12:23 +0000 |
commit | ab355ec168efda9893f01c768f9243f2ad85d0bd (patch) | |
tree | 5ffaa80ce1d27112a286a29776197b4c453b46fc /org.eclipse.core.variables | |
parent | 4e1445faf207d52593e07eed3a473095f6808e26 (diff) | |
download | eclipse.platform.debug-ab355ec168efda9893f01c768f9243f2ad85d0bd.tar.gz eclipse.platform.debug-ab355ec168efda9893f01c768f9243f2ad85d0bd.tar.xz eclipse.platform.debug-ab355ec168efda9893f01c768f9243f2ad85d0bd.zip |
[nobug] fix Javadoc warnings
Diffstat (limited to 'org.eclipse.core.variables')
5 files changed, 15 insertions, 9 deletions
diff --git a/org.eclipse.core.variables/META-INF/MANIFEST.MF b/org.eclipse.core.variables/META-INF/MANIFEST.MF index 6093f5dea..8a0c5ec45 100644 --- a/org.eclipse.core.variables/META-INF/MANIFEST.MF +++ b/org.eclipse.core.variables/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %pluginName Bundle-SymbolicName: org.eclipse.core.variables; singleton:=true -Bundle-Version: 3.2.500.qualifier +Bundle-Version: 3.2.600.qualifier Bundle-Activator: org.eclipse.core.variables.VariablesPlugin Bundle-Vendor: %providerName Bundle-Localization: plugin diff --git a/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringSubstitutionEngine.java b/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringSubstitutionEngine.java index 94bd5d7ea..07e8c1769 100644 --- a/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringSubstitutionEngine.java +++ b/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringSubstitutionEngine.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 IBM Corporation and others. + * Copyright (c) 2000, 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 @@ -76,6 +76,7 @@ public class StringSubstitutionEngine { * * @param expression expression to resolve * @param reportUndefinedVariables whether to report undefined variables as an error + * @param resolveVariables if the variables should be resolved during the substitution * @param manager registry of variables * @return the resulting string with all variables recursively * substituted @@ -131,6 +132,8 @@ public class StringSubstitutionEngine { * @param expression source expression * @param reportUndefinedVariables whether to report undefined variables as an error * @param resolveVariables whether to resolve the value of any variables + * @param manager the {@link IStringVariableManager} to use for the substitution + * @return the set of {@link String}s resolved from the given expression * @exception CoreException if unable to resolve a variable */ private HashSet substitute(String expression, boolean reportUndefinedVariables, boolean resolveVariables, IStringVariableManager manager) throws CoreException { @@ -228,7 +231,7 @@ public class StringSubstitutionEngine { * Resolve and return the value of the given variable reference, * possibly <code>null</code>. * - * @param var + * @param var the {@link VariableReference} to try and resolve * @param reportUndefinedVariables whether to report undefined variables as * an error * @param resolveVariables whether to resolve the variables value or just to validate that this variable is valid diff --git a/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariable.java b/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariable.java index 498b411b5..c819bd1a1 100644 --- a/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariable.java +++ b/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariable.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2007 IBM Corporation and others. + * Copyright (c) 2000, 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 @@ -12,6 +12,7 @@ package org.eclipse.core.internal.variables; import org.eclipse.core.runtime.IConfigurationElement; import org.eclipse.core.variables.IStringVariable; +import org.eclipse.core.variables.IValueVariable; /** * Common implementation of context and value variables @@ -72,7 +73,7 @@ public abstract class StringVariable implements IStringVariable { /** * @see IValueVariable#setDescription(String) - * @param description + * @param description the new description to set for the variable */ public void setDescription(String description) { fDescription = description; diff --git a/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariableManager.java b/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariableManager.java index c847de62f..e3e643d6e 100644 --- a/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariableManager.java +++ b/org.eclipse.core.variables/src/org/eclipse/core/internal/variables/StringVariableManager.java @@ -147,8 +147,7 @@ public class StringVariableManager implements IStringVariableManager, IPreferenc /** * Notifies the given listener of the add/change/remove * - * @param listener the listener to notify - * @param launch the launch that has changed + * @param variables the {@link IValueVariable}s to notify about * @param update the type of change */ public void notify(IValueVariable[] variables, int update) { @@ -443,6 +442,8 @@ public class StringVariableManager implements IStringVariableManager, IPreferenc * * @return memento representing the value variables currently registered * @throws IOException if an I/O exception occurs while creating the XML. + * @throws ParserConfigurationException if an I/O exception occurs while creating the XML. + * @throws TransformerException if an exception occurs while creating the XML. */ private String getValueVariablesAsXML() throws IOException, ParserConfigurationException, TransformerException { IValueVariable[] variables = getValueVariables(); @@ -487,7 +488,7 @@ public class StringVariableManager implements IStringVariableManager, IPreferenc * @param doc document to serialize * @return the document as a string * @throws TransformerException if an unrecoverable error occurs during the serialization - * @throws IOException if the encoding attempted to be used is not supported + * @throws UnsupportedEncodingException if the encoding attempted to be used is not supported */ private String serializeDocument(Document doc) throws TransformerException, UnsupportedEncodingException { ByteArrayOutputStream s= new ByteArrayOutputStream(); diff --git a/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java b/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java index 4fa1b74a5..740e2afdb 100644 --- a/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java +++ b/org.eclipse.core.variables/src/org/eclipse/core/variables/VariablesPlugin.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2008 IBM Corporation and others. + * Copyright (c) 2000, 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 @@ -98,6 +98,7 @@ public class VariablesPlugin extends Plugin { /** * Convenience method which returns the unique identifier of this plug-in. + * @return the identifier of this plug-in */ public static String getUniqueIdentifier() { return PI_CORE_VARIABLES; |