diff options
Diffstat (limited to 'org.eclipse.debug.core/core/org/eclipse/debug/internal')
21 files changed, 195 insertions, 146 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java index 6bd2824e2..72a93b1d6 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointImportParticipantDelegate.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2008 IBM Corporation and others. + * Copyright (c) 2008, 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 @@ -29,7 +29,7 @@ import org.eclipse.debug.core.model.IBreakpointImportParticipant; </extension> * </pre> * - * @noextend This class is not intended to be subclassed by clients. + * @noextend This class is not intended to be sub-classed by clients. * @noinstantiate This class is not intended to be instantiated by clients. * * @since 3.5 @@ -55,7 +55,7 @@ public class BreakpointImportParticipantDelegate { * a problem loading the delegate * * @return the {@link IBreakpointImportParticipant} or <code>null</code> - * @throws CoreException + * @throws CoreException if a problem is encountered */ public IBreakpointImportParticipant getDelegate() throws CoreException { if(fParticipant == null) { @@ -68,7 +68,7 @@ public class BreakpointImportParticipantDelegate { * Returns the marker type this participant is registered for. * * @return the marker type this participant is registered for - * @throws CoreException + * @throws CoreException if a problem is encountered */ public String getType() throws CoreException { return fElement.getAttribute(IConfigurationElementConstants.TYPE); diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java index c7f12a82f..4275ff851 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/BreakpointManager.java @@ -21,20 +21,6 @@ import java.util.Map; import java.util.Set; import java.util.Vector; -import com.ibm.icu.text.MessageFormat; - -import org.eclipse.core.runtime.CoreException; -import org.eclipse.core.runtime.IConfigurationElement; -import org.eclipse.core.runtime.IExtensionPoint; -import org.eclipse.core.runtime.IProgressMonitor; -import org.eclipse.core.runtime.ISafeRunnable; -import org.eclipse.core.runtime.IStatus; -import org.eclipse.core.runtime.ListenerList; -import org.eclipse.core.runtime.Platform; -import org.eclipse.core.runtime.SafeRunner; -import org.eclipse.core.runtime.Status; -import org.eclipse.core.runtime.jobs.Job; - import org.eclipse.core.resources.IMarker; import org.eclipse.core.resources.IMarkerDelta; import org.eclipse.core.resources.IProject; @@ -46,7 +32,17 @@ import org.eclipse.core.resources.IResourceDeltaVisitor; import org.eclipse.core.resources.IWorkspace; import org.eclipse.core.resources.IWorkspaceRunnable; import org.eclipse.core.resources.ResourcesPlugin; - +import org.eclipse.core.runtime.CoreException; +import org.eclipse.core.runtime.IConfigurationElement; +import org.eclipse.core.runtime.IExtensionPoint; +import org.eclipse.core.runtime.IProgressMonitor; +import org.eclipse.core.runtime.ISafeRunnable; +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.ListenerList; +import org.eclipse.core.runtime.Platform; +import org.eclipse.core.runtime.SafeRunner; +import org.eclipse.core.runtime.Status; +import org.eclipse.core.runtime.jobs.Job; import org.eclipse.debug.core.DebugException; import org.eclipse.debug.core.DebugPlugin; import org.eclipse.debug.core.IBreakpointListener; @@ -56,6 +52,8 @@ import org.eclipse.debug.core.IBreakpointsListener; import org.eclipse.debug.core.model.IBreakpoint; import org.eclipse.debug.core.model.IBreakpointImportParticipant; +import com.ibm.icu.text.MessageFormat; + /** * The breakpoint manager manages all registered breakpoints * for the debug plug-in. It is instantiated by the debug plug-in at startup. @@ -79,7 +77,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * Map of breakpoint import participants. * Map has the form: - * <pre>Map(String - markerid, List of {@link IBreakpointImportParticipantDelegate})</pre> + * <pre>Map(String - marker_id, List of {@link IBreakpointImportParticipant})</pre> */ private HashMap fImportParticipants = null; @@ -253,6 +251,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis * * @param resource the resource which contains the breakpoints * @param notify whether to notify of the breakpoint additions + * @throws CoreException if a problem is encountered */ private void loadBreakpoints(IResource resource, boolean notify) throws CoreException { initBreakpointExtensions(); @@ -287,6 +286,9 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis * does this for us (at shutdown, transient markers are not saved). However, * the code is still present to delete non-persisted markers from old * workspaces. + * @param resource the {@link IResource} to get markers for + * @return the complete listing of persisted markers for the given {@link IResource} + * @throws CoreException if a problem is encountered */ protected IMarker[] getPersistedMarkers(IResource resource) throws CoreException { IMarker[] markers= resource.findMarkers(IBreakpoint.BREAKPOINT_MARKER, true, IResource.DEPTH_INFINITE); @@ -363,6 +365,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * Convenience method to get the workspace + * @return the default {@link IWorkspace} */ private IWorkspace getWorkspace() { return ResourcesPlugin.getWorkspace(); @@ -394,6 +397,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis * The BreakpointManager waits to load the breakpoints * of the workspace until a request is made to retrieve the * breakpoints. + * @return the underlying {@link Vector} of breakpoints */ private synchronized Vector getBreakpoints0() { if (fBreakpoints == null) { @@ -556,8 +560,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis * * @param breakpoints the breakpoints to register * @param notify whether to notify listeners of the add - * @param loading whether the given breakpoints are being automatically loaded - * from previously persisted markers + * @throws CoreException if a problem is encountered */ private void addBreakpoints(IBreakpoint[] breakpoints, boolean notify) throws CoreException { List added = new ArrayList(breakpoints.length); @@ -607,7 +610,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis * Returns whether change notification is to be suppressed for the given breakpoint. * Used when adding breakpoints and changing the "REGISTERED" attribute. * - * @param breakpoint + * @param breakpoint the breakpoint * @return boolean whether change notification is suppressed */ protected boolean isChangeSuppressed(IBreakpoint breakpoint) { @@ -628,6 +631,8 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * Verifies that the breakpoint marker has the minimal required attributes, * and throws a debug exception if not. + * @param breakpoint the {@link IBreakpoint} to verify + * @throws DebugException if a problem is encountered */ private void verifyBreakpoint(IBreakpoint breakpoint) throws DebugException { try { @@ -783,6 +788,9 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * Wrapper for handling adds + * @param rDelta the {@link IResourceDelta} + * @param marker the new {@link IMarker} + * @param mDelta the accompanying {@link IMarkerDelta} */ protected void handleAddBreakpoint(IResourceDelta rDelta, IMarker marker, IMarkerDelta mDelta) { if (0 != (rDelta.getFlags() & IResourceDelta.MOVED_FROM)) { @@ -812,6 +820,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * Wrapper for handling removes + * @param marker the {@link IMarker} */ protected void handleRemoveBreakpoint(IMarker marker) { synchronized (fPostChangMarkersChanged) { @@ -826,6 +835,8 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * Wrapper for handling changes + * @param marker the {@link IMarker} that was changed + * @param delta the {@link IMarkerDelta} */ protected void handleChangeBreakpoint(IMarker marker, IMarkerDelta delta) { IBreakpoint breakpoint= getBreakpoint(marker); @@ -838,6 +849,7 @@ public class BreakpointManager implements IBreakpointManager, IResourceChangeLis /** * A project has been opened or closed. Updates the breakpoints for * that project + * @param project the {@link IProject} that was changed */ private void handleProjectResourceOpenStateChange(final IResource project) { if (!project.isAccessible()) { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java index 5b0360c12..0fc30b27a 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/ExpressionManager.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -481,7 +481,6 @@ public class ExpressionManager extends PlatformObject implements IExpressionMana * expressions to store this change as indicated * * @param expression the changed expression - * @param persist whether to persist the expressions */ protected void watchExpressionChanged(IWatchExpression expression) { boolean notify = false; diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java index 11344dde6..7970718ab 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfiguration.java @@ -176,7 +176,7 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig /** * Given a name that ends with .launch, return the simple name of the configuration. * - * @param fileName + * @param fileName the name to parse * @return simple name * @since 3.5 */ @@ -328,8 +328,8 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig /** * Returns whether the given objects are equal or both <code>null</code>. * - * @param o1 - * @param o2 + * @param o1 the object + * @param o2 the object to be compared to o1 * @return whether the given objects are equal or both <code>null</code> * @since 3.5 */ @@ -485,7 +485,7 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig * is in a project that is closed or does not exist, <code>null</code> is returned. * * @return file store this configuration is persisted in or <code>null</code> - * @throws CoreException + * @throws CoreException if a problem is encountered * @since 3.5 */ public IFileStore getFileStore() throws CoreException { @@ -645,6 +645,7 @@ public class LaunchConfiguration extends PlatformObject implements ILaunchConfig * by this configuration. * * @param launch the launch on which to set the source locator + * @throws CoreException if a problem is encountered */ protected void initializeSourceLocator(ILaunch launch) throws CoreException { if (launch.getSourceLocator() == null) { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java index 810ffeb31..3b2751197 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationComparator.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 @@ -38,7 +38,9 @@ public class LaunchConfigurationComparator implements Comparator { } /** - * Returns the resolver delegate (and creates if required) + * Returns the {@link Comparator} delegate + * + * @return the {@link Comparator} */ protected Comparator getComparator() { if (fDelegate == null) { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java index 0b9cde3f6..e62171c5f 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationInfo.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -117,7 +117,7 @@ public class LaunchConfigurationInfo { /** * Sets the attributes in this info to those in the given map. * - * @param map + * @param map the {@link Map} of attributes to set */ protected void setAttributes(Map map) { if (map == null) { @@ -130,6 +130,8 @@ public class LaunchConfigurationInfo { /** * Returns the <code>String</code> attribute with the given key or the * given default value if undefined. + * @param key the attribute name + * @param defaultValue the value to be returned if the given key does not exist in the attribute table * * @return attribute specified by given key or the defaultValue if undefined * @throws CoreException @@ -155,6 +157,8 @@ public class LaunchConfigurationInfo { /** * Returns the <code>int</code> attribute with the given key or the given * default value if undefined. + * @param key the name of the attribute + * @param defaultValue the default value to return if the key does not appear in the attribute table * * @return attribute specified by given key or the defaultValue if undefined * @throws CoreException @@ -180,6 +184,8 @@ public class LaunchConfigurationInfo { /** * Returns the <code>boolean</code> attribute with the given key or the * given default value if undefined. + * @param key the name of the attribute + * @param defaultValue the default value to return if the key does not appear in the attribute table * * @return attribute specified by given key or the defaultValue if undefined * @throws CoreException @@ -205,6 +211,8 @@ public class LaunchConfigurationInfo { /** * Returns the <code>java.util.List</code> attribute with the given key or * the given default value if undefined. + * @param key the name of the attribute + * @param defaultValue the default value to return if the key does not appear in the attribute table * * @return attribute specified by given key or the defaultValue if undefined * @throws CoreException @@ -230,6 +238,8 @@ public class LaunchConfigurationInfo { /** * Returns the <code>java.util.Set</code> attribute with the given key or * the given default value if undefined. + * @param key the name of the attribute + * @param defaultValue the default value to return if the key does not xist in the attribute table * * @return attribute specified by given key or the defaultValue if undefined * @throws CoreException @@ -257,6 +267,8 @@ public class LaunchConfigurationInfo { /** * Returns the <code>java.util.Map</code> attribute with the given key or * the given default value if undefined. + * @param key the name of the attribute + * @param defaultValue the default value to return if the key does not exist in the attribute table * * @return attribute specified by given key or the defaultValue if undefined * @throws CoreException @@ -400,6 +412,11 @@ public class LaunchConfigurationInfo { /** * Helper method that creates a 'key value' element of the specified type * with the specified attribute values. + * @param doc the {@link Document} + * @param elementType the {@link Element} type to create + * @param key the {@link Element} key + * @param value the {@link Element} value + * @return the new {@link Element} */ protected Element createKeyValueElement(Document doc, String elementType, String key, String value) { Element element = doc.createElement(elementType); @@ -414,7 +431,7 @@ public class LaunchConfigurationInfo { * * @param doc the doc to add the element to * @param elementType the type of the element - * @param setKey the key for the element + * @param listKey the key for the element * @param list the list to fill the new element with * @return the new element */ @@ -464,7 +481,7 @@ public class LaunchConfigurationInfo { * * @param doc the doc to add the element to * @param elementType the type of the element - * @param setKey the key for the element + * @param mapKey the key for the element * @param map the map to fill the new element with * @return the new element * @@ -490,7 +507,7 @@ public class LaunchConfigurationInfo { /** * Initializes the mapping of attributes from the XML file * @param root the root node from the XML document - * @throws CoreException + * @throws CoreException if a problem is encountered */ protected void initializeFromXML(Element root) throws CoreException { if (!root.getNodeName().equalsIgnoreCase(LAUNCH_CONFIGURATION)) { @@ -544,7 +561,7 @@ public class LaunchConfigurationInfo { /** * Loads a <code>String</code> from the specified element into the local attribute mapping * @param element the element to load from - * @throws CoreException + * @throws CoreException if a problem is encountered */ protected void setStringAttribute(Element element) throws CoreException { setAttribute(getKeyAttribute(element), getValueAttribute(element)); @@ -553,7 +570,7 @@ public class LaunchConfigurationInfo { /** * Loads an <code>Integer</code> from the specified element into the local attribute mapping * @param element the element to load from - * @throws CoreException + * @throws CoreException if a problem is encountered */ protected void setIntegerAttribute(Element element) throws CoreException { setAttribute(getKeyAttribute(element), new Integer(getValueAttribute(element))); @@ -562,7 +579,7 @@ public class LaunchConfigurationInfo { /** * Loads a <code>Boolean</code> from the specified element into the local attribute mapping * @param element the element to load from - * @throws CoreException + * @throws CoreException if a problem is encountered */ protected void setBooleanAttribute(Element element) throws CoreException { setAttribute(getKeyAttribute(element), Boolean.valueOf(getValueAttribute(element))); @@ -655,7 +672,7 @@ public class LaunchConfigurationInfo { * Returns the <code>String</code> representation of the 'key' attribute from the specified element * @param element the element to read from * @return the value - * @throws CoreException + * @throws CoreException if a problem is encountered */ protected String getKeyAttribute(Element element) throws CoreException { String key = element.getAttribute(KEY); @@ -669,7 +686,7 @@ public class LaunchConfigurationInfo { * Returns the <code>String</code> representation of the 'value' attribute from the specified element * @param element the element to read from * @return the value - * @throws CoreException + * @throws CoreException if a problem is encountered */ protected String getValueAttribute(Element element) throws CoreException { String value = element.getAttribute(VALUE); @@ -773,7 +790,7 @@ public class LaunchConfigurationInfo { /** * Returns if the attribute map contains the specified key - * @param attributeName + * @param attributeName the name of the attribute to check for * @return true if the attribute map contains the specified key, false otherwise * * @since 3.4.0 @@ -786,7 +803,7 @@ public class LaunchConfigurationInfo { * Removes the specified attribute from the mapping and returns * its value, or <code>null</code> if none. Does nothing * if the attribute name is <code>null</code> - * @param attributeName + * @param attributeName the name of the attribute to remove * @return attribute value or <code>null</code> * * @since 3.4.0 diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java index f3d3a555f..39890ae86 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationType.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -401,7 +401,7 @@ public class LaunchConfigurationType extends PlatformObject implements ILaunchCo * if we initialize the delegate and it has not been provided, return false instead of failing * @param candidate the candidate to inspect for migration suitability * @return true if the specified launch configuration is suitable for migration, false otherwise - * @throws CoreException + * @throws CoreException if a problem is encountered * * @since 3.2 */ @@ -415,7 +415,7 @@ public class LaunchConfigurationType extends PlatformObject implements ILaunchCo /** * This method initializes the migration delegate - * @throws CoreException + * @throws CoreException if a problem is encountered */ private synchronized void initializeMigrationDelegate() throws CoreException { if(fElement.getAttribute(IConfigurationElementConstants.MIGRATION_DELEGATE) != null && fMigrationDelegate == null) { @@ -440,7 +440,7 @@ public class LaunchConfigurationType extends PlatformObject implements ILaunchCo * Migrates the specified launch configuration by loading its delegate. * In the event the migration delegate has not been provided do nothing. * @param candidate the candidate launch configuration to migrate - * @throws CoreException + * @throws CoreException if a problem is encountered * * @since 3.2 */ diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java index fb2820235..da3db4b35 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchConfigurationWorkingCopy.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -173,9 +173,9 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen /** * Saves with progress. * - * @param monitor + * @param monitor the {@link IProgressMonitor} * @return the saved <code>ILaunchConfiguration</code> - * @throws CoreException + * @throws CoreException if a problem is encountered * * @since 3.3 */ @@ -228,7 +228,8 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen /** * Performs the actual saving of the launch configuration. - * @throws CoreException + * @param monitor the {@link IProgressMonitor} + * @throws CoreException if a problem is encountered */ private void doSave0(IProgressMonitor monitor) throws CoreException { SubMonitor lmonitor = SubMonitor.convert(monitor, MessageFormat.format(DebugCoreMessages.LaunchConfigurationWorkingCopy_0, new String[] {getName()}), 2); @@ -259,6 +260,7 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen /** * Writes the new configuration information to a file. + * @param monitor the {@link IProgressMonitor} * * @exception CoreException if writing the file fails */ @@ -388,9 +390,9 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen /** * Updates the given monitor with the given tick count and polls for cancellation. If the monitor * is cancelled an {@link OperationCanceledException} is thrown - * @param monitor - * @param ticks - * @throws OperationCanceledException + * @param monitor the {@link IProgressMonitor} + * @param ticks the amount of work to advance the monitor + * @throws OperationCanceledException if the user cancels the operation */ private void updateMonitor(IProgressMonitor monitor, int ticks) throws OperationCanceledException { if(monitor != null) { @@ -642,6 +644,7 @@ public class LaunchConfigurationWorkingCopy extends LaunchConfiguration implemen /** * Returns whether change notification should be * suppressed + * @return if changes notification should be suppressed */ protected boolean suppressChangeNotification() { return fSuppressChange; diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java index 29174c1fc..37858a6c2 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchManager.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -741,6 +741,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * method preserves mixed-case keys using the variable names * recorded by the OS. * </p> + * @param cache the map * @since 3.1 */ private void cacheNativeEnvironment(Map cache) { @@ -892,6 +893,9 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe /** * Return an instance of DebugException containing the specified message and Throwable. + * @param message the message for the new {@link DebugException} + * @param throwable the underlying {@link Exception} + * @return the new {@link DebugException} */ protected DebugException createDebugException(String message, Throwable throwable) { return new DebugException( @@ -907,6 +911,13 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * the specified stream. Simply pass out any exceptions encountered so that * caller can deal with them. This is important since caller may need access to the * actual exception. + * + * @param stream the {@link InputStream} to read from + * @return the new {@link LaunchConfigurationInfo} + * @throws CoreException if a problem is encountered + * @throws ParserConfigurationException if the stream fails to parse + * @throws IOException if there is a problem handling the given stream or writing the new info file + * @throws SAXException if there is a SAX parse exception */ protected LaunchConfigurationInfo createInfoFromXML(InputStream stream) throws CoreException, ParserConfigurationException, @@ -926,8 +937,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * container (and sub-containers) * * @param container the container to search - * @exception CoreException an exception occurs traversing - * the container. * @return all launch configurations in the given container */ protected List findLaunchConfigurations(IContainer container) { @@ -1100,6 +1109,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * Return a sorted array of the names of all <code>ILaunchConfiguration</code>s in * the workspace. These are cached, and cache is cleared when a new config is added, * deleted or changed. + * @return the sorted array of {@link ILaunchConfiguration} names */ protected synchronized String[] getAllSortedConfigNames() { if (fSortedConfigNames == null) { @@ -1127,6 +1137,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe /** * Returns comparators, loading if required + * @return the complete map of {@link ILaunchConfiguration} {@link Comparator}s */ protected Map getComparators() { initializeComparators(); @@ -1139,7 +1150,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * * @param root XML document * @return list of launch configurations - * @exception IOException if an exception occurs reading the XML + * @throws CoreException if a problem is encountered */ protected List getConfigsFromXML(Element root) throws CoreException { DebugException invalidFormat = @@ -1305,6 +1316,8 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * Returns the info object for the specified launch configuration. * If the configuration exists, but is not yet in the cache, * an info object is built and added to the cache. + * @param config the {@link ILaunchConfiguration} to get the info object from + * @return the {@link LaunchConfigurationInfo} object from the given {@link ILaunchConfiguration} * * @exception CoreException if an exception occurs building * the info object @@ -1887,10 +1900,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe /** * Load comparator extensions. - * - * @exception CoreException if an exception occurs reading - * the extensions - * */ private synchronized void initializeLaunchModes() { if (fLaunchModes == null) { @@ -1934,9 +1943,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe /** * Register source locators. - * - * @exception CoreException if an exception occurs reading - * the extensions */ private synchronized void initializeSourceLocators() { if (fSourceLocators == null) { @@ -2010,6 +2016,8 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe /** * Returns whether the given String is composed solely of digits + * @param string the {@link String} to check + * @return <code>true</code> if the given {@link String} is a number <code>false</code> otherwise */ private boolean isNumber(String string) { int numChars= string.length(); @@ -2161,7 +2169,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * launch configurations from the cached index. * * @param project the project that has been closed - * @exception CoreException if writing the index fails */ protected void projectClosed(IProject project) { List configs = getLaunchConfigurations(project); @@ -2180,7 +2187,6 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * configs in the project to the index of all configs. * * @param project the project that has been opened - * @exception CoreException if reading the index fails */ protected void projectOpened(IProject project) { List configs = findLaunchConfigurations(project); @@ -2417,6 +2423,9 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe /** * Throws a debug exception with the given throwable that occurred * while processing the given configuration. + * @param config the {@link ILaunchConfiguration} causing the exception + * @param e the {@link Exception} to throw + * @throws DebugException the new {@link DebugException} wrapping the given {@link Exception} and {@link ILaunchConfiguration} * @since 3.5 */ private void throwException(LaunchConfiguration config, Throwable e) throws DebugException { @@ -2592,7 +2601,7 @@ public class LaunchManager extends PlatformObject implements ILaunchManager, IRe * * @param in the file to copy * @param out the file to be copied out to - * @throws IOException + * @throws IOException if the file read fails * @since 3.4.0 */ private void copyFile(File in, File out) throws IOException { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java index 48a25f627..d596460ca 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LaunchMode.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2007 IBM Corporation and others. + * Copyright (c) 2004, 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 @@ -50,6 +50,7 @@ public class LaunchMode implements ILaunchMode { /** * Verifies the given attribute exists + * @param name the attribute name to check * * @exception CoreException if attribute does not exist */ @@ -63,7 +64,7 @@ public class LaunchMode implements ILaunchMode { * This method is used to create a new internal error describing that the specified attribute * is missing * @param attrName the name of the attribute that is missing - * @throws CoreException + * @throws CoreException if a problem is encountered */ private void missingAttribute(String attrName) throws CoreException { throw new CoreException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, MessageFormat.format(DebugCoreMessages.LaunchMode_1,new String[]{attrName}), null)); diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java index 5c5c02931..abe87bd1c 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureManager.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2009 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 @@ -204,9 +204,9 @@ public class LogicalStructureManager { /** * - * @param types + * @param types the array of types * @param selected the type that is selected for the given combo or <code>null</code> - * if the user has deselected any structure for the given combo + * if the user has de-selected any structure for the given combo */ public void setEnabledType(ILogicalStructureType[] types, ILogicalStructureType selected) { String combo= getComboString(types); @@ -223,8 +223,8 @@ public class LogicalStructureManager { /** * Returns the string representing the given combination of logical * structure types. This string will be a series of comma-separated - * indeces representing the various types. If any of the given types - * don't have indeces associated with them, this method will create + * indices representing the various types. If any of the given types + * don't have indices associated with them, this method will create * the appropriate index. * @param types the logical structure types * @return the string representing the given combination of logical diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java index 6aea4bea8..b478b3107 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureProvider.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 @@ -60,6 +60,7 @@ public class LogicalStructureProvider { /** * Return the ILogicalStructureProvider for this extension. + * @return the {@link ILogicalStructureProvider} */ protected ILogicalStructureProvider getDelegate() { if (fDelegate == null) { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java index 95633f5a6..029a15c85 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/LogicalStructureType.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 @@ -60,6 +60,7 @@ public class LogicalStructureType implements ILogicalStructureType { /** * Verifies the given attribute exists + * @param name the name to verify * * @exception CoreException if attribute does not exist */ @@ -72,7 +73,7 @@ public class LogicalStructureType implements ILogicalStructureType { /** * Throws a new <code>CoreException</code> about the specified attribute being missing * @param attrName the name of the missing attribute - * @throws CoreException + * @throws CoreException if a problem is encountered */ private void missingAttribute(String attrName) throws CoreException { throw new CoreException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.ERROR, MessageFormat.format(DebugCoreMessages.LogicalStructureType_1, new String[]{attrName}), null)); diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java index 25a381d84..a42f94845 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/MemoryBlockManager.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2004, 2007 IBM Corporation and others. + * Copyright (c) 2004, 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 @@ -250,8 +250,8 @@ public class MemoryBlockManager implements IMemoryBlockManager, IDebugEventSetLi /** * Notifies the listeners about the given memory blocks and the event to be sent - * @param memBlocks - * @param event + * @param memBlocks the array of memory blocks + * @param event the event to notify to the blocks */ private void notifyListeners(IMemoryBlock[] memBlocks, int event) { getMemoryBlockNotifier().notify(memBlocks, event); @@ -268,7 +268,7 @@ public class MemoryBlockManager implements IMemoryBlockManager, IDebugEventSetLi /** * Handles a debug event - * @param event + * @param event the {@link DebugEvent} */ public void handleDebugEvent(DebugEvent event) { Object obj = event.getSource(); diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java index c5fa6dae0..7dd37305c 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/OutputStreamMonitor.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 @@ -111,6 +111,7 @@ public class OutputStreamMonitor implements IFlushableStreamMonitor { /** * Notifies the listeners that text has * been appended to the stream. + * @param text the text that was appended to the stream */ private void fireStreamAppended(String text) { getNotifier().notifyAppend(text); diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java index 5fc5fd99b..e79766c83 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/Preferences.java @@ -42,10 +42,10 @@ public final class Preferences { /** * Sets a string preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to set the value in */ public static synchronized void setString(String qualifier, String key, String value, IScopeContext context) { if(context != null) { @@ -66,10 +66,10 @@ public final class Preferences { /** * Sets a boolean preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to set the value in */ public static synchronized void setBoolean(String qualifier, String key, boolean value, IScopeContext context) { if(context != null) { @@ -90,10 +90,10 @@ public final class Preferences { /** * Sets a integer preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to set the value in */ public static synchronized void setInt(String qualifier, String key, int value, IScopeContext context) { if(context != null) { @@ -114,10 +114,10 @@ public final class Preferences { /** * Sets a long preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to set the value in */ public static synchronized void setLong(String qualifier, String key, long value, IScopeContext context) { if(context != null) { @@ -138,10 +138,10 @@ public final class Preferences { /** * Sets a byte array preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to set the value in */ public static synchronized void setByteArray(String qualifier, String key, byte[] value, IScopeContext context) { if(context != null) { @@ -162,10 +162,10 @@ public final class Preferences { /** * Sets a double preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to set the value in */ public static synchronized void setDouble(String qualifier, String key, double value, IScopeContext context) { if(context != null) { @@ -186,10 +186,10 @@ public final class Preferences { /** * Sets a float preference in the {@link InstanceScope} or the given {@link IScopeContext} if it * is not <code>null</code>. Preferences set in a given context are flushed as they are set. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the value - * @param context + * @param context the context to setthe value in */ public static synchronized void setFloat(String qualifier, String key, float value, IScopeContext context) { if(context != null) { @@ -209,7 +209,7 @@ public final class Preferences { /** * Sets a string in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -219,7 +219,7 @@ public final class Preferences { /** * Sets a boolean in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -229,7 +229,7 @@ public final class Preferences { /** * Sets a byte array in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -239,7 +239,7 @@ public final class Preferences { /** * Sets a double in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -249,7 +249,7 @@ public final class Preferences { /** * Sets a float in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -259,7 +259,7 @@ public final class Preferences { /** * Sets a integer in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -269,7 +269,7 @@ public final class Preferences { /** * Sets a long in the {@link DefaultScope} - * @param qualifier + * @param qualifier the preference qualifier * @param key the key * @param value the new value */ @@ -280,7 +280,7 @@ public final class Preferences { /** * Sets the given preference to its default value. This is done by removing any set value * from the {@link InstanceScope}. Has no effect if the given key is <code>null</code>. - * @param qualifier + * @param qualifier the preference qualifier * @param key the key for the preference */ public static synchronized void setToDefault(String qualifier, String key) { @@ -292,9 +292,9 @@ public final class Preferences { /** * Returns the default boolean value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the boolean value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -305,9 +305,9 @@ public final class Preferences { /** * Returns the default string value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the string value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -318,9 +318,9 @@ public final class Preferences { /** * Returns the default byte array value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the byte array value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -331,9 +331,9 @@ public final class Preferences { /** * Returns the default integer value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the integer value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -344,9 +344,9 @@ public final class Preferences { /** * Returns the default long value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the long value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -357,9 +357,9 @@ public final class Preferences { /** * Returns the default double value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the double value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -370,9 +370,9 @@ public final class Preferences { /** * Returns the default float value stored in the {@link DefaultScope} for the given key * or the specified default value if the key does not appear in the {@link DefaultScope} - * @param qualifier - * @param key - * @param defaultvalue + * @param qualifier the preference qualifier + * @param key the preference key + * @param defaultvalue the default value * * @return the float value set in the {@link DefaultScope} for the given key, or the specified default value. */ @@ -381,9 +381,9 @@ public final class Preferences { } /** - * Save the preferences for the given plugin identifier. + * Save the preferences for the given plug-in identifier. * It should be noted that all pending preference changes will be flushed with this method. - * @param qualifier + * @param qualifier the preference qualifier */ public static synchronized void savePreferences(String qualifier) { try { @@ -397,8 +397,8 @@ public final class Preferences { /** * Adds the given preference listener to the {@link DefaultScope} and the {@link InstanceScope} - * @param qualifier - * @param listener + * @param qualifier the preference qualifier + * @param listener the listener to register */ public static void addPreferenceListener(String qualifier, IEclipsePreferences.IPreferenceChangeListener listener) { contexts[DEFAULT_CONTEXT].getNode(qualifier).addPreferenceChangeListener(listener); @@ -407,8 +407,8 @@ public final class Preferences { /** * Removes the given preference listener from the {@link DefaultScope} and the {@link InstanceScope} - * @param qualifier - * @param listener + * @param qualifier the preference qualifier + * @param listener the listener to register */ public static void removePreferenceListener(String qualifier, IEclipsePreferences.IPreferenceChangeListener listener) { contexts[DEFAULT_CONTEXT].getNode(qualifier).removePreferenceChangeListener(listener); diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java index 8be2ba3b4..82fa104b4 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/WatchExpression.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -136,7 +136,7 @@ public class WatchExpression implements IWatchExpression { /** * Fires the given debug event - * @param event + * @param event the {@link DebugEvent} */ protected void fireEvent(DebugEvent event) { DebugPlugin.getDefault().fireDebugEventSet(new DebugEvent[] {event}); @@ -146,8 +146,6 @@ public class WatchExpression implements IWatchExpression { * Notifies the expression manager that this watch expression's * values have changed so the manager can update the * persisted expression. - * - * @param persist whether to persist the expression */ private void watchExpressionChanged() { ((ExpressionManager)DebugPlugin.getDefault().getExpressionManager()).watchExpressionChanged(this); @@ -229,7 +227,9 @@ public class WatchExpression implements IWatchExpression { } /** - * @param enabled + * Set the enabled state of the {@link WatchExpression} + * + * @param enabled the new enabled state */ public void setEnabled(boolean enabled) { fEnabled= enabled; @@ -238,7 +238,8 @@ public class WatchExpression implements IWatchExpression { } /** - * @param expression + * Set the text of the expression + * @param expression the new expression text */ public void setExpressionText(String expression) { fExpressionText= expression; diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java index 65081fd3a..f8c67a243 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/XMLMemento.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2010 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 @@ -355,6 +355,7 @@ public final class XMLMemento { /** * Places the element's attributes into the document. + * @param element1 the element * @param copyText true if the first text node should be copied */ private void putElement(Element element1, boolean copyText) { @@ -416,8 +417,8 @@ public final class XMLMemento { } /** - * @param key - * @param value + * @param key the attribute key + * @param value the boolean value for the key * @since 3.4 */ public void putBoolean(String key, boolean value) { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java index 935d11532..7bd6f4331 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourceContainerType.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 @@ -75,7 +75,7 @@ public class SourceContainerType implements ISourceContainerType { /** * Lazily instantiates and returns the underlying source container type. - * + * @return the {@link ISourceContainerTypeDelegate} * @exception CoreException if unable to instantiate */ private ISourceContainerTypeDelegate getDelegate() throws CoreException { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java index 21bc87d27..fa06e2aaf 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/sourcelookup/SourcePathComputer.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 @@ -51,7 +51,7 @@ public class SourcePathComputer implements ISourcePathComputer { /** * Lazily instantiates and returns the underlying source container type. - * + * @return the {@link ISourcePathComputerDelegate} * @exception CoreException if unable to instantiate */ private ISourcePathComputerDelegate getDelegate() throws CoreException { diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java index 91c9bc45b..710df3595 100644 --- a/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java +++ b/org.eclipse.debug.core/core/org/eclipse/debug/internal/core/variables/ResourceResolver.java @@ -105,7 +105,7 @@ public class ResourceResolver implements IDynamicVariableResolver { * * @param message exception message * @param exception underlying exception or <code>null</code> - * @throws CoreException + * @throws CoreException if a problem occurs */ protected void abort(String message, Throwable exception) throws CoreException { throw new CoreException(new Status(IStatus.ERROR, DebugPlugin.getUniqueIdentifier(), DebugPlugin.INTERNAL_ERROR, message, exception)); |