Skip to content

Commit 05e4a1c

Browse files
committed
Fixed javadoc errors.
1 parent 422bd8b commit 05e4a1c

File tree

9 files changed

+28
-28
lines changed

9 files changed

+28
-28
lines changed

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/AbstractHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public void dispose() {
5959
* type of listener can be attached to a subclass). This is used primarily
6060
* for support of <code>AbstractHandler</code> in
6161
* <code>org.eclipse.ui.workbench</code>, and clients should be wary of
62-
* overriding this behaviour. If this method is overridden, then the first
62+
* overriding this behavior. If this method is overridden, then the first
6363
* line of the method should be "<code>super.fireHandlerChanged(handlerEvent);</code>".
6464
* </p>
6565
*
@@ -147,7 +147,7 @@ public boolean isHandled() {
147147
* type of listener can be attached to a subclass). This is used primarily
148148
* for support of <code>AbstractHandler</code> in
149149
* <code>org.eclipse.ui.workbench</code>, and clients should be wary of
150-
* overriding this behaviour. If this method is overridden, then the return
150+
* overriding this behavior. If this method is overridden, then the return
151151
* value should include "<code>super.hasListeners() ||</code>".
152152
* </p>
153153
*

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/AbstractParameterValueConverter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* <p>
3131
* This class will typically be extended so the subclass can be referenced from
3232
* the <code>converter</code> attribute of the
33-
* <code>commandParameterType</code> elemement of the
33+
* <code>commandParameterType</code> element of the
3434
* <code>org.eclipse.ui.commands</code> extension-point. Objects implementing
3535
* this interface may also be passed directly to
3636
* {@link ParameterType#define(String, AbstractParameterValueConverter)} by

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/Command.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
/**
2727
* <p>
2828
* A command is an abstract representation for some semantic behaviour. It is
29-
* not the actual implementation of this behaviour, nor is it the visual
30-
* appearance of this behaviour in the user interface. Instead, it is a bridge
29+
* not the actual implementation of this behavior, nor is it the visual
30+
* appearance of this behavior in the user interface. Instead, it is a bridge
3131
* between the two.
3232
* </p>
3333
* <p>

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/CommandEvent.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -172,26 +172,26 @@ public CommandEvent(final Command command, final boolean categoryChanged,
172172
* @param command
173173
* the instance of the interface that changed.
174174
* @param categoryChanged
175-
* <code>true</code>, iff the category property changed.
175+
* <code>true</code>, if the category property changed.
176176
* @param definedChanged
177-
* <code>true</code>, iff the defined property changed.
177+
* <code>true</code>, if the defined property changed.
178178
* @param descriptionChanged
179-
* <code>true</code>, iff the description property changed.
179+
* <code>true</code>, if the description property changed.
180180
* @param handledChanged
181-
* <code>true</code>, iff the handled property changed.
181+
* <code>true</code>, if the handled property changed.
182182
* @param nameChanged
183-
* <code>true</code>, iff the name property changed.
183+
* <code>true</code>, if the name property changed.
184184
* @param parametersChanged
185185
* <code>true</code> if the parameters have changed;
186186
* <code>false</code> otherwise.
187187
* @param returnTypeChanged
188-
* <code>true</code> iff the return type property changed;
188+
* <code>true</code> if the return type property changed;
189189
* <code>false</code> otherwise.
190190
* @param helpContextIdChanged
191-
* <code>true</code> iff the help context identifier changed;
191+
* <code>true</code> if the help context identifier changed;
192192
* <code>false</code> otherwise.
193193
* @param enabledChanged
194-
* <code>true</code> iff the comand enablement changed;
194+
* <code>true</code> if the command enablement changed;
195195
* <code>false</code> otherwise.
196196
* @since 3.3
197197
*/
@@ -287,7 +287,7 @@ public final boolean isReturnTypeChanged() {
287287
/**
288288
* Return whether the enable property changed.
289289
*
290-
* @return <code>true</code> iff the comand enablement changed
290+
* @return <code>true</code> if the command enablement changed
291291
* @since 3.3
292292
*/
293293
public final boolean isEnabledChanged() {

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/ParameterizedCommand.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* <p>
3434
* A command that has had one or more of its parameters specified. This class
3535
* serves as a utility class for developers that need to manipulate commands
36-
* with parameters. It handles the behaviour of generating a parameter map and a
36+
* with parameters. It handles the behavior of generating a parameter map and a
3737
* human-readable name.
3838
* </p>
3939
*
@@ -434,7 +434,7 @@ public boolean equals(final Object object) {
434434
/**
435435
* Executes this command with its parameters. This method will succeed
436436
* regardless of whether the command is enabled or defined. It is
437-
* preferrable to use {@link #executeWithChecks(Object, Object)}.
437+
* preferable to use {@link #executeWithChecks(Object, Object)}.
438438
*
439439
* @param trigger
440440
* The object that triggered the execution; may be

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/common/NamedHandleObject.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public abstract class NamedHandleObject extends HandleObject {
2929
protected String description = null;
3030

3131
/**
32-
* The name of this handle. This valud should not be <code>null</code>
32+
* The name of this handle. This value should not be <code>null</code>
3333
* unless the handle is undefined.
3434
*/
3535
protected String name = null;

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/common/NamedHandleObjectComparator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public class NamedHandleObjectComparator implements Comparator {
3232
* useful is they are display to an end user.
3333
*
3434
* @param left
35-
* The first obect to compare; may be <code>null</code>.
35+
* The first object to compare; may be <code>null</code>.
3636
* @param right
3737
* The second object to compare; may be <code>null</code>.
3838
* @return <code>-1</code> if <code>left</code> is <code>null</code>

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/operations/IAdvancedUndoableOperation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ public interface IAdvancedUndoableOperation {
8989
* @return the IStatus indicating the validity of the undo. The status
9090
* severity should be set to <code>OK</code> if the undo can
9191
* successfully be performed, and <code>ERROR</code> if it
92-
* cannnot. Any other status is assumed to represent an ambiguous
92+
* cannot. Any other status is assumed to represent an ambiguous
9393
* state.
9494
* @throws ExecutionException
9595
* if an exception occurs while computing the validity.
@@ -119,7 +119,7 @@ IStatus computeUndoableStatus(IProgressMonitor monitor)
119119
* @return the IStatus indicating the validity of the redo. The status
120120
* severity should be set to <code>OK</code> if the redo can
121121
* successfully be performed, and <code>ERROR</code> if it
122-
* cannnot. Any other status is assumed to represent an ambiguous
122+
* cannot. Any other status is assumed to represent an ambiguous
123123
* state.
124124
* @throws ExecutionException
125125
* if an exception occurs while computing the validity.

bundles/org.eclipse.core.commands/src/org/eclipse/core/commands/package.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ <h2>Package Specification</h2>
1313
This package provides API and implementation classes to define abstract
1414
pieces of functionality. These pieces of functionality are intended to
1515
provide a common way for plug-ins and the user interface to communicate
16-
potential behaviour.
16+
potential behavior.
1717
</p>
1818
<p>
1919
This package is designed so that its elements can be public and dynamic. That
@@ -22,11 +22,11 @@ <h2>Package Specification</h2>
2222
</p>
2323
<h3>Command</h3>
2424
<p>
25-
A command is an abstract representation for some semantic behaviour. For
25+
A command is an abstract representation for some semantic behavior. For
2626
example, there might be a "copy" command. How this command actually
2727
behaves might be dependent on what state your application is in. It is not
28-
the actual implementation of that behaviour, and it is not the visual
29-
representation of that behaviour.
28+
the actual implementation of that behavior, and it is not the visual
29+
representation of that behavior.
3030
</p>
3131
<p>
3232
Commands are managed by an instance of <code>CommandManager</code>. In fact, a
@@ -45,7 +45,7 @@ <h3>Command</h3>
4545
built around dynamic components (e.g., plug-ins).
4646
<p>
4747
Commands can be grouped into categories. These categories are arbitrary
48-
groupings, and have no defined behaviour. These categories might be used in a
48+
groupings, and have no defined behavior. These categories might be used in a
4949
user interface for breaking up a large list of commands into semantically
5050
similar commands -- making the list easier to navigate.
5151
</p>
@@ -115,20 +115,20 @@ <h4>Examples</h4>
115115

116116
<h3>Handler</h3>
117117
<p>
118-
A handler is the behaviour of a command at a particular point in time. This is
118+
A handler is the behavior of a command at a particular point in time. This is
119119
the piece that will actually interact with your application model. For every
120120
command, there can be zero or more possible handlers. However, at any one
121121
time, there is either one handler (i.e., handled) or no handler (i.e.,
122122
unhandled).
123123
</p>
124124
<p>
125125
Handlers must implement <code>IHandler</code>. However, there is a convenient
126-
abstract class, <code>AbstractHandler</code> which provides default behaviour
126+
abstract class, <code>AbstractHandler</code> which provides default behavior
127127
for some of the methods in the interface. It is recommended that developers
128128
subclass <code>AbstractHandler</code>.
129129
</p>
130130
<p>
131-
Beside functional behaviour, a handler carries with it a map of attribute
131+
Beside functional behavior, a handler carries with it a map of attribute
132132
values. This is a completely optionaly way of carrying extra data. In the
133133
case of the <code>AbstractHandler</code>, this map is empty. Some attributes
134134
have well defined meanings. These attributes are defined in

0 commit comments

Comments
 (0)