Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-15 22:16:07 +0000
committerAlexander Kurtakov2019-02-15 22:23:41 +0000
commit94821aeec18c0ff4103819e6f5323838b8670bc9 (patch)
treee5055db8d889bc1adee1ce83c190bff80934f265 /org.eclipse.debug.core/core/org
parenta674c6df5225f33908b78dd288e8439e37df4aa9 (diff)
downloadeclipse.platform.debug-94821aeec18c0ff4103819e6f5323838b8670bc9.tar.gz
eclipse.platform.debug-94821aeec18c0ff4103819e6f5323838b8670bc9.tar.xz
eclipse.platform.debug-94821aeec18c0ff4103819e6f5323838b8670bc9.zip
Bug 543933 - Build javadocs with Java 11I20190216-0600I20190215-1800
Fix javadoc warnings catched by Java 11 tool with XDoclint:html. Change-Id: I22598ce741b2ced850e6642575460534d7ba6309 Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'org.eclipse.debug.core/core/org')
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java2
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java41
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java29
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationWorkingCopy.java12
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegister.java10
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegisterGroup.java30
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IThread.java30
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IValue.java39
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IVariable.java43
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IWatchExpression.java11
10 files changed, 144 insertions, 103 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java
index 8f99d3937..4228c4f93 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java
@@ -323,7 +323,7 @@ public interface IBreakpointManager {
* Returns whether a workspace has active TriggerPoints
*
* @return return <code>true</code> if a breakpoint has active triggers and
- * cannot suspend and return <code>false> otherwise.
+ * cannot suspend and return <code>false</code> otherwise.
* @since 3.11
*/
boolean hasActiveTriggerPoints();
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java
index 6c850fc68..858a0bec1 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java
@@ -55,7 +55,7 @@ import org.eclipse.core.runtime.IProgressMonitor;
* Clients that define a launch configuration delegate extension implement the
* <code>ILaunchConfigurationDelegate</code> interface.
* </p>
- *
+ *
* @see ILaunchConfigurationType
* @see org.eclipse.debug.core.model.ILaunchConfigurationDelegate
* @see ILaunchConfigurationWorkingCopy
@@ -510,25 +510,34 @@ public interface ILaunchConfiguration extends IAdaptable {
boolean isWorkingCopy();
/**
- * Launches this configuration in the specified mode by delegating to
- * this configuration's launch configuration delegate, and returns the
- * resulting launch.
+ * Launches this configuration in the specified mode by delegating to this
+ * configuration's launch configuration delegate, and returns the resulting
+ * launch.
* <p>
- * Equivalent to calling <code>launch(String, IProgressMontitor, boolean)</code>
- * with a <code>build</code> flag of <code>false</code>.
+ * Equivalent to calling
+ * <code>launch(String, IProgressMontitor, boolean)</code> with a
+ * <code>build</code> flag of <code>false</code>.
* </p>
+ *
* @param mode the mode in which to launch, one of the mode constants
- * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code> or <code>DEBUG_MODE</code>.
- * @param monitor progress monitor, or <code>null</code>. A cancelable progress monitor is provided by the Job
- * framework. It should be noted that the setCanceled(boolean) method should never be called on the provided
- * monitor or the monitor passed to any delegates from this method; due to a limitation in the progress monitor
- * framework using the setCanceled method can cause entire workspace batch jobs to be canceled, as the canceled flag
- * is propagated up the top-level parent monitor. The provided monitor is not guaranteed to have been started.
+ * defined by <code>ILaunchManager</code> - <code>RUN_MODE</code>
+ * or <code>DEBUG_MODE</code>.
+ * @param monitor progress monitor, or <code>null</code>. A cancelable
+ * progress monitor is provided by the Job framework. It should
+ * be noted that the setCanceled(boolean) method should never be
+ * called on the provided monitor or the monitor passed to any
+ * delegates from this method; due to a limitation in the
+ * progress monitor framework using the setCanceled method can
+ * cause entire workspace batch jobs to be canceled, as the
+ * canceled flag is propagated up the top-level parent monitor.
+ * The provided monitor is not guaranteed to have been started.
* @return the resulting launch
- * @exception CoreException if this method fails. Reasons include:<ul>
- * <li>unable to instantiate the underlying launch configuration delegate</li>
- * <li>the launch fails (in the delegate)</code>
- * </ul>
+ * @exception CoreException if this method fails. Reasons include:
+ * <ul>
+ * <li>unable to instantiate the underlying launch
+ * configuration delegate</li>
+ * <li>the launch fails (in the delegate)</li>
+ * </ul>
*/
ILaunch launch(String mode, IProgressMonitor monitor) throws CoreException;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java
index 2b0070e4b..f28c69f25 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java
@@ -281,24 +281,25 @@ public interface ILaunchConfigurationType extends IAdaptable {
boolean isPublic();
/**
- * Returns a new launch configuration working copy of this type,
- * that resides in the specified container, with the given name.
- * When <code>container</code> is </code>null</code>, the configuration
- * will reside locally in the metadata area.
- * Note: a launch configuration is not actually created until the working copy is saved.
+ * Returns a new launch configuration working copy of this type, that
+ * resides in the specified container, with the given name. When
+ * <code>container</code> is <code>null</code>, the configuration will
+ * reside locally in the metadata area. Note: a launch configuration is not
+ * actually created until the working copy is saved.
* <p>
- * The configuration <code>name</code> parameter cannot contain file separator characters
- * (sub directories) when the <code>container</code> is <code>null</code> (i.e. when the
- * configuration is to be stored in the local metadata area.
+ * The configuration <code>name</code> parameter cannot contain file
+ * separator characters (sub directories) when the <code>container</code> is
+ * <code>null</code> (i.e. when the configuration is to be stored in the
+ * local metadata area.
* </p>
+ *
* @param container the container in which the new configuration will
- * reside, or <code>null</code> if the configuration should reside
- * locally with the metadata.
+ * reside, or <code>null</code> if the configuration should
+ * reside locally with the metadata.
* @param name name for the launch configuration
* @return a new launch configuration working copy instance of this type
- * @exception CoreException if an instance of this type
- * of launch configuration could not be created for any
- * reason
+ * @exception CoreException if an instance of this type of launch
+ * configuration could not be created for any reason
*/
ILaunchConfigurationWorkingCopy newInstance(IContainer container, String name) throws CoreException;
@@ -335,7 +336,7 @@ public interface ILaunchConfigurationType extends IAdaptable {
/**
* Returns a new launch configuration working copy of this type, that
* resides in the specified container, with the given name. When
- * <code>container</code> is </code>null</code>, the configuration will
+ * <code>container</code> is <code>null</code>, the configuration will
* reside locally in the metadata area. Note: a launch configuration is not
* actually created until the working copy is saved.
* <p>
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationWorkingCopy.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationWorkingCopy.java
index 00aa646d3..ef5e72c1e 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationWorkingCopy.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationWorkingCopy.java
@@ -297,12 +297,14 @@ public interface ILaunchConfigurationWorkingCopy extends ILaunchConfiguration, I
/**
* Removes the specified attribute from the this configuration and returns
- * the previous value associated with the specified attribute name, or <tt>null</tt>
- * if there was no mapping for the attribute. Note that for int's and booleans,
- * corresponding Integer and Boolean objects are returned.
+ * the previous value associated with the specified attribute name, or
+ * <code>null</code> if there was no mapping for the attribute. Note that
+ * for int's and booleans, corresponding Integer and Boolean objects are
+ * returned.
* <p>
* This method allows non-object attributes to be removed.
* </p>
+ *
* @param attributeName the name of the attribute to remove
* @return previous value of the attribute or <code>null</code>
*
@@ -322,13 +324,13 @@ public interface ILaunchConfigurationWorkingCopy extends ILaunchConfiguration, I
/**
* Copies all attributes from the given prototype to this working.
* Overwrites any existing attributes with the same key.
- *
+ *
* @param prototype configuration prototype
* @exception CoreException if unable to retrieve attributes from the prototype
* @since 3.12
*/
void copyAttributes(ILaunchConfiguration prototype) throws CoreException;
-
+
/**
* Sets the prototype that this configuration is based on, possibly <code>null</code>,
* and optionally copies attributes from the prototype to this working copy.
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegister.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegister.java
index 6dbb2a0f8..469678552 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegister.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegister.java
@@ -31,10 +31,12 @@ public interface IRegister extends IVariable {
* Returns the register group this register is contained in.
*
* @return the register group this register is contained in
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the debug target. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the debug target. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
IRegisterGroup getRegisterGroup() throws DebugException;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegisterGroup.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegisterGroup.java
index 97c42d2ae..7d6ca3996 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegisterGroup.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IRegisterGroup.java
@@ -34,10 +34,12 @@ public interface IRegisterGroup extends IDebugElement {
* Returns the name of this register group.
*
* @return this register group's name
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the debug target. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the debug target. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
String getName() throws DebugException;
@@ -45,10 +47,12 @@ public interface IRegisterGroup extends IDebugElement {
* Returns the registers in this register group.
*
* @return the registers in this register group
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the debug target. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the debug target. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
IRegister[] getRegisters() throws DebugException;
@@ -56,10 +60,12 @@ public interface IRegisterGroup extends IDebugElement {
* Returns whether this register group currently contains any registers.
*
* @return whether this register group currently contains any registers
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the debug target. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the debug target. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
boolean hasRegisters() throws DebugException;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IThread.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IThread.java
index afe8e4a73..2e349e00e 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IThread.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IThread.java
@@ -77,26 +77,32 @@ public interface IThread extends IDebugElement, ISuspendResume, IStep, ITerminat
* the failure.</li>
*/
int getPriority() throws DebugException;
+
/**
- * Returns the top stack frame or <code>null</code> if there is
- * currently no top stack frame.
+ * Returns the top stack frame or <code>null</code> if there is currently no
+ * top stack frame.
*
* @return the top stack frame, or <code>null</code> if none
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
IStackFrame getTopStackFrame() throws DebugException;
+
/**
- * Returns the name of this thread. Name format is debug model
- * specific, and should be specified by a debug model.
+ * Returns the name of this thread. Name format is debug model specific, and
+ * should be specified by a debug model.
*
* @return this thread's name
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
String getName() throws DebugException;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IValue.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IValue.java
index d9816397b..c347fee52 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IValue.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IValue.java
@@ -43,14 +43,16 @@ import org.eclipse.debug.core.DebugException;
public interface IValue extends IDebugElement {
/**
- * Returns a description of the type of data this value contains
- * or references.
+ * Returns a description of the type of data this value contains or
+ * references.
*
* @return the name of this value's reference type
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
String getReferenceTypeName() throws DebugException;
@@ -58,24 +60,29 @@ public interface IValue extends IDebugElement {
* Returns this value as a <code>String</code>.
*
* @return a String representation of this value
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
String getValueString() throws DebugException;
/**
* Returns whether this value is currently allocated.
* <p>
- * For example, if this value represents
- * an object that has been garbage collected, <code>false</code> is returned.
+ * For example, if this value represents an object that has been garbage
+ * collected, <code>false</code> is returned.
* </p>
+ *
* @return whether this value is currently allocated
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
boolean isAllocated() throws DebugException;
/**
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IVariable.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IVariable.java
index 080ccb267..9b444f037 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IVariable.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IVariable.java
@@ -47,34 +47,41 @@ public interface IVariable extends IDebugElement, IValueModification {
* Returns the value of this variable.
*
* @return this variable's value
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
IValue getValue() throws DebugException;
+
/**
- * Returns the name of this variable. Name format is debug model
- * specific, and should be specified by a debug model.
+ * Returns the name of this variable. Name format is debug model specific,
+ * and should be specified by a debug model.
*
* @return this variable's name
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
String getName() throws DebugException;
+
/**
- * Returns a description of the type of data this variable is
- * declared to reference. Note that the declared type of a
- * variable and the concrete type of its value are not necessarily
- * the same.
+ * Returns a description of the type of data this variable is declared to
+ * reference. Note that the declared type of a variable and the concrete
+ * type of its value are not necessarily the same.
*
* @return the declared type of this variable
- * @exception DebugException if this method fails. Reasons include:
- * <ul><li>Failure communicating with the VM. The DebugException's
- * status code contains the underlying exception responsible for
- * the failure.</li>
+ * @exception DebugException if this method fails. Reasons include:
+ * <ul>
+ * <li>Failure communicating with the VM. The
+ * DebugException's status code contains the underlying
+ * exception responsible for the failure.</li>
+ * </ul>
*/
String getReferenceTypeName() throws DebugException;
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IWatchExpression.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IWatchExpression.java
index b1449beb9..7cca45079 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IWatchExpression.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IWatchExpression.java
@@ -42,23 +42,24 @@ public interface IWatchExpression extends IErrorReportingExpression {
* generally be asynchronous to avoid blocking the calling thread.
*/
void evaluate();
+
/**
* Sets the context for this watch expression, or <code>null</code> if none.
* If the given context is valid for this expression, this expression may
- * update its value. When the value update is complete, a debug change event is
- * fired. When <code>null</code> is specified as a context, this expression
- * may choose to retain its previous value.
+ * update its value. When the value update is complete, a debug change event
+ * is fired. When <code>null</code> is specified as a context, this
+ * expression may choose to retain its previous value.
* <p>
* The context is usually one of (but not limited to):
+ * </p>
* <ul>
* <li>a debug target (<code>IDebugTarget</code>)</li>
* <li>a thread (<code>IThread</code>)</li>
* <li>a stack frame (<code>IStackFrame</code>)</li>
* </ul>
- * </p>
*
* @param context context in which to update this expression's value, or
- * <code>null</code> if none
+ * <code>null</code> if none
*/
void setExpressionContext(IDebugElement context);
/**

Back to the top