diff options
author | Xavier Ducrohet <xav@android.com> | 2012-10-02 17:37:28 -0700 |
---|---|---|
committer | Xavier Ducrohet <xav@android.com> | 2012-10-02 17:37:28 -0700 |
commit | bdb9903224d688b264b6a9b4c7aa3fa8e0142996 (patch) | |
tree | 6f80d17a615c1798bda4b4925f1bc42e88d568f4 | |
parent | d19ce5efa561089937102f19a373ac5324311a03 (diff) | |
download | sdk-bdb9903224d688b264b6a9b4c7aa3fa8e0142996.zip sdk-bdb9903224d688b264b6a9b4c7aa3fa8e0142996.tar.gz sdk-bdb9903224d688b264b6a9b4c7aa3fa8e0142996.tar.bz2 |
Fix javadoc here and there.
Change-Id: If02d0b97c294d9821a1c914547782a08b1d256fb
22 files changed, 38 insertions, 68 deletions
diff --git a/common/src/com/android/utils/SdkUtils.java b/common/src/com/android/utils/SdkUtils.java index 9bf43dc..18d3ccd 100644 --- a/common/src/com/android/utils/SdkUtils.java +++ b/common/src/com/android/utils/SdkUtils.java @@ -128,8 +128,8 @@ public class SdkUtils { /** * Returns the default line separator to use. * <p> - * NOTE: If you have an associated {@link IDocument}, it is better to call - * {@link TextUtilities#getDefaultLineDelimiter(IDocument)} since that will + * NOTE: If you have an associated IDocument (Eclipse), it is better to call + * TextUtilities#getDefaultLineDelimiter(IDocument) since that will * allow (for example) editing a \r\n-delimited document on a \n-delimited * platform and keep a consistent usage of delimiters in the file. * diff --git a/common/src/com/android/utils/StdLogger.java b/common/src/com/android/utils/StdLogger.java index c0de06f..05eb456 100644 --- a/common/src/com/android/utils/StdLogger.java +++ b/common/src/com/android/utils/StdLogger.java @@ -103,7 +103,7 @@ public class StdLogger implements ILogger { * <p/> * This is displayed only if the logging {@link Level} is {@link Level#WARNING} or higher. * - * @param msgFormat is a string format to be used with a {@link Formatter}. Cannot be null. + * @param warningFormat is a string format to be used with a {@link Formatter}. Cannot be null. * @param args provides the arguments for warningFormat. */ @Override diff --git a/ddms/libs/ddmlib/src/com/android/ddmlib/IDevice.java b/ddms/libs/ddmlib/src/com/android/ddmlib/IDevice.java index d81aea9..452d032 100644 --- a/ddms/libs/ddmlib/src/com/android/ddmlib/IDevice.java +++ b/ddms/libs/ddmlib/src/com/android/ddmlib/IDevice.java @@ -351,7 +351,6 @@ public interface IDevice { * * @param localPort the local port to forward * @param remotePort the remote port. - * @return <code>true</code> if success. * @throws TimeoutException in case of timeout on the connection. * @throws AdbCommandRejectedException if adb rejects the command * @throws IOException in case of I/O error on the connection. @@ -365,7 +364,6 @@ public interface IDevice { * @param localPort the local port to forward * @param remoteSocketName name of the unix domain socket created on the device * @param namespace namespace in which the unix domain socket was created - * @return <code>true</code> if success. * @throws TimeoutException in case of timeout on the connection. * @throws AdbCommandRejectedException if adb rejects the command * @throws IOException in case of I/O error on the connection. @@ -379,7 +377,6 @@ public interface IDevice { * * @param localPort the local port to forward * @param remotePort the remote port. - * @return <code>true</code> if success. * @throws TimeoutException in case of timeout on the connection. * @throws AdbCommandRejectedException if adb rejects the command * @throws IOException in case of I/O error on the connection. @@ -393,7 +390,6 @@ public interface IDevice { * @param localPort the local port to forward * @param remoteSocketName the remote unix domain socket name. * @param namespace namespace in which the unix domain socket was created - * @return <code>true</code> if success. * @throws TimeoutException in case of timeout on the connection. * @throws AdbCommandRejectedException if adb rejects the command * @throws IOException in case of I/O error on the connection. diff --git a/ddms/libs/ddmlib/src/com/android/ddmlib/NativeAllocationInfo.java b/ddms/libs/ddmlib/src/com/android/ddmlib/NativeAllocationInfo.java index 385ce0d..9b104ba 100644 --- a/ddms/libs/ddmlib/src/com/android/ddmlib/NativeAllocationInfo.java +++ b/ddms/libs/ddmlib/src/com/android/ddmlib/NativeAllocationInfo.java @@ -18,7 +18,6 @@ package com.android.ddmlib; import java.util.ArrayList; import java.util.Arrays; -import java.util.Iterator; import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; @@ -146,7 +145,7 @@ public final class NativeAllocationInfo { * Returns the resolved stack call. * @return An array of {@link NativeStackCallInfo} or <code>null</code> if the stack call * was not resolved. - * @see #setResolvedStackCall(ArrayList) + * @see #setResolvedStackCall(List) * @see #isStackCallResolved() */ public synchronized List<NativeStackCallInfo> getResolvedStackCall() { @@ -263,7 +262,7 @@ public final class NativeAllocationInfo { * lower level of the libc, but the actual method that performed the allocation. * @return a <code>NativeStackCallInfo</code> or <code>null</code> if the stack call has not * been processed from the raw addresses. - * @see #setResolvedStackCall(ArrayList) + * @see #setResolvedStackCall(List) * @see #isStackCallResolved() */ public synchronized NativeStackCallInfo getRelevantStackCallInfo() { diff --git a/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/IRemoteAndroidTestRunner.java b/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/IRemoteAndroidTestRunner.java index 7606d69..7d3d6bf 100644 --- a/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/IRemoteAndroidTestRunner.java +++ b/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/IRemoteAndroidTestRunner.java @@ -16,8 +16,8 @@ package com.android.ddmlib.testrunner; -import com.android.ddmlib.IDevice; import com.android.ddmlib.AdbCommandRejectedException; +import com.android.ddmlib.IDevice; import com.android.ddmlib.ShellCommandUnresponsiveException; import com.android.ddmlib.TimeoutException; @@ -181,7 +181,7 @@ public interface IRemoteAndroidTestRunner { * <p/> * By default no timeout will be specified. * - * @see {@link IDevice#executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, int)} + * @see IDevice#executeShellCommand(String, com.android.ddmlib.IShellOutputReceiver, int) */ public void setMaxtimeToOutputResponse(int maxTimeToOutputResponse); diff --git a/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/ITestRunListener.java b/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/ITestRunListener.java index a8b117d..7e20c9f 100644 --- a/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/ITestRunListener.java +++ b/ddms/libs/ddmlib/src/com/android/ddmlib/testrunner/ITestRunListener.java @@ -21,7 +21,7 @@ import java.util.Map; /** * Receives event notifications during instrumentation test runs. * <p/> - * Patterned after {@link junit.runner.TestRunListener}. + * Patterned after junit.runner.TestRunListener. * <p/> * The sequence of calls will be: * <ul> diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java b/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java index f14255f..a8f269f 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/DeclareStyleableResourceValue.java @@ -27,7 +27,7 @@ import java.util.Map; * {@link #getValue()} will return null, instead use {@link #getAttributeValues(String)} to * get the enum/flag value associated with an attribute defined in the declare-styleable. * - * @Deprecated This class is broken as it does not handle the namespace for each attribute. + * @deprecated This class is broken as it does not handle the namespace for each attribute. * Thankfully, newer versions of layoutlib don't actually use it, so we just keep it as is for * backward compatibility on older layoutlibs. * diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java b/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java index 766b3be..346d67d 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/DrawableParams.java @@ -37,16 +37,7 @@ public class DrawableParams extends RenderParams { * @param density the density factor for the screen. * @param xdpi the screen actual dpi in X * @param ydpi the screen actual dpi in Y - * @param themeName The name of the theme to use. - * @param isProjectTheme true if the theme is a project theme, false if it is a framework theme. - * @param projectResources the resources of the project. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the - * map contains (String, {@link ResourceValue}) pairs where the key is the resource name, - * and the value is the resource value. - * @param frameworkResources the framework resources. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the map - * contains (String, {@link ResourceValue}) pairs where the key is the resource name, and the - * value is the resource value. + * @param renderResources a {@link RenderResources} object providing access to the resources. * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param minSdkVersion the minSdkVersion of the project diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java b/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java index 574f9bb..9c0e97b 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/ILayoutPullParser.java @@ -20,7 +20,7 @@ import org.xmlpull.v1.XmlPullParser; /** * Extended version of {@link XmlPullParser} to use with - * {@link Bridge#createScene(SceneParams)} + * {@link Bridge#createSession(SessionParams)} */ public interface ILayoutPullParser extends XmlPullParser { diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java b/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java index 8ccdd75..a88b0d3 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/IProjectCallback.java @@ -126,7 +126,7 @@ public interface IProjectCallback { * of the same type. This is only valid if the adapter view is an ExpandableListView. * If there is only one type of items, this is the same as <var>fullParentPosition</var>. * @param viewRef The {@link ResourceReference} for the view we're trying to fill. - * @param ViewAttribute the attribute being queried. + * @param viewAttribute the attribute being queried. * @param defaultValue the default value for this attribute. The object class matches the * class associated with the {@link ViewAttribute}. * @return the item value or null if there's no value. diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java index 2cfe770..f89dcfe 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderParams.java @@ -60,16 +60,7 @@ public abstract class RenderParams { * @param density the density factor for the screen. * @param xdpi the screen actual dpi in X * @param ydpi the screen actual dpi in Y - * @param themeName The name of the theme to use. - * @param isProjectTheme true if the theme is a project theme, false if it is a framework theme. - * @param projectResources the resources of the project. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the - * map contains (String, {@link ResourceValue}) pairs where the key is the resource name, - * and the value is the resource value. - * @param frameworkResources the framework resources. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the map - * contains (String, {@link ResourceValue}) pairs where the key is the resource name, and the - * value is the resource value. + * @param renderResources a {@link RenderResources} object providing access to the resources. * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param minSdkVersion the minSdkVersion of the project diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java index f9e02d6..c362224 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderResources.java @@ -134,7 +134,7 @@ public class RenderResources { * @param attrName the name of the attribute to search for. * @return the {@link ResourceValue} object or <code>null</code> * - * @Deprecated Use {@link #findItemInStyle(StyleResourceValue, String, boolean)} since this + * @deprecated Use {@link #findItemInStyle(StyleResourceValue, String, boolean)} since this * method doesn't know the item namespace. */ @Deprecated diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java index 188909e..96caa6a 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/RenderSession.java @@ -27,7 +27,7 @@ import java.util.Map; /** * An object allowing interaction with an Android layout. * - * This is returned by {@link Bridge#createScene(RenderParams)}. + * This is returned by {@link Bridge#createSession(SessionParams)}. * and can then be used for subsequent actions on the layout. * * @since 5 @@ -94,7 +94,7 @@ public class RenderSession { /** * Re-renders the layout as-is. - * In case of success, this should be followed by calls to {@link #getRootView()} and + * In case of success, this should be followed by calls to {@link #getRootViews()} and * {@link #getImage()} to access the result of the rendering. * * This is equivalent to calling <code>render(SceneParams.DEFAULT_TIMEOUT)</code> @@ -107,7 +107,7 @@ public class RenderSession { /** * Re-renders the layout as-is, with a given timeout in case other renderings are being done. - * In case of success, this should be followed by calls to {@link #getRootView()} and + * In case of success, this should be followed by calls to {@link #getRootViews()} and * {@link #getImage()} to access the result of the rendering. * * The {@link Bridge} is only able to inflate or render one layout at a time. There diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java b/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java index 1af450e..a620b05 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/SessionParams.java @@ -67,16 +67,7 @@ public class SessionParams extends RenderParams { * @param density the density factor for the screen. * @param xdpi the screen actual dpi in X * @param ydpi the screen actual dpi in Y - * @param themeName The name of the theme to use. - * @param isProjectTheme true if the theme is a project theme, false if it is a framework theme. - * @param projectResources the resources of the project. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the - * map contains (String, {@link ResourceValue}) pairs where the key is the resource name, - * and the value is the resource value. - * @param frameworkResources the framework resources. The map contains (String, map) pairs - * where the string is the type of the resource reference used in the layout file, and the map - * contains (String, {@link ResourceValue}) pairs where the key is the resource name, and the - * value is the resource value. + * @param renderResources a {@link RenderResources} object providing access to the resources. * @param projectCallback The {@link IProjectCallback} object to get information from * the project. * @param minSdkVersion the minSdkVersion of the project diff --git a/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java b/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java index 2671fc0..d859e95 100644 --- a/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java +++ b/layoutlib_api/src/com/android/ide/common/rendering/api/ViewInfo.java @@ -88,7 +88,7 @@ public class ViewInfo { /** * Returns the cookie associated with the XML node. Can be null. * - * @see ILayoutPullParser#getViewKey() + * @see ILayoutPullParser#getViewCookie() */ public Object getCookie() { return mCookie; @@ -131,8 +131,8 @@ public class ViewInfo { /** * Returns the actual android.view.View (or child class) object. This can be used - * to query the object properties that are not in the XML and not in the map returned - * by {@link #getDefaultPropertyValues()}. + * to query the object properties that are not in the XML and not available through + * {@link RenderSession#getProperty(Object, String)}. */ public Object getViewObject() { return mViewObject; @@ -140,8 +140,8 @@ public class ViewInfo { /** * Returns the actual android.view.ViewGroup$LayoutParams (or child class) object. - * This can be used to query the object properties that are not in the XML and not in - * the map returned by {@link #getDefaultPropertyValues()}. + * This can be used to query the object properties that are not in the XML and not available + * through {@link RenderSession#getProperty(Object, String)}. */ public Object getLayoutParamsObject() { return mLayoutParamsObject; diff --git a/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java b/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java index 56d2e36..f849cdd 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java +++ b/layoutlib_api/src/com/android/layoutlib/api/ILayoutBridge.java @@ -104,7 +104,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link Bridge#createScene(SceneParams)} + * @deprecated use {@link Bridge#createSession(com.android.ide.common.rendering.api.SessionParams)} * @since 4 */ @Deprecated @@ -141,7 +141,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link Bridge#createScene(SceneParams)} + * @deprecated use {@link Bridge#createSession(com.android.ide.common.rendering.api.SessionParams)} * @since 3 */ @Deprecated @@ -174,7 +174,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link Bridge#createScene(SceneParams)} + * @deprecated use {@link Bridge#createSession(com.android.ide.common.rendering.api.SessionParams)} * @since 2 */ @Deprecated @@ -206,7 +206,7 @@ public interface ILayoutBridge { * the project. * @param logger the object responsible for displaying warning/errors to the user. * @return a new {@link ILayoutResult} object that contains the result of the layout. - * @deprecated use {@link Bridge#createScene(SceneParams)} + * @deprecated use {@link Bridge#createSession(com.android.ide.common.rendering.api.SessionParams)} * @since 1 */ @Deprecated diff --git a/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java b/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java index 46255c4..6aeaf9f 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java +++ b/layoutlib_api/src/com/android/layoutlib/api/ILayoutResult.java @@ -25,8 +25,9 @@ import java.awt.image.BufferedImage; * The result of a layout computation through {@link ILayoutBridge}. * * @since 1 - * @deprecated use {@link RenderSession} as returned by {@link Bridge#createScene(SceneParams)} + * @deprecated use {@link RenderSession} as returned by {@link Bridge#createSession(com.android.ide.common.rendering.api.SessionParams)} */ +@Deprecated public interface ILayoutResult { /** * Success return code @@ -66,6 +67,7 @@ public interface ILayoutResult { * Layout information for a specific view. * @deprecated */ + @Deprecated public interface ILayoutViewInfo { /** diff --git a/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java b/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java index b4d10a2..e0a98a6 100644 --- a/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java +++ b/layoutlib_api/src/com/android/layoutlib/api/IXmlPullParser.java @@ -21,12 +21,14 @@ import org.xmlpull.v1.XmlPullParser; /** * @deprecated */ +@Deprecated public interface IXmlPullParser extends XmlPullParser { /** * Returns a key for the current XML node. - * <p/>This key will be passed back in the {@link ViewInfo} objects, allowing association - * of a particular XML node with its result from the layout computation. + * <p/>This key will be passed back in the {@link com.android.ide.common.rendering.api.ViewInfo} + * objects, allowing association of a particular XML node with its result from the + * layout computation. */ Object getViewKey(); } diff --git a/layoutlib_api/src/com/android/util/Pair.java b/layoutlib_api/src/com/android/util/Pair.java index 3818107..7e797e0 100644 --- a/layoutlib_api/src/com/android/util/Pair.java +++ b/layoutlib_api/src/com/android/util/Pair.java @@ -33,7 +33,7 @@ package com.android.util; * @param <S> The type of the first value * @param <T> The type of the second value * - * @Deprecated This is used for backward compatibility with layoutlib_api. Use com.android.utils.Pair instead + * @deprecated This is used for backward compatibility with layoutlib_api. Use com.android.utils.Pair instead */ @Deprecated public class Pair<S,T> { diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/devices/DeviceWriter.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/devices/DeviceWriter.java index feed6d4..d80f91e 100644 --- a/sdkmanager/libs/sdklib/src/com/android/sdklib/devices/DeviceWriter.java +++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/devices/DeviceWriter.java @@ -47,7 +47,7 @@ public class DeviceWriter { /** * Writes the XML definition of the given {@link Collection} of {@link Device}s according to - * {@value SdkConstants#NS_DEVICES_XSD} to the {@link OutputStream}. + * {@link SdkConstants#NS_DEVICES_XSD} to the {@link OutputStream}. * Note that it is up to the caller to close the {@link OutputStream}. * @param out The {@link OutputStream} to write the resulting XML to. * @param devices The {@link Device}s from which to generate the XML. diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java index 8a201d2..1fdea64 100644 --- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java +++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/project/ProjectCreator.java @@ -50,8 +50,6 @@ import javax.xml.xpath.XPathFactory; /** * Creates the basic files needed to get an Android project up and running. - * - * @hide */ public class ProjectCreator { diff --git a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/IDescription.java b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/IDescription.java index 5662a9c..7226360 100755 --- a/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/IDescription.java +++ b/sdkmanager/libs/sdklib/src/com/android/sdklib/internal/repository/IDescription.java @@ -25,7 +25,7 @@ public interface IDescription { * Returns a description of the given element. Cannot be null. * <p/> * A description is a multi-line of text, typically much more - * elaborate than what {@link #toString()} would provide. + * elaborate than what {@link Object#toString()} would provide. */ public abstract String getShortDescription(); @@ -33,7 +33,7 @@ public interface IDescription { * Returns a description of the given element. Cannot be null. * <p/> * A description is a multi-line of text, typically much more - * elaborate than what {@link #toString()} would provide. + * elaborate than what {@link Object#toString()} would provide. */ public abstract String getLongDescription(); |