Skip to content

Commit c521dfc

Browse files
elsazacmerks
authored andcommitted
Fix Javadoc errors
1 parent 90de1f0 commit c521dfc

File tree

10 files changed

+25
-32
lines changed

10 files changed

+25
-32
lines changed

bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/dom/ElementAdapter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public boolean isStaticPseudoInstance(String s) {
7272

7373
@Override
7474
public void copyDefaultStyleDeclarations(CSSStylableElement stylableElement) {
75-
// Copy default style decalaration
75+
// Copy default style declaration
7676
this.setDefaultStyleDeclaration(null, stylableElement
7777
.getDefaultStyleDeclaration(null));
7878
// Copy all static pseudo instances

bundles/org.eclipse.e4.ui.model.workbench/model/UIElements.ecore

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@
100100
</eClassifiers>
101101
<eClassifiers xsi:type="ecore:EClass" name="Addon" eSuperTypes="#//Contribution">
102102
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
103-
<details key="documentation" value="&lt;p>&#xD;&#xA;An MAddon represents a self-contained application logic. Addons may be used&#xD;&#xA;to augment the UI in a variety of ways without requiring that the base application&#xD;&#xA;be aware of the extensions.&#xD;&#xA;&lt;/p>&lt;p>&#xD;&#xA;Addons are expected to be capable of being removed without damage to the&#xD;&#xA;original UI. While not yet implemented there will be an uninstall protocol defined&#xD;&#xA;In the future allowing an addon to remove any model elements specific to the&#xD;&#xA;addon (i.e. The MinMaxAddon's TrimElements.&#xD;&#xA;&lt;/p>&#xD;&#xA;@since 1.0&#xD;&#xA;@noimplement This interface is not intended to be implemented by clients."/>
103+
<details key="documentation" value="&lt;p>&#xD;&#xA;An MAddon represents a self-contained application logic. Addons may be used&#xD;&#xA;to augment the UI in a variety of ways without requiring that the base application&#xD;&#xA;be aware of the extensions.&#xD;&#xA;&lt;/p>&lt;p>&#xD;&#xA;Addons are expected to be capable of being removed without damage to the&#xD;&#xA;original UI. While not yet implemented there will be an uninstall protocol defined&#xD;&#xA;in the future allowing an addon to remove any model elements specific to the&#xD;&#xA;addon (i.e. The MinMaxAddon's TrimElements.&#xD;&#xA;&lt;/p>&#xD;&#xA;@since 1.0&#xD;&#xA;@noimplement This interface is not intended to be implemented by clients."/>
104104
</eAnnotations>
105105
</eClassifiers>
106106
<eClassifiers xsi:type="ecore:EClass" name="StringToObjectMap" instanceClassName="java.util.Map$Entry">
@@ -112,7 +112,7 @@
112112
<eClassifiers xsi:type="ecore:EClass" name="BindingTableContainer" abstract="true"
113113
interface="true">
114114
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
115-
<details key="documentation" value="&lt;p>&#xD;&#xA;This type contains the list of binding 'tables', representing the various sets of bindings&#xD;&#xA;based on the application's current running 'context'. Here the 'context' represents&#xD;&#xA;the application's UI state (i.e. whether a Dialog is open...).&#xD;&#xA;&lt;/p>&#xD;&#xA;@since 1.0&#xD;&#xA;@noimplement This interface is not intended to be implemented by clients."/>
115+
<details key="documentation" value="&lt;p>&#xD;&#xA;This type contains the list of binding 'tables', representing the various sets of bindings&#xD;&#xA;based on the applicaiton's current running 'context'. Here the 'context' represents&#xD;&#xA;the applicaiton's UI state (i.e. whether a Dialog is open...).&#xD;&#xA;&lt;/p>&#xD;&#xA;@since 1.0&#xD;&#xA;@noimplement This interface is not intended to be implemented by clients."/>
116116
</eAnnotations>
117117
<eStructuralFeatures xsi:type="ecore:EReference" name="bindingTables" upperBound="-1"
118118
eType="#//commands/BindingTable" containment="true">
@@ -1185,7 +1185,7 @@
11851185
</eOperations>
11861186
<eStructuralFeatures xsi:type="ecore:EAttribute" name="allowMultiple" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EBoolean">
11871187
<eAnnotations source="http://www.eclipse.org/emf/2002/GenModel">
1188-
<details key="documentation" value="&lt;p>&#xD;&#xA;Determines whether or not the part represented by this descriptot can have multiple&#xD;&#xA;instances with a given window.&#xD;&#xA;&lt;/p>"/>
1188+
<details key="documentation" value="&lt;p>&#xD;&#xA;Determines whether or not the part represented by this descriptor can have multiple&#xD;&#xA;instances with a given window.&#xD;&#xA;&lt;/p>"/>
11891189
</eAnnotations>
11901190
</eStructuralFeatures>
11911191
<eStructuralFeatures xsi:type="ecore:EAttribute" name="category" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString">

bundles/org.eclipse.e4.ui.model.workbench/src/org/eclipse/e4/ui/model/application/MAddon.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* </p><p>
2727
* Addons are expected to be capable of being removed without damage to the
2828
* original UI. While not yet implemented there will be an uninstall protocol defined
29-
* In the future allowing an addon to remove any model elements specific to the
29+
* in the future allowing an addon to remove any model elements specific to the
3030
* addon (i.e. The MinMaxAddon's TrimElements.
3131
* </p>
3232
* @since 1.0

bundles/org.eclipse.e4.ui.model.workbench/src/org/eclipse/e4/ui/model/application/descriptor/basic/MPartDescriptor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public interface MPartDescriptor extends MApplicationElement, MUILabel, MHandler
6666
* <!-- end-user-doc -->
6767
* <!-- begin-model-doc -->
6868
* <p>
69-
* Determines whether or not the part represented by this descriptot can have multiple
69+
* Determines whether or not the part represented by this descriptor can have multiple
7070
* instances with a given window.
7171
* </p>
7272
* <!-- end-model-doc -->

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/IJobRunnable.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,13 @@ public interface IJobRunnable {
2929
* <p>
3030
* The provided monitor can be used to report progress and respond to
3131
* cancellation. If the progress monitor has been canceled, the runnable should
32-
* finish its execution at the earliest convenience and return a result
33-
* status of severity <code>IStatus.CANCEL</code>. The singleton cancel
34-
* status <code>Status.CANCEL_STATUS</code> can be used for this purpose.
32+
* finish its execution at the earliest convenience and return a result status
33+
* of severity <code>IStatus.CANCEL</code>. The singleton cancel status
34+
* <code>Status.CANCEL_STATUS</code> can be used for this purpose.
3535
*
36-
* @param monitor
37-
* the monitor to be used for reporting progress and responding
38-
* to cancelation. The monitor is never <code>null</code>
39-
* @return resulting status of the run. The result must not be
40-
* <code>null</code>
36+
* @param monitor the monitor to be used for reporting progress and responding
37+
* to cancellation. The monitor is never <code>null</code>
38+
* @return resulting status of the run. The result must not be <code>null</code>
4139
*/
4240
public IStatus run(IProgressMonitor monitor);
4341

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/IProgressService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ public interface IProgressService extends IRunnableContext {
105105
* @throws InvocationTargetException wraps any exception or error which occurs
106106
* while running the runnable
107107
* @throws InterruptedException propagated by the context if the runnable
108-
* acknowledges cancelation by throwing this
108+
* acknowledges cancellation by throwing this
109109
* exception.
110110
*/
111111
public void runInUI(IRunnableContext context,

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/AnimationItem.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ interface IAnimationContainer {
3939
public abstract void animationDone();
4040
}
4141

42-
//Create a containter that does nothing by default
42+
// Create a container that does nothing by default
4343
IAnimationContainer animationContainer = new IAnimationContainer() {
4444
@Override
4545
public void animationDone() {

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/ProgressManagerUtil.java

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,13 +197,11 @@ static String shortenText(String textValue, Control control) {
197197
}
198198

199199
/**
200-
* Find the second index of a whitespace. Return the first index if there
201-
* isn't one or 0 if there is no space at all.
200+
* Find the second index of a whitespace. Return the first index if there isn't
201+
* one or 0 if there is no space at all.
202202
*
203-
* @param gc
204-
* The GC to test max length
205-
* @param maxWidth
206-
* The maximim extent
203+
* @param gc The GC to test max length
204+
* @param maxWidth The maximum extent
207205
* @return int
208206
*/
209207
private static int findSecondWhitespace(String textValue, GC gc,

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/ProgressRegion.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ public void dock(int dropSide) {
214214
}
215215

216216
/**
217-
* Answer true if the side is a horizonal one
217+
* Answer true if the side is a horizontal one
218218
*
219219
* @return <code>true</code> if the side is horizontal
220220
*/
@@ -227,9 +227,9 @@ private boolean isHorizontal(int dropSide) {
227227

228228

229229
/**
230-
* Answer true if the side is a horizonal one
230+
* Answer true if the side is a vertical one
231231
*
232-
* @return <code>true</code> if the side is horizontal
232+
* @return <code>true</code> if the side is vertical
233233
*/
234234
private boolean isVertical(int dropSide) {
235235
if (forceHorizontal) {

bundles/org.eclipse.e4.ui.progress/src/org/eclipse/e4/ui/progress/internal/TaskInfo.java

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,12 @@ void addWork(double workIncrement) {
4949
}
5050

5151
/**
52-
* Add the amount of work to the recevier. Update a parent monitor by the
52+
* Add the amount of work to the receiver. Update a parent monitor by the
5353
* increment scaled to the amount of ticks this represents.
5454
*
55-
* @param workIncrement
56-
* int the amount of work in the receiver
57-
* @param parentMonitor
58-
* The IProgressMonitor that is also listening
59-
* @param parentTicks
60-
* the number of ticks this monitor represents
55+
* @param workIncrement int the amount of work in the receiver
56+
* @param parentMonitor The IProgressMonitor that is also listening
57+
* @param parentTicks the number of ticks this monitor represents
6158
*/
6259
void addWork(double workIncrement, IProgressMonitor parentMonitor,
6360
int parentTicks) {

0 commit comments

Comments
 (0)