Skip to content

Commit 6e80a41

Browse files
Fix java doc in e4 plugins (eclipse-platform#1207)
Issue eclipse-platform#1103
1 parent dfd9109 commit 6e80a41

File tree

10 files changed

+29
-43
lines changed

10 files changed

+29
-43
lines changed

bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/css2/CSS2FontPropertiesHelpers.java

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,6 @@ public static void updateCSSPropertyFontComposite(CSS2FontProperties font, CSSVa
127127
*
128128
* @param font
129129
* @param value
130-
* @throws Exception
131130
*/
132131
public static void updateCSSPropertyFontFamily(CSS2FontProperties font, CSSValue value) {
133132
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
@@ -140,7 +139,6 @@ public static void updateCSSPropertyFontFamily(CSS2FontProperties font, CSSValue
140139
*
141140
* @param font
142141
* @param value
143-
* @throws Exception
144142
*/
145143
public static void updateCSSPropertyFontSize(CSS2FontProperties font, CSSValue value) {
146144
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
@@ -153,7 +151,6 @@ public static void updateCSSPropertyFontSize(CSS2FontProperties font, CSSValue v
153151
*
154152
* @param font
155153
* @param value
156-
* @throws Exception
157154
*/
158155
public static void updateCSSPropertyFontStyle(CSS2FontProperties font, CSSValue value) {
159156
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
@@ -166,7 +163,6 @@ public static void updateCSSPropertyFontStyle(CSS2FontProperties font, CSSValue
166163
*
167164
* @param font
168165
* @param value
169-
* @throws Exception
170166
*/
171167
public static void updateCSSPropertyFontWeight(CSS2FontProperties font, CSSValue value) {
172168
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {

bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/dom/properties/converters/ICSSValueConverter.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,11 @@ public interface ICSSValueConverter {
4242
* Returns the result of the conversion of the given CSSValue
4343
* <code>value</code>.
4444
*
45-
* @param value
46-
* the CSSValue to convert, of type {@link #getFromType()}
45+
* @param value the CSSValue to convert
4746
* @param engine
4847
* @param context
4948
*
50-
* @return the converted object, of type {@link #getToType()}
49+
* @return the converted object
5150
*/
5251
public Object convert(CSSValue value, CSSEngine engine, Object context)
5352
throws Exception;

bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/engine/CSSEngine.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,6 @@ ICSSPropertyHandler applyCSSProperty(Object node, String property, CSSValue valu
367367
*
368368
* @param node
369369
* @param applyStylesToChildNodes
370-
* @throws IOException
371370
*/
372371
void applyDefaultStyleDeclaration(Object node, boolean applyStylesToChildNodes);
373372

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
import org.w3c.css.sac.LexicalUnit;
1818
import org.w3c.dom.DOMException;
19+
import org.w3c.dom.css.CSSValue;
1920

2021
public class Measure extends CSSValueImpl {
2122

@@ -35,8 +36,9 @@ public float getFloatValue(short valueType) throws DOMException {
3536
//If it's actually a SAC_INTEGER return the integer value, callers tend to expect and cast
3637
//There is no getIntegerFloat(short)
3738
//TODO Not sure the purpose of arg valyeType, its not referenced in this method
38-
if(value.getLexicalUnitType() == LexicalUnit.SAC_INTEGER)
39+
if(value.getLexicalUnitType() == LexicalUnit.SAC_INTEGER) {
3940
return value.getIntegerValue();
41+
}
4042
//TODO not sure what to do if it's not one of the lexical unit types that are specified in LexicalUnit#getFloatValue()
4143
//ie. SAC_DEGREE, SAC_GRADIAN, SAC_RADIAN, SAC_MILLISECOND, SAC_SECOND, SAC_HERTZ or SAC_KILOHERTZ
4244
return value.getFloatValue();
@@ -55,8 +57,9 @@ public String getStringValue() throws DOMException {
5557
short lexicalUnit = value.getLexicalUnitType();
5658
if((lexicalUnit == LexicalUnit.SAC_IDENT)
5759
|| (lexicalUnit == LexicalUnit.SAC_STRING_VALUE)
58-
|| (lexicalUnit == LexicalUnit.SAC_URI))
60+
|| (lexicalUnit == LexicalUnit.SAC_URI)) {
5961
return value.getStringValue();
62+
}
6063
// TODO There are more cases to catch of getLexicalUnitType()
6164
throw new UnsupportedOperationException("NOT YET IMPLEMENTED");
6265
}

bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/impl/sac/CSSDocumentHandlerImpl.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@
3535
import org.w3c.dom.css.CSSStyleSheet;
3636

3737
/**
38-
* This class provides an implementation for the
39-
* {@link org.eclipse.ui.css.core.sac.ExtendedDocumentHandler} interface.
38+
* This class provides an implementation for the {@link ExtendedDocumentHandler}
39+
* interface.
4040
*/
4141
public class CSSDocumentHandlerImpl implements ExtendedDocumentHandler {
4242

bundles/org.eclipse.e4.ui.css.core/src/org/eclipse/e4/ui/css/core/utils/StringUtils.java

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -64,16 +64,14 @@ public static boolean isEmpty(String value) {
6464
// -----------------------------------------------------------------------
6565
/**
6666
* <p>
67-
* Capitalizes all the whitespace separated words in a String. Only the
68-
* first letter of each word is changed. To convert the rest of each word to
69-
* lowercase at the same time, use {@link #capitalizeFully(String)}.
67+
* Capitalizes all the whitespace separated words in a String. Only the first
68+
* letter of each word is changed.
7069
* </p>
7170
*
7271
* <p>
7372
* Whitespace is defined by {@link Character#isWhitespace(char)}. A
74-
* <code>null</code> input String returns <code>null</code>.
75-
* Capitalization uses the unicode title case, normally equivalent to upper
76-
* case.
73+
* <code>null</code> input String returns <code>null</code>. Capitalization uses
74+
* the unicode title case, normally equivalent to upper case.
7775
* </p>
7876
*
7977
* <pre>
@@ -82,11 +80,8 @@ public static boolean isEmpty(String value) {
8280
* WordUtils.capitalize(&quot;i am FINE&quot;) = &quot;I Am FINE&quot;
8381
* </pre>
8482
*
85-
* @param str
86-
* the String to capitalize, may be null
83+
* @param str the String to capitalize, may be null
8784
* @return capitalized String, <code>null</code> if null String input
88-
* @see #uncapitalize(String)
89-
* @see #capitalizeFully(String)
9085
*/
9186
public static String capitalize(String str) {
9287
return capitalize(str, null);
@@ -95,20 +90,18 @@ public static String capitalize(String str) {
9590
/**
9691
* <p>
9792
* Capitalizes all the delimiter separated words in a String. Only the first
98-
* letter of each word is changed. To convert the rest of each word to
99-
* lowercase at the same time, use {@link #capitalizeFully(String, char[])}.
93+
* letter of each word is changed.
10094
* </p>
10195
*
10296
* <p>
103-
* The delimiters represent a set of characters understood to separate
104-
* words. The first string character and the first non-delimiter character
105-
* after a delimiter will be capitalized.
97+
* The delimiters represent a set of characters understood to separate words.
98+
* The first string character and the first non-delimiter character after a
99+
* delimiter will be capitalized.
106100
* </p>
107101
*
108102
* <p>
109-
* A <code>null</code> input String returns <code>null</code>.
110-
* Capitalization uses the unicode title case, normally equivalent to upper
111-
* case.
103+
* A <code>null</code> input String returns <code>null</code>. Capitalization
104+
* uses the unicode title case, normally equivalent to upper case.
112105
* </p>
113106
*
114107
* <pre>
@@ -119,14 +112,10 @@ public static String capitalize(String str) {
119112
* WordUtils.capitalize(&quot;i aM.fine&quot;, {'.'}) = &quot;I aM.Fine&quot;
120113
* </pre>
121114
*
122-
* @param str
123-
* the String to capitalize, may be null
124-
* @param delimiters
125-
* set of characters to determine capitalization, null means
126-
* whitespace
115+
* @param str the String to capitalize, may be null
116+
* @param delimiters set of characters to determine capitalization, null means
117+
* whitespace
127118
* @return capitalized String, <code>null</code> if null String input
128-
* @see #uncapitalize(String)
129-
* @see #capitalizeFully(String)
130119
* @since 2.1
131120
*/
132121
public static String capitalize(String str, char[] delimiters) {

bundles/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/dom/SWTElementProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
*
4545
*
4646
* {@link IElementProvider} SWT implementation to retrieve w3c Element
47-
* {@link SWTElement} linked to SWT widget.
47+
* {@link Element} linked to SWT widget.
4848
*
4949
*/
5050
public class SWTElementProvider implements IElementProvider {

bundles/org.eclipse.e4.ui.css.swt/src/org/eclipse/e4/ui/css/swt/helpers/CSSSWTCursorHelper.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ public class CSSSWTCursorHelper {
2525
private static final String DEFAULT_CURSOR = "defaultCursor";
2626

2727
/**
28-
* @see http://www.w3schools.com/css/pr_class_cursor.asp
28+
* @see <a href=
29+
* "http://www.w3schools.com/css/pr_class_cursor.asp">http://www.w3schools.com/css/pr_class_cursor.asp</a>
2930
*/
3031
public static Cursor getSWTCursor(CSSValue value, Display display) {
3132
if (!(value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE)) {

bundles/org.eclipse.e4.ui.workbench3/META-INF/MANIFEST.MF

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Manifest-Version: 1.0
22
Bundle-ManifestVersion: 2
33
Bundle-SymbolicName: org.eclipse.e4.ui.workbench3;singleton:=true
4-
Bundle-Version: 0.17.100.qualifier
4+
Bundle-Version: 0.17.200.qualifier
55
Bundle-Name: %pluginName
66
Bundle-Vendor: %providerName
77
Bundle-Localization: plugin

bundles/org.eclipse.e4.ui.workbench3/src/org/eclipse/ui/testing/IWorkbenchPartTestable.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* This interface provides methods that allow introspection of workbench parts.
2020
* Instances may be obtained by calling
2121
* {@link org.eclipse.core.runtime.IAdaptable#getAdapter(Class)} on
22-
* {@link org.eclipse.ui.IWorkbenchPartSite}.
22+
* org.eclipse.ui.IWorkbenchPartSite.
2323
*
2424
* <p>
2525
* This interface is not intended to be implemented or extended by clients.
@@ -31,8 +31,7 @@ public interface IWorkbenchPartTestable {
3131

3232
/**
3333
* Get the {@link org.eclipse.swt.widgets.Composite} provided to the parts
34-
* {@link org.eclipse.ui.IWorkbenchPart#createPartControl(Composite)}
35-
* method.
34+
* org.eclipse.ui.IWorkbenchPart.createPartControl(Composite) method.
3635
*
3736
* @return the composite
3837
*/

0 commit comments

Comments
 (0)