Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix some java doc.
  • Loading branch information
marcushoepfner committed Oct 18, 2023
1 parent e3d651a commit 157391b
Show file tree
Hide file tree
Showing 13 changed files with 40 additions and 52 deletions.
4 changes: 3 additions & 1 deletion bundles/org.eclipse.e4.core.commands/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ Import-Package: javax.annotation;version="[1.3.0,2.0.0)",
Export-Package: org.eclipse.e4.core.commands,
org.eclipse.e4.core.commands.internal;x-friends:="org.eclipse.e4.ui.bindings,org.eclipse.ui.workbench"
Require-Bundle: org.eclipse.equinox.common;bundle-version="[3.6.0,4.0.0)",
org.eclipse.e4.core.di;bundle-version="0.9.0"
org.eclipse.e4.core.di;bundle-version="0.9.0",
javax.annotation;bundle-version="[1.3.5,2.0.0)",
javax.inject;bundle-version="[1.0.0,2.0.0)"
Service-Component: OSGI-INF/org.eclipse.e4.core.commands.internal.CommandServiceCreationFunction.xml,
OSGI-INF/org.eclipse.e4.core.commands.internal.HandlerServiceCreationFunction.xml
Automatic-Module-Name: org.eclipse.e4.core.commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ public static void updateCSSPropertyFontComposite(CSS2FontProperties font, CSSVa
*
* @param font
* @param value
* @throws Exception
*/
public static void updateCSSPropertyFontFamily(CSS2FontProperties font, CSSValue value) {
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
Expand All @@ -140,7 +139,6 @@ public static void updateCSSPropertyFontFamily(CSS2FontProperties font, CSSValue
*
* @param font
* @param value
* @throws Exception
*/
public static void updateCSSPropertyFontSize(CSS2FontProperties font, CSSValue value) {
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
Expand All @@ -153,7 +151,6 @@ public static void updateCSSPropertyFontSize(CSS2FontProperties font, CSSValue v
*
* @param font
* @param value
* @throws Exception
*/
public static void updateCSSPropertyFontStyle(CSS2FontProperties font, CSSValue value) {
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
Expand All @@ -166,7 +163,6 @@ public static void updateCSSPropertyFontStyle(CSS2FontProperties font, CSSValue
*
* @param font
* @param value
* @throws Exception
*/
public static void updateCSSPropertyFontWeight(CSS2FontProperties font, CSSValue value) {
if (value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,11 @@ public interface ICSSValueConverter {
* Returns the result of the conversion of the given CSSValue
* <code>value</code>.
*
* @param value
* the CSSValue to convert, of type {@link #getFromType()}
* @param value the CSSValue to convert
* @param engine
* @param context
*
* @return the converted object, of type {@link #getToType()}
* @return the converted object
*/
public Object convert(CSSValue value, CSSEngine engine, Object context)
throws Exception;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,6 @@ ICSSPropertyHandler applyCSSProperty(Object node, String property, CSSValue valu
*
* @param node
* @param applyStylesToChildNodes
* @throws IOException
*/
void applyDefaultStyleDeclaration(Object node, boolean applyStylesToChildNodes);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

import org.w3c.css.sac.LexicalUnit;
import org.w3c.dom.DOMException;
import org.w3c.dom.css.CSSValue;

public class Measure extends CSSValueImpl {

Expand All @@ -35,8 +36,9 @@ public float getFloatValue(short valueType) throws DOMException {
//If it's actually a SAC_INTEGER return the integer value, callers tend to expect and cast
//There is no getIntegerFloat(short)
//TODO Not sure the purpose of arg valyeType, its not referenced in this method
if(value.getLexicalUnitType() == LexicalUnit.SAC_INTEGER)
if(value.getLexicalUnitType() == LexicalUnit.SAC_INTEGER) {
return value.getIntegerValue();
}
//TODO not sure what to do if it's not one of the lexical unit types that are specified in LexicalUnit#getFloatValue()
//ie. SAC_DEGREE, SAC_GRADIAN, SAC_RADIAN, SAC_MILLISECOND, SAC_SECOND, SAC_HERTZ or SAC_KILOHERTZ
return value.getFloatValue();
Expand All @@ -55,8 +57,9 @@ public String getStringValue() throws DOMException {
short lexicalUnit = value.getLexicalUnitType();
if((lexicalUnit == LexicalUnit.SAC_IDENT)
|| (lexicalUnit == LexicalUnit.SAC_STRING_VALUE)
|| (lexicalUnit == LexicalUnit.SAC_URI))
|| (lexicalUnit == LexicalUnit.SAC_URI)) {
return value.getStringValue();
}
// TODO There are more cases to catch of getLexicalUnitType()
throw new UnsupportedOperationException("NOT YET IMPLEMENTED");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
import org.w3c.dom.css.CSSStyleSheet;

/**
* This class provides an implementation for the
* {@link org.eclipse.ui.css.core.sac.ExtendedDocumentHandler} interface.
* This class provides an implementation for the {@link ExtendedDocumentHandler}
* interface.
*/
public class CSSDocumentHandlerImpl implements ExtendedDocumentHandler {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,14 @@ public static boolean isEmpty(String value) {
// -----------------------------------------------------------------------
/**
* <p>
* Capitalizes all the whitespace separated words in a String. Only the
* first letter of each word is changed. To convert the rest of each word to
* lowercase at the same time, use {@link #capitalizeFully(String)}.
* Capitalizes all the whitespace separated words in a String. Only the first
* letter of each word is changed.
* </p>
*
* <p>
* Whitespace is defined by {@link Character#isWhitespace(char)}. A
* <code>null</code> input String returns <code>null</code>.
* Capitalization uses the unicode title case, normally equivalent to upper
* case.
* <code>null</code> input String returns <code>null</code>. Capitalization uses
* the unicode title case, normally equivalent to upper case.
* </p>
*
* <pre>
Expand All @@ -82,11 +80,8 @@ public static boolean isEmpty(String value) {
* WordUtils.capitalize(&quot;i am FINE&quot;) = &quot;I Am FINE&quot;
* </pre>
*
* @param str
* the String to capitalize, may be null
* @param str the String to capitalize, may be null
* @return capitalized String, <code>null</code> if null String input
* @see #uncapitalize(String)
* @see #capitalizeFully(String)
*/
public static String capitalize(String str) {
return capitalize(str, null);
Expand All @@ -95,20 +90,18 @@ public static String capitalize(String str) {
/**
* <p>
* Capitalizes all the delimiter separated words in a String. Only the first
* letter of each word is changed. To convert the rest of each word to
* lowercase at the same time, use {@link #capitalizeFully(String, char[])}.
* letter of each word is changed.
* </p>
*
* <p>
* The delimiters represent a set of characters understood to separate
* words. The first string character and the first non-delimiter character
* after a delimiter will be capitalized.
* The delimiters represent a set of characters understood to separate words.
* The first string character and the first non-delimiter character after a
* delimiter will be capitalized.
* </p>
*
* <p>
* A <code>null</code> input String returns <code>null</code>.
* Capitalization uses the unicode title case, normally equivalent to upper
* case.
* A <code>null</code> input String returns <code>null</code>. Capitalization
* uses the unicode title case, normally equivalent to upper case.
* </p>
*
* <pre>
Expand All @@ -119,14 +112,10 @@ public static String capitalize(String str) {
* WordUtils.capitalize(&quot;i aM.fine&quot;, {'.'}) = &quot;I aM.Fine&quot;
* </pre>
*
* @param str
* the String to capitalize, may be null
* @param delimiters
* set of characters to determine capitalization, null means
* whitespace
* @param str the String to capitalize, may be null
* @param delimiters set of characters to determine capitalization, null means
* whitespace
* @return capitalized String, <code>null</code> if null String input
* @see #uncapitalize(String)
* @see #capitalizeFully(String)
* @since 2.1
*/
public static String capitalize(String str, char[] delimiters) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
*
*
* {@link IElementProvider} SWT implementation to retrieve w3c Element
* {@link SWTElement} linked to SWT widget.
* {@link Element} linked to SWT widget.
*
*/
public class SWTElementProvider implements IElementProvider {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ public class CSSSWTCursorHelper {
private static final String DEFAULT_CURSOR = "defaultCursor";

/**
* @see http://www.w3schools.com/css/pr_class_cursor.asp
* @see <a href=
* "http://www.w3schools.com/css/pr_class_cursor.asp">http://www.w3schools.com/css/pr_class_cursor.asp</a>
*/
public static Cursor getSWTCursor(CSSValue value, Display display) {
if (!(value.getCssValueType() == CSSValue.CSS_PRIMITIVE_VALUE)) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* This interface provides methods that allow introspection of workbench parts.
* Instances may be obtained by calling
* {@link org.eclipse.core.runtime.IAdaptable#getAdapter(Class)} on
* {@link org.eclipse.ui.IWorkbenchPartSite}.
* org.eclipse.ui.IWorkbenchPartSite.
*
* <p>
* This interface is not intended to be implemented or extended by clients.
Expand All @@ -31,8 +31,7 @@ public interface IWorkbenchPartTestable {

/**
* Get the {@link org.eclipse.swt.widgets.Composite} provided to the parts
* {@link org.eclipse.ui.IWorkbenchPart#createPartControl(Composite)}
* method.
* org.eclipse.ui.IWorkbenchPart.createPartControl(Composite) method.
*
* @return the composite
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ public abstract class AbstractControlFactory<F extends AbstractControlFactory<?,
* setting the tool tip text to an empty string replaces the default, causing no
* tool tip text to be shown.
*
* The mnemonic indicator (character '&') is not displayed in a tool tip. To
* display a single '&' in the tool tip, the character '&' can be escaped by
* doubling it in the string.
* The mnemonic indicator (character '&amp;') is not displayed in a tool tip. To
* display a single '&amp;' in the tool tip, the character '&amp;' can be
* escaped by doubling it in the string.
*
* @param tooltipText the tool tip text
* @return this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ public TableColumnFactory align(int alignment) {
* setting the tool tip text to an empty string replaces the default, causing no
* tool tip text to be shown.
*
* The mnemonic indicator (character '&') is not displayed in a tool tip. To
* display a single '&' in the tool tip, the character '&' can be escaped by
* doubling it in the string.
* The mnemonic indicator (character '&amp;') is not displayed in a tool tip. To
* display a single '&amp;' in the tool tip, the character '&amp;' can be
* escaped by doubling it in the string.
*
* @param tooltip the tool tip text
* @return this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ public TreeColumnFactory align(int alignment) {
* setting the tool tip text to an empty string replaces the default, causing no
* tool tip text to be shown.
*
* The mnemonic indicator (character '&') is not displayed in a tool tip. To
* display a single '&' in the tool tip, the character '&' can be escaped by
* doubling it in the string.
* The mnemonic indicator (character '&amp;') is not displayed in a tool tip. To
* display a single '&amp;' in the tool tip, the character '&amp;' can be
* escaped by doubling it in the string.
*
* @param tooltip the tool tip text
* @return this
Expand Down

0 comments on commit 157391b

Please sign in to comment.