Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-14 10:33:35 -0500
committerAlexander Kurtakov2019-02-14 10:45:48 -0500
commit62a4a631630ed77cfdd1e27333cafae0a7cbcf27 (patch)
tree07093d13fc2718ae6d7b9ed1ca9a392449c8377c /org.eclipse.debug.core/core/org
parent2341d0c7e25069e795fafd9d027acec7f99c8884 (diff)
downloadeclipse.platform.debug-62a4a631630ed77cfdd1e27333cafae0a7cbcf27.tar.gz
eclipse.platform.debug-62a4a631630ed77cfdd1e27333cafae0a7cbcf27.tar.xz
eclipse.platform.debug-62a4a631630ed77cfdd1e27333cafae0a7cbcf27.zip
Bug 543933 - Build javadocs with Java 11I20190215-0630I20190215-0055I20190214-1800
Fix javadoc warnings catched by Java 11 tool with XDoclint:html. Change-Id: I99061cad4e8a9e3eb18bfc97143fa893715a58f8 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/DebugEvent.java218
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManager.java5
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManagerListener.java2
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfiguration.java36
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchConfigurationType.java62
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchMode.java16
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureProvider.java16
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureType.java32
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IProcessFactory.java20
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java49
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IBreakpointImportParticipant.java20
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IPersistableSourceLocator.java25
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/model/IStepFilter.java7
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/package.html1
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourceContainerType.java19
-rw-r--r--org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourcePathComputer.java18
16 files changed, 295 insertions, 251 deletions
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugEvent.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugEvent.java
index d0eaefe5f..313d3218e 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugEvent.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/DebugEvent.java
@@ -19,124 +19,136 @@ import java.util.EventObject;
import org.eclipse.debug.internal.core.DebugCoreMessages;
/**
- * A debug event describes an event in a program being debugged or
- * in a running process. Debug models and process implementations
- * are required to generate debug events as specified by this class.
+ * A debug event describes an event in a program being debugged or in a running
+ * process. Debug models and process implementations are required to generate
+ * debug events as specified by this class.
* <p>
- * The following list defines the events generated for each debug
- * model element.
- * The <code>getSource()</code> method of a debug event
- * returns the element associated with the event.
- * Creation events are guaranteed to occur in a top
- * down order - that is, parents are created before children.
- * Termination events are guaranteed to occur in a bottom up order -
- * that is, children before parents. However, termination events are not guaranteed
- * for all elements that are created. That is, terminate events can be coalesced - a
- * terminate event for a parent signals that all children have been terminated.
+ * The following list defines the events generated for each debug model element.
+ * The <code>getSource()</code> method of a debug event returns the element
+ * associated with the event. Creation events are guaranteed to occur in a top
+ * down order - that is, parents are created before children. Termination events
+ * are guaranteed to occur in a bottom up order - that is, children before
+ * parents. However, termination events are not guaranteed for all elements that
+ * are created. That is, terminate events can be coalesced - a terminate event
+ * for a parent signals that all children have been terminated.
* </p>
* <p>
* A debug model may define model specific events by specifying a debug event
- * kind of <code>MODEL_SPECIFIC</code>. A model specific event is identified by the
- * event source (i.e. by the debug model that generated the event). The detail of
- * a model specific event is client defined. Note that model specific events are
- * not understood by the debug platform, and are thus ignored.
+ * kind of <code>MODEL_SPECIFIC</code>. A model specific event is identified by
+ * the event source (i.e. by the debug model that generated the event). The
+ * detail of a model specific event is client defined. Note that model specific
+ * events are not understood by the debug platform, and are thus ignored.
* </p>
* <p>
- * The generic <code>CHANGE</code> event can be fired at any time by any element.
- * Generally, a client of a debug model, such as as a UI, can get sufficient
- * information to update by listening/responding to the other event kinds. However,
- * if a debug model needs to inform clients of a change that is not specified
- * by create/terminate/suspend/resume, the <code>CHANGE</code> event may be used.
- * For example, generally, the only way a thread or any of its children can change
- * state between a suspend and resume operation, is if the thread or owning debug
- * target is terminated. However, if a debug model supports some other operation
- * that would allow a debug element to change state while suspended, the debug model
- * would fire a change event for that element. The valid detail codes for a
- * change event are:<ul>
- * <li><code>STATE</code> - indicates the state of an element has changed, but its
- * children are not affected. A client would use a state change event to update
- * a label of the affected element, but would not update any children.</li>
- * <li><code>CONTENT</code> - indicates that a debug element's value or contents have
- * changed in some way. For example, when the value of a variable is changed
- * explicitly, the variable should fire a content change event.</li>
- * </ul>
+ * The generic <code>CHANGE</code> event can be fired at any time by any
+ * element. Generally, a client of a debug model, such as as a UI, can get
+ * sufficient information to update by listening/responding to the other event
+ * kinds. However, if a debug model needs to inform clients of a change that is
+ * not specified by create/terminate/suspend/resume, the <code>CHANGE</code>
+ * event may be used. For example, generally, the only way a thread or any of
+ * its children can change state between a suspend and resume operation, is if
+ * the thread or owning debug target is terminated. However, if a debug model
+ * supports some other operation that would allow a debug element to change
+ * state while suspended, the debug model would fire a change event for that
+ * element. The valid detail codes for a change event are:
* </p>
* <ul>
+ * <li><code>STATE</code> - indicates the state of an element has changed, but
+ * its children are not affected. A client would use a state change event to
+ * update a label of the affected element, but would not update any
+ * children.</li>
+ * <li><code>CONTENT</code> - indicates that a debug element's value or contents
+ * have changed in some way. For example, when the value of a variable is
+ * changed explicitly, the variable should fire a content change event.</li>
+ * </ul>
+ *
+ * <ul>
* <li><code>IProcess</code>
- * <ul>
- * <li><code>CREATE</code> - a process has been created and is executing.</li>
- * <li><code>TERMINATE</code> - a process has terminated.</li>
- * </ul>
+ * <ul>
+ * <li><code>CREATE</code> - a process has been created and is executing.</li>
+ * <li><code>TERMINATE</code> - a process has terminated.</li>
+ * </ul>
* <li><code>IDebugTarget</code>
- * <ul>
- * <li><code>CREATE</code> - a debug target has been created and is ready
- * to begin a debug session.</li>
- * <li><code>TERMINATE</code> - a debug target has terminated and the debug
- * session has ended.</li>
- * <li><code>SUSPEND</code> - a debug target has suspended. Event detail provides
- * the reason for the suspension:<ul>
- * <li><code>STEP_END</code> - a request to step has completed</li>
- * <li><code>BREAKPOINT</code> - a breakpoint has been hit</li>
- * <li><code>CLIENT_REQUEST</code> - a client request has caused the target to suspend
- * (i.e. an explicit call to <code>suspend()</code>)</li>
- * <li><code>UNSPECIFIED</code> - the reason for the suspend is not specified</li>
- * </ul>
- * </li>
- * <li><code>RESUME</code> - a debug target has resumed. Event detail provides
- * the reason for the resume:<ul>
- * <li><code>STEP_INTO</code> - a target is being resumed because of a request to step into</li>
- * <li><code>STEP_OVER</code> - a target is being resumed because of a request to step over</li>
- * <li><code>STEP_RETURN</code> - a target is being resumed because of a request to step return</li>
- * <li><code>CLIENT_REQUEST</code> - a client request has caused the target to be resumed
- * (i.e. an explicit call to <code>resume()</code>)</li>
- * <li><code>UNSPECIFIED</code> - The reason for the resume is not specified</li>
- * </ul>
- * </li>
- * </ul>
+ * <ul>
+ * <li><code>CREATE</code> - a debug target has been created and is ready to
+ * begin a debug session.</li>
+ * <li><code>TERMINATE</code> - a debug target has terminated and the debug
+ * session has ended.</li>
+ * <li><code>SUSPEND</code> - a debug target has suspended. Event detail
+ * provides the reason for the suspension:
+ * <ul>
+ * <li><code>STEP_END</code> - a request to step has completed</li>
+ * <li><code>BREAKPOINT</code> - a breakpoint has been hit</li>
+ * <li><code>CLIENT_REQUEST</code> - a client request has caused the target to
+ * suspend (i.e. an explicit call to <code>suspend()</code>)</li>
+ * <li><code>UNSPECIFIED</code> - the reason for the suspend is not
+ * specified</li>
+ * </ul>
* </li>
- * <li><code>IThread</code>
- * <ul>
- * <li><code>CREATE</code> - a thread has been created in a debug target.</li>
- * <li><code>TERMINATE</code> - a thread has terminated.</li>
- * <li><code>SUSPEND</code> - a thread has suspended execution. Event detail provides
- * the reason for the suspension:<ul>
- * <li><code>STEP_END</code> - a request to step has completed</li>
- * <li><code>BREAKPOINT</code> - a breakpoint has been hit</li>
- * <li><code>CLIENT_REQUEST</code> - a client request has caused the thread to suspend
- * (i.e. an explicit call to <code>suspend()</code>)</li>
- * <li><code>EVALUATION</code> - an expression evaluation has ended that may
- * have had side effects in the debug target.</li>
- * <li><code>EVALUATION_IMPLICIT</code> - an expression evaluation has ended that
- * had no side effects in the debug target.</li>
- * <li><code>UNSPECIFIED</code> - the reason for the suspend is not specified</li>
- * </ul>
- * </li>
- * <li><code>RESUME</code> - a thread has resumed execution. Event detail provides
- * the reason for the resume:<ul>
- * <li><code>STEP_INTO</code> - a thread is being resumed because of a request to step into</li>
- * <li><code>STEP_OVER</code> - a thread is being resumed because of a request to step over</li>
- * <li><code>STEP_RETURN</code> - a thread is being resumed because of a request to step return</li>
- * <li><code>CLIENT_REQUEST</code> - a client request has caused the thread to be resumed
- * (i.e. an explicit call to <code>resume()</code>)</li>
- * <li><code>EVALUATION</code> - an expression evaluation has started that may
- * have side effects in the debug target.</li>
- * <li><code>EVALUATION_IMPLICIT</code> - an expression evaluation has started that
- * will have no side effects in the debug target.</li>
- * <li><code>UNSPECIFIED</code> - The reason for the resume is not specified</li>
- * </ul>
- * </li>
- * </ul>
+ * <li><code>RESUME</code> - a debug target has resumed. Event detail provides
+ * the reason for the resume:
+ * <ul>
+ * <li><code>STEP_INTO</code> - a target is being resumed because of a request
+ * to step into</li>
+ * <li><code>STEP_OVER</code> - a target is being resumed because of a request
+ * to step over</li>
+ * <li><code>STEP_RETURN</code> - a target is being resumed because of a request
+ * to step return</li>
+ * <li><code>CLIENT_REQUEST</code> - a client request has caused the target to
+ * be resumed (i.e. an explicit call to <code>resume()</code>)</li>
+ * <li><code>UNSPECIFIED</code> - The reason for the resume is not
+ * specified</li>
+ * </ul>
+ * </li>
+ * </ul>
* </li>
- * <li><code>IStackFrame</code> - no events are specified for stack frames.
- * When a thread is suspended, it has stack frames. When a thread resumes,
- * stack frames are unavailable.
+ * <li><code>IThread</code>
+ * <ul>
+ * <li><code>CREATE</code> - a thread has been created in a debug target.</li>
+ * <li><code>TERMINATE</code> - a thread has terminated.</li>
+ * <li><code>SUSPEND</code> - a thread has suspended execution. Event detail
+ * provides the reason for the suspension:
+ * <ul>
+ * <li><code>STEP_END</code> - a request to step has completed</li>
+ * <li><code>BREAKPOINT</code> - a breakpoint has been hit</li>
+ * <li><code>CLIENT_REQUEST</code> - a client request has caused the thread to
+ * suspend (i.e. an explicit call to <code>suspend()</code>)</li>
+ * <li><code>EVALUATION</code> - an expression evaluation has ended that may
+ * have had side effects in the debug target.</li>
+ * <li><code>EVALUATION_IMPLICIT</code> - an expression evaluation has ended
+ * that had no side effects in the debug target.</li>
+ * <li><code>UNSPECIFIED</code> - the reason for the suspend is not
+ * specified</li>
+ * </ul>
* </li>
- * <li><code>IVariable</code> - no events are specified for variables.
- * When a thread is suspended, stack frames have variables. When a thread resumes,
- * variables are unavailable.
+ * <li><code>RESUME</code> - a thread has resumed execution. Event detail
+ * provides the reason for the resume:
+ * <ul>
+ * <li><code>STEP_INTO</code> - a thread is being resumed because of a request
+ * to step into</li>
+ * <li><code>STEP_OVER</code> - a thread is being resumed because of a request
+ * to step over</li>
+ * <li><code>STEP_RETURN</code> - a thread is being resumed because of a request
+ * to step return</li>
+ * <li><code>CLIENT_REQUEST</code> - a client request has caused the thread to
+ * be resumed (i.e. an explicit call to <code>resume()</code>)</li>
+ * <li><code>EVALUATION</code> - an expression evaluation has started that may
+ * have side effects in the debug target.</li>
+ * <li><code>EVALUATION_IMPLICIT</code> - an expression evaluation has started
+ * that will have no side effects in the debug target.</li>
+ * <li><code>UNSPECIFIED</code> - The reason for the resume is not
+ * specified</li>
+ * </ul>
* </li>
- * <li><code>IValue</code> - no events are specified for values.
+ * </ul>
* </li>
+ * <li><code>IStackFrame</code> - no events are specified for stack frames. When
+ * a thread is suspended, it has stack frames. When a thread resumes, stack
+ * frames are unavailable.</li>
+ * <li><code>IVariable</code> - no events are specified for variables. When a
+ * thread is suspended, stack frames have variables. When a thread resumes,
+ * variables are unavailable.</li>
+ * <li><code>IValue</code> - no events are specified for values.</li>
* </ul>
*
*/
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 dccc366c4..8f99d3937 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
@@ -332,8 +332,9 @@ public interface IBreakpointManager {
* Revisit all the trigger points to activate/deactivate trigger points.
*
* @param triggerPoints list of trigger points to be deactivated or
- * <code>null<code> to deactivate all trigger points
- * @param enable enable if <code>true</code> or disable if <code>false</code>
+ * <code>null</code> to deactivate all trigger points
+ * @param enable enable if <code>true</code> or disable if
+ * <code>false</code>
* @since 3.11
*/
void enableTriggerPoints(IBreakpoint[] triggerPoints, boolean enable);
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManagerListener.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManagerListener.java
index 8d2a34586..d10763248 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManagerListener.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IBreakpointManagerListener.java
@@ -40,7 +40,7 @@ public interface IBreakpointManagerListener {
* Notifies the listener that the breakpoint manager's trigger point has
* changed.
*
- * @param triggerBreakpoint new trigger breakpoint or <code>null<code>
+ * @param triggerBreakpoint new trigger breakpoint or <code>null</code>
* @since 3.11
*/
default void breakpointManagerTriggerPointChanged(IBreakpoint triggerBreakpoint) {
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 e40503486..6c850fc68 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
@@ -29,35 +29,33 @@ import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
/**
- * A launch configuration describes how to launch an application.
- * Each launch configuration is an instance of a type of launch
- * configuration as described by a launch configuration type
- * extension. Each launch configuration has a launch configuration
- * delegate which performs the actual launching of a
+ * A launch configuration describes how to launch an application. Each launch
+ * configuration is an instance of a type of launch configuration as described
+ * by a launch configuration type extension. Each launch configuration has a
+ * launch configuration delegate which performs the actual launching of a
* configuration.
* <p>
- * A launch configuration may be shared in a repository via
- * standard VCM mechanisms, or may be stored locally, essentially
- * making the launch configuration private for a single user.
- * Thus, a launch configuration may stored as a file in the
- * workspace (shared), or as a file in the debug plug-in's state
- * location.
+ * A launch configuration may be shared in a repository via standard VCM
+ * mechanisms, or may be stored locally, essentially making the launch
+ * configuration private for a single user. Thus, a launch configuration may
+ * stored as a file in the workspace (shared), or as a file in the debug
+ * plug-in's state location.
* </p>
- * A launch configuration is a handle to its underlying storage.
- * Methods annotated as "handle-only" do not require a configuration
- * to exist. Methods that require an underlying configuration to exist
- * throw a <code>CoreException</code> when an underlying configuration
- * is missing.
+ * <p>
+ * A launch configuration is a handle to its underlying storage. Methods
+ * annotated as "handle-only" do not require a configuration to exist. Methods
+ * that require an underlying configuration to exist throw a
+ * <code>CoreException</code> when an underlying configuration is missing.
* </p>
* <p>
- * A launch configuration is modified by obtaining a working copy
- * of a launch configuration, modifying the working copy, and then
- * saving the working copy.
+ * A launch configuration is modified by obtaining a working copy of a launch
+ * configuration, modifying the working copy, and then saving the working copy.
* </p>
* <p>
* 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
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 199bf1bcd..2b0070e4b 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
@@ -24,13 +24,13 @@ import org.eclipse.debug.core.model.ILaunchConfigurationDelegate;
import org.eclipse.debug.core.sourcelookup.ISourcePathComputer;
/**
- * Describes and creates instances of a specific type of
- * launch configuration. Launch configuration types are
- * defined by extensions.
+ * Describes and creates instances of a specific type of launch configuration.
+ * Launch configuration types are defined by extensions.
* <p>
* A launch configuration type extension is defined in <code>plugin.xml</code>.
- * Following is an example definition of a launch configuration
- * type extension.
+ * Following is an example definition of a launch configuration type extension.
+ * </p>
+ *
* <pre>
* &lt;extension point="org.eclipse.debug.core.launchConfigurationTypes"&gt;
* &lt;launchConfigurationType
@@ -43,42 +43,48 @@ import org.eclipse.debug.core.sourcelookup.ISourcePathComputer;
* &lt;/launchConfigurationType&gt;
* &lt;/extension&gt;
* </pre>
+ *
* The attributes are specified as follows:
* <ul>
- * <li><code>id</code> specifies a unique identifier for this launch configuration
- * type.</li>
- * <li><code>delegate</code> specifies the fully qualified name of the java class
- * that implements <code>ILaunchConfigurationDelegate</code>. Launch configuration
- * instances of this type will delegate to instances of this class
- * to perform launching.</li>
+ * <li><code>id</code> specifies a unique identifier for this launch
+ * configuration type.</li>
+ * <li><code>delegate</code> specifies the fully qualified name of the java
+ * class that implements <code>ILaunchConfigurationDelegate</code>. Launch
+ * configuration instances of this type will delegate to instances of this class
+ * to perform launching.</li>
* <li><code>modes</code> specifies a comma separated list of the modes this
- * type of launch configuration supports - <code>"run"</code> and/or <code>"debug"</code>.</li>
- * <li><code>name</code> specifies a human readable name for this type
- * of launch configuration.</li>
+ * type of launch configuration supports - <code>"run"</code> and/or
+ * <code>"debug"</code>.</li>
+ * <li><code>name</code> specifies a human readable name for this type of launch
+ * configuration.</li>
* <li><code>category</code> is an optional attribute that specifies a category
* for this launch configuration type. Categories are client defined. This
* attribute was added in the 2.1 release.</li>
- * <li><code>sourceLocatorId</code> an optional unique identifier of a sourceLocator extension that
- * is used to create the source locator for sessions launched using launch configurations
- * of this type. This attribute was added in the 3.0 release.</li>
- * <li><code>sourcePathComputerId</code> an optional unique identifier of a sourcePathComputer extension
- * that is used to compute a default source lookup path for launch configurations of this type.
- * This attribute was added in the 3.0 release.</li>
+ * <li><code>sourceLocatorId</code> an optional unique identifier of a
+ * sourceLocator extension that is used to create the source locator for
+ * sessions launched using launch configurations of this type. This attribute
+ * was added in the 3.0 release.</li>
+ * <li><code>sourcePathComputerId</code> an optional unique identifier of a
+ * sourcePathComputer extension that is used to compute a default source lookup
+ * path for launch configurations of this type. This attribute was added in the
+ * 3.0 release.</li>
* </ul>
- * </p>
+ *
* <p>
- * The <code>category</code> attribute has been added in release 2.1, such that other
- * tools may re-use the launch configuration framework for purposes other than
- * the standard running and debugging of programs under development. Such that
- * clients may access arbitrary attributes specified in launch configuration type
- * extension definitions, the method <code>getAttribute</code> has also been
- * added. Launch configurations that are to be recognized as standard run/debug
- * launch configurations should not specify the <code>category</code> attribute.
+ * The <code>category</code> attribute has been added in release 2.1, such that
+ * other tools may re-use the launch configuration framework for purposes other
+ * than the standard running and debugging of programs under development. Such
+ * that clients may access arbitrary attributes specified in launch
+ * configuration type extension definitions, the method
+ * <code>getAttribute</code> has also been added. Launch configurations that are
+ * to be recognized as standard run/debug launch configurations should not
+ * specify the <code>category</code> attribute.
* </p>
* <p>
* Clients that define a launch configuration delegate extension implement the
* <code>ILaunchConfigurationDelegate</code> interface.
* </p>
+ *
* @see ILaunchConfiguration
* @since 2.0
* @noimplement This interface is not intended to be implemented by clients.
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchMode.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchMode.java
index b97da8770..5d09836ad 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchMode.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILaunchMode.java
@@ -14,13 +14,15 @@
package org.eclipse.debug.core;
/**
- * A launch mode. The debug platform contributes launch modes
- * for run, debug, and profile. Clients may contribute additional launch
- * modes in plug-in XML via the <code>launchModes</code> extension point.
+ * A launch mode. The debug platform contributes launch modes for run, debug,
+ * and profile. Clients may contribute additional launch modes in plug-in XML
+ * via the <code>launchModes</code> extension point.
* <p>
- * Following is an example launch mode contribution for profiling. A launch
- * mode has an unique identifier specified by the <code>mode</code> attribute
- * and a human readable label specified by the <code>label</code> attribute.
+ * Following is an example launch mode contribution for profiling. A launch mode
+ * has an unique identifier specified by the <code>mode</code> attribute and a
+ * human readable label specified by the <code>label</code> attribute.
+ * </p>
+ *
* <pre>
* &lt;extension point=&quot;org.eclipse.debug.core.launchModes&quot;&gt;
* &lt;launchMode
@@ -29,7 +31,7 @@ package org.eclipse.debug.core;
* &lt;/launchMode&gt;
* &lt;/extension&gt;
* </pre>
- * </p>
+ *
* @since 3.0
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureProvider.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureProvider.java
index 47e0e829f..0526f1927 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureProvider.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureProvider.java
@@ -16,10 +16,12 @@ package org.eclipse.debug.core;
import org.eclipse.debug.core.model.IValue;
/**
- * Provides logical structure types applicable to a raw implementation value from
- * a debug model. Associated with a logical structure provider extension.
+ * Provides logical structure types applicable to a raw implementation value
+ * from a debug model. Associated with a logical structure provider extension.
* <p>
* The following is an example of a logical structure provider extension:
+ * </p>
+ *
* <pre>
* &lt;extension point=&quot;org.eclipse.debug.core.logicalStructureProviders&quot;&gt;
* &lt;logicalStructureProvider
@@ -28,15 +30,17 @@ import org.eclipse.debug.core.model.IValue;
* &lt;/logicalStructureProvider&gt;
* &lt;/extension&gt;
* </pre>
- * </p>
- * In the example above, the specified logical structure provider will be consulted for
- * alternative logical structures for values from the <code>com.example.debug.model</code>
- * debug model as they are displayed in the variables view.
+ * <p>
+ * In the example above, the specified logical structure provider will be
+ * consulted for alternative logical structures for values from the
+ * <code>com.example.debug.model</code> debug model as they are displayed in the
+ * variables view.
* </p>
* <p>
* Clients contributing logical structure providers must implement this
* interface.
* </p>
+ *
* @since 3.1
* @see org.eclipse.debug.core.ILogicalStructureType
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureType.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureType.java
index c6f4b3153..ff45b549e 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureType.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/ILogicalStructureType.java
@@ -17,14 +17,16 @@ import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate;
import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate2;
/**
- * Provides a value representing the logical structure of a raw implementation value
- * from a debug model. Logical structures are useful for navigating complex data
- * structures. Logical structure types are contributed via extensions in plug-in XML,
- * and provide a delegate for performing logical value computation. Logical
- * structure types can be retrieved from the <code>DebugPlugin</code>.
+ * Provides a value representing the logical structure of a raw implementation
+ * value from a debug model. Logical structures are useful for navigating
+ * complex data structures. Logical structure types are contributed via
+ * extensions in plug-in XML, and provide a delegate for performing logical
+ * value computation. Logical structure types can be retrieved from the
+ * <code>DebugPlugin</code>.
* <p>
* Following is example plug-in XML to define a logical structure type.
* </p>
+ *
* <pre>
* &lt;extension point=&quot;org.eclipse.debug.core.logicalStructureTypes&quot;&gt;
* &lt;logicalStructureType
@@ -37,23 +39,25 @@ import org.eclipse.debug.core.model.ILogicalStructureTypeDelegate2;
* </pre>
* <p>
* The attributes are specified as follows:
+ * </p>
* <ul>
* <li>id - unique identifier for this logical structure type</li>
* <li>class - fully qualified name of class that implements
- * <code>ILogicalStructureTypeDelegate</code></li>
+ * <code>ILogicalStructureTypeDelegate</code></li>
* <li>modelIdentifier - identifier of the debug model this logical structure
- * type is associated with</li>
+ * type is associated with</li>
* <li>description - description of the logical structure provided</li>
* </ul>
- * </p>
* <p>
- * Clients contributing logicalStructureType extensions are not intended to implement
- * this interface. Rather, they provide an <code>ILogicalStructureTypeDelegate</code>
- * that optionally implements <code>ILogicalStructureTypeDelegate2</code> to provide
- * dynamic descriptions of logical structures.
- * Since 3.1, clients contributing logicalStructureProviders extensions may implement this
- * interface to return a collection of logical structure types applicable to a value.
+ * Clients contributing logicalStructureType extensions are not intended to
+ * implement this interface. Rather, they provide an
+ * <code>ILogicalStructureTypeDelegate</code> that optionally implements
+ * <code>ILogicalStructureTypeDelegate2</code> to provide dynamic descriptions
+ * of logical structures. Since 3.1, clients contributing
+ * logicalStructureProviders extensions may implement this interface to return a
+ * collection of logical structure types applicable to a value.
* </p>
+ *
* @since 3.0
* @see org.eclipse.debug.core.model.ILogicalStructureTypeDelegate
* @see org.eclipse.debug.core.ILogicalStructureProvider
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IProcessFactory.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IProcessFactory.java
index 553c41cca..468b8ca17 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IProcessFactory.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IProcessFactory.java
@@ -21,13 +21,15 @@ import org.eclipse.debug.core.model.IProcess;
* A process factory is used to override default process (<code>IProcess</code>)
* creation by the debug plug-in, and can be contributed via plug-in XML. When a
* new process is created via <code>DebugPlugin.newProcess(..)</code>, the
- * launch configuration associated with the specified launch is consulted for
- * a process factory attribute (<code>DebugPlugin.ATTR_PROCESS_FACTORY_ID</code>). If
- * present, the associated process factory is consulted to create a process for
- * the launch. If not present a default process implementation is created and
- * returned by the debug plug-in.
+ * launch configuration associated with the specified launch is consulted for a
+ * process factory attribute (<code>DebugPlugin.ATTR_PROCESS_FACTORY_ID</code>).
+ * If present, the associated process factory is consulted to create a process
+ * for the launch. If not present a default process implementation is created
+ * and returned by the debug plug-in.
* <p>
* Following is example plug-in XML that contributes a process factory.
+ * </p>
+ *
* <pre>
* &lt;extension point="org.eclipse.debug.core.processFactories"&gt;
* &lt;processFactory
@@ -36,16 +38,18 @@ import org.eclipse.debug.core.model.IProcess;
* &lt;/processFactory&gt;
* &lt;/extension&gt;
* </pre>
+ *
* The attributes are specified as follows:
* <ul>
* <li>id - a unique identifier for this extension point</li>
* <li>class - the fully qualified name of a class the implements
- * <code>IProcessFactory</code></li>
+ * <code>IProcessFactory</code></li>
* </ul>
- * </p>
* <p>
- * Clients contributing a process factory are intended to implement this interface.
+ * Clients contributing a process factory are intended to implement this
+ * interface.
* </p>
+ *
* @since 3.0
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java
index 601496a27..b955afa00 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/IStatusHandler.java
@@ -18,24 +18,25 @@ import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
/**
- * A status handler registers to handle a specific status - error
- * or otherwise. Provides a mechanism for separating core (headless)
- * function from UI interaction. The debug plug-in provides a
- * status handlers extension point, against which handlers can
- * register for specific status codes - identified by plug-in
- * identifier and plug-in specific status code. The interaction between
- * an object requiring a status handler (source), and the status handler
- * is defined by the source and handler.
+ * A status handler registers to handle a specific status - error or otherwise.
+ * Provides a mechanism for separating core (headless) function from UI
+ * interaction. The debug plug-in provides a status handlers extension point,
+ * against which handlers can register for specific status codes - identified by
+ * plug-in identifier and plug-in specific status code. The interaction between
+ * an object requiring a status handler (source), and the status handler is
+ * defined by the source and handler.
* <p>
- * For example, a launch configuration delegate might encounter a timeout
- * while launching an application. In this case the delegate could abort
- * or, via the use of a status handler, prompt the user to continue. This
- * allows the launcher to be implemented in a plug-in that does not require
- * UI support, and allows another (UI) plug-in to register a handler.
+ * For example, a launch configuration delegate might encounter a timeout while
+ * launching an application. In this case the delegate could abort or, via the
+ * use of a status handler, prompt the user to continue. This allows the
+ * launcher to be implemented in a plug-in that does not require UI support, and
+ * allows another (UI) plug-in to register a handler.
* </p>
* <p>
- * A status handler extension is defined in <code>plugin.xml</code>.
- * Following is an example definition of a status handler extension.
+ * A status handler extension is defined in <code>plugin.xml</code>. Following
+ * is an example definition of a status handler extension.
+ * </p>
+ *
* <pre>
* &lt;extension point="org.eclipse.debug.core.statusHandlers"&gt;
* &lt;statusHandler
@@ -46,21 +47,23 @@ import org.eclipse.core.runtime.IStatus;
* &lt;/statusHandler&gt;
* &lt;/extension&gt;
* </pre>
+ *
* The attributes are specified as follows:
* <ul>
- * <li><code>id</code> specifies a unique identifier for this status handler.</li>
+ * <li><code>id</code> specifies a unique identifier for this status
+ * handler.</li>
* <li><code>class</code> specifies the fully qualified name of the Java class
- * that implements <code>IStatusHandler</code>.</li>
- * <li><code>plugin</code> plug-in identifier that corresponds to the
- * plug-in of the status this handler is registered for (i.e.
- * <code>IStatus.getPlugin()</code>).</li>
- * <li><code>code</code> specifies the status code this handler
- * is registered for.</li>
+ * that implements <code>IStatusHandler</code>.</li>
+ * <li><code>plugin</code> plug-in identifier that corresponds to the plug-in of
+ * the status this handler is registered for (i.e.
+ * <code>IStatus.getPlugin()</code>).</li>
+ * <li><code>code</code> specifies the status code this handler is registered
+ * for.</li>
* </ul>
- * </p>
* <p>
* Clients may implement this interface.
* </p>
+ *
* @see DebugPlugin#getStatusHandler(IStatus)
* @since 2.0
*/
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IBreakpointImportParticipant.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IBreakpointImportParticipant.java
index 5bf3e818c..a986fc6fb 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IBreakpointImportParticipant.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IBreakpointImportParticipant.java
@@ -21,24 +21,26 @@ import org.eclipse.debug.core.IBreakpointManager;
/**
* This interface defines a breakpoint import participant.
* <p>
- * Participants are used during a breakpoint import operation
- * to specify how breakpoints of the associated marker type should be compared
- * and how the breakpoint should be validated once it is decided it will be imported.
+ * Participants are used during a breakpoint import operation to specify how
+ * breakpoints of the associated marker type should be compared and how the
+ * breakpoint should be validated once it is decided it will be imported.
* </p>
* <p>
* A breakpoint import participant it contributed via the
- * <code>org.eclipse.debug.core.breakpointImportParticipants</code> extension point.
+ * <code>org.eclipse.debug.core.breakpointImportParticipants</code> extension
+ * point.
* </p>
* <p>
* Following is an example of a breakpoint participant extension:
* </p>
+ *
* <pre>
- * <extension point="org.eclipse.debug.core.breakpointImportParticipants">
- * <importParticipant
+ * &lt;extension point="org.eclipse.debug.core.breakpointImportParticipants"&gt;
+ * &lt;importParticipant
* participant="x.y.z.BreakpointImportParticipant"
- * type="org.eclipse.jdt.debug.javaLineBreakpointMarker">
- * </importParticipant>
- * </extension>
+ * type="org.eclipse.jdt.debug.javaLineBreakpointMarker"&gt;
+ * &lt;/importParticipant&gt;
+ * &lt;/extension&gt;
* </pre>
* <p>
* Clients may implement this interface.
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IPersistableSourceLocator.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IPersistableSourceLocator.java
index 7c36c7c2c..c2bd3ea89 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IPersistableSourceLocator.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IPersistableSourceLocator.java
@@ -18,13 +18,14 @@ import org.eclipse.core.runtime.CoreException;
import org.eclipse.debug.core.ILaunchConfiguration;
/**
- * A source locator that can be persisted and restored,
- * to be used with a specific launch configuration.
- * The debug plug-in defines a source locator extension
- * point for persistable source locators.
+ * A source locator that can be persisted and restored, to be used with a
+ * specific launch configuration. The debug plug-in defines a source locator
+ * extension point for persistable source locators.
* <p>
- * A source locator extension is defined in <code>plugin.xml</code>.
- * Following is an example definition of a source locator extension.
+ * A source locator extension is defined in <code>plugin.xml</code>. Following
+ * is an example definition of a source locator extension.
+ * </p>
+ *
* <pre>
* &lt;extension point="org.eclipse.debug.core.sourceLocators"&gt;
* &lt;sourceLocator
@@ -34,18 +35,20 @@ import org.eclipse.debug.core.ILaunchConfiguration;
* &lt;/sourceLocator&gt;
* &lt;/extension&gt;
* </pre>
+ *
* The attributes are specified as follows:
* <ul>
- * <li><code>id</code> specifies a unique identifier for this source locator.</li>
+ * <li><code>id</code> specifies a unique identifier for this source
+ * locator.</li>
* <li><code>class</code> specifies the fully qualified name of the Java class
- * that implements <code>IPersistableSourceLocator</code>.</li>
- * <li><code>name</code> a human readable name, describing the type of
- * this source locator.</li>
+ * that implements <code>IPersistableSourceLocator</code>.</li>
+ * <li><code>name</code> a human readable name, describing the type of this
+ * source locator.</li>
* </ul>
- * </p>
* <p>
* Clients may implement this interface.
* </p>
+ *
* @see org.eclipse.debug.core.ILaunch
* @see IStackFrame
* @since 2.0
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IStepFilter.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IStepFilter.java
index 1fb05fb3d..4183815f5 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IStepFilter.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/model/IStepFilter.java
@@ -16,6 +16,7 @@ package org.eclipse.debug.core.model;
*
* <p>
* The following is an example of a step filter extension:
+ * </p>
*
* <pre>
* &lt;extension point=&quot;org.eclipse.debug.core.stepFilters&quot;&gt;
@@ -25,10 +26,10 @@ package org.eclipse.debug.core.model;
* &lt;/stepFilters&gt;
* &lt;/extension&gt;
* </pre>
- *
- * </p>
+ * <p>
* In the example above, the specified step filter will be used for the
- * <code>com.example.debug.model</code> debug model. </p>
+ * <code>com.example.debug.model</code> debug model.
+ * </p>
*
* <p>
* Clients contributing step filters must implement this interface.
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/package.html b/org.eclipse.debug.core/core/org/eclipse/debug/core/package.html
index 069ad320f..34937cab9 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/package.html
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/package.html
@@ -44,7 +44,6 @@ and debug events.</p>
Expressions are not automatically persisted, but a client could persist its own expressions
if required.</li>
</ul>
-<p></p>
<h4>Launch Configurations</h4>
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourceContainerType.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourceContainerType.java
index a81c864ef..49053aad3 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourceContainerType.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourceContainerType.java
@@ -16,14 +16,17 @@ package org.eclipse.debug.core.sourcelookup;
/**
- * A source container type represents a kind of container of source code.
- * For example, a source container type may be a project or a directory. A specific
- * project or directory is represented by an instance of a source container type,
- * which is called a source container (<code>ISourceContainer</code>).
+ * A source container type represents a kind of container of source code. For
+ * example, a source container type may be a project or a directory. A specific
+ * project or directory is represented by an instance of a source container
+ * type, which is called a source container (<code>ISourceContainer</code>).
* <p>
- * A source container type is contributed via the <code>sourceContainerTypes</code>
- * extension point, providing a delegate to the work specific to the contributed
- * type. Following is an example contribution.
+ * A source container type is contributed via the
+ * <code>sourceContainerTypes</code> extension point, providing a delegate to
+ * the work specific to the contributed type. Following is an example
+ * contribution.
+ * </p>
+ *
* <pre>
* &lt;extension point=&quot;org.eclipse.debug.core.sourceContainerTypes&quot;&gt;
* &lt;sourceContainerType
@@ -34,11 +37,11 @@ package org.eclipse.debug.core.sourcelookup;
* &lt;/sourceContainerType&gt;
* &lt;/extension&gt;
* </pre>
- * </p>
* <p>
* Clients contributing a source container type implement
* {@link org.eclipse.debug.core.sourcelookup.ISourceContainerTypeDelegate}.
* </p>
+ *
* @see org.eclipse.debug.core.sourcelookup.ISourceContainer
* @see org.eclipse.debug.core.sourcelookup.ISourceContainerTypeDelegate
* @since 3.0
diff --git a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourcePathComputer.java b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourcePathComputer.java
index 6577880de..357b96217 100644
--- a/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourcePathComputer.java
+++ b/org.eclipse.debug.core/core/org/eclipse/debug/core/sourcelookup/ISourcePathComputer.java
@@ -20,9 +20,11 @@ import org.eclipse.debug.core.DebugPlugin;
* containers that should be considered) for a launch configuration.
* <p>
* A source path computer is contributed in plug-in XML via the
- * <code>sourcePathComputers</code> extension point, that provides a delegate
- * to compute the path specific to a launch configuration. Following
- * is an example contribution.
+ * <code>sourcePathComputers</code> extension point, that provides a delegate to
+ * compute the path specific to a launch configuration. Following is an example
+ * contribution.
+ * </p>
+ *
* <pre>
* &lt;extension point=&quot;org.eclipse.debug.core.sourcePathComputers&quot;&gt;
* &lt;sourcePathComputer
@@ -31,18 +33,18 @@ import org.eclipse.debug.core.DebugPlugin;
* &lt;/sourcePathComputer&gt;
* &lt;/extension&gt;
* </pre>
- * </p>
* <p>
- * A source path computer can be associated with a launch configuration type
- * via the <code>sourcePathComputerId</code> attribute of a launch configuration
- * type extension. As well, a launch configuration can specify its own
- * source path computer to use via the <code>ATTR_SOURCE_PATH_COMPUTER_ID</code>
+ * A source path computer can be associated with a launch configuration type via
+ * the <code>sourcePathComputerId</code> attribute of a launch configuration
+ * type extension. As well, a launch configuration can specify its own source
+ * path computer to use via the <code>ATTR_SOURCE_PATH_COMPUTER_ID</code>
* attribute.
* </p>
* <p>
* Clients contributing a source path computer provide an implementation of
* {@link org.eclipse.debug.core.sourcelookup.ISourcePathComputerDelegate}.
* </p>
+ *
* @since 3.0
* @noimplement This interface is not intended to be implemented by clients.
* @noextend This interface is not intended to be extended by clients.

Back to the top