From 5b15779ff65b74c4625049b98c110a59c6e846b2 Mon Sep 17 00:00:00 2001 From: Martin Oberhuber < martin.oberhuber@windriver.com> Date: Mon, 5 May 2008 13:56:50 +0000 Subject: [PATCH] [cleanup] Fix Javadoc --- .../ui/view/SystemAbstractAPIProvider.java | 22 ++++---- .../subsystems/SubSystemConfiguration.java | 52 +++++++++---------- .../StandardCredentialsProvider.java | 31 ++++++----- 3 files changed, 56 insertions(+), 49 deletions(-) diff --git a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/SystemAbstractAPIProvider.java b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/SystemAbstractAPIProvider.java index ea7560fceef..30a3475d571 100644 --- a/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/SystemAbstractAPIProvider.java +++ b/rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/SystemAbstractAPIProvider.java @@ -39,7 +39,7 @@ import org.eclipse.rse.ui.RSEUIPlugin; * * This class existed in RSE 1.0, was made "internal" for RSE 2.0 and restored * as API for RSE 3.0. - * + * * @since 3.0 */ public abstract class SystemAbstractAPIProvider @@ -64,7 +64,9 @@ public abstract class SystemAbstractAPIProvider */ protected SystemMessageObject nullObject = null; /** - * @since org.eclipse.rse.ui 3.0 renamed from canceledObject + * This field was renamed from canceledObject in RSE 3.0. + * + * @since org.eclipse.rse.ui 3.0 * @deprecated don't use this field */ protected SystemMessageObject cancelledObject = null; @@ -119,21 +121,23 @@ public abstract class SystemAbstractAPIProvider errorObject = new SystemMessageObject(RSEUIPlugin.getPluginMessage(ISystemMessages.MSG_EXPAND_FAILED),ISystemMessageObject.MSGTYPE_ERROR, null); } - /** - * Callable by subclasses. Do not override.
+ /** * In getChildren, return checkForEmptyList(children, parent, * true/false) versus your array directly. This method checks for a * null array which is not allowed and replaces it with an empty array. If * true is passed then it returns the "Empty list" message object if the - * array is null or empty + * array is null or empty. + *

+ * Callable by subclasses. Do not override.
* * @param children The list of children. * @param parent The parent for the children. - * @param returnNullMsg true if an "Empty List" message - * should be returned. + * @param returnNullMsg true if an "Empty List" message should + * be returned. * @return The list of children, a list with the "Empty List" message object - * or an empty list. - * @noextend This method is not intended to be extended by clients. + * or an empty list. + * @nooverride This method is not intended to be re-implemented or extended + * by clients. */ protected Object[] checkForEmptyList(Object[] children, Object parent, boolean returnNullMsg) { if ((children == null) || (children.length == 0)) { diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java index 6e5b1e68588..563d8cc5cd6 100644 --- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java +++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java @@ -480,10 +480,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * Return vendor of this subsystem configuration. This comes from the xml * "vendor" attribute of the extension point. * - * @noextend This method is not intended to be extended by clients. It will - * likely be declared final in the next release in - * order to ensure consistency with static xml markup in the - * extension. + * @nooverride This method is not intended to be re-implemented or extended + * by clients. It will likely be declared final in the next + * release in order to ensure consistency with static xml markup in the + * extension. */ public String getVendor() { @@ -494,10 +494,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * Return name of this subsystem configuration. This comes from the xml * "name" attribute of the extension point. * - * @noextend This method is not intended to be extended by clients. It will - * likely be declared final in the next release in - * order to ensure consistency with static xml markup in the - * extension. + * @nooverride This method is not intended to be re-implemented or extended + * by clients. It will likely be declared final in the next + * release in order to ensure consistency with static xml markup in the + * extension. */ public String getName() { @@ -508,10 +508,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * Return name of this subsystem configuration. This comes from the xml * "description" attribute of the extension point. * - * @noextend This method is not intended to be extended by clients. It will - * likely be declared final in the next release in - * order to ensure consistency with static xml markup in the - * extension. + * @nooverride This method is not intended to be re-implemented or extended + * by clients. It will likely be declared final in the next + * release in order to ensure consistency with static xml markup in the + * extension. */ public String getDescription() { @@ -522,10 +522,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * Return unique id of this subsystem configuration. This comes from the xml * "id" attribute of the extension point. * - * @noextend This method is not intended to be extended by clients. It will - * likely be declared final in the next release in - * order to ensure consistency with static xml markup in the - * extension. + * @nooverride This method is not intended to be re-implemented or extended + * by clients. It will likely be declared final in the next + * release in order to ensure consistency with static xml markup in the + * extension. */ public String getId() { @@ -538,10 +538,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * * @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories * - * @noextend This method is not intended to be extended by clients. It will - * likely be declared final in the next release in - * order to ensure consistency with static xml markup in the - * extension. + * @nooverride This method is not intended to be re-implemented or extended + * by clients. It will likely be declared final in the next + * release in order to ensure consistency with static xml markup in the + * extension. */ public String getCategory() { @@ -553,11 +553,11 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * from static declaration in the * org.eclipse.rse.core.subsystemConfigurations and * org.eclipse.rse.core.systemTypes extension points. - * - * @noextend This method is not intended to be extended by clients. It will - * likely be declared final in the next release in - * order to ensure consistency with static xml markup in the - * extension. + * + * @nooverride This method is not intended to be re-implemented or extended + * by clients. It will likely be declared final in the next + * release in order to ensure consistency with static xml markup in the + * extension. */ public IRSESystemType[] getSystemTypes() { @@ -979,7 +979,7 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration * the subsystem. *

  • finally, saves the subsystem to disk. * - * + * * @param conn The connection to create a subsystem for * @param creatingConnection true if we are creating a connection, false if * just creating another subsystem for an existing connection. diff --git a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/ui/subsystems/StandardCredentialsProvider.java b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/ui/subsystems/StandardCredentialsProvider.java index 00ec58c1934..0466cd26071 100644 --- a/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/ui/subsystems/StandardCredentialsProvider.java +++ b/rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/ui/subsystems/StandardCredentialsProvider.java @@ -158,22 +158,25 @@ public class StandardCredentialsProvider extends AbstractCredentialsProvider { } /** - * @noimplement - * Acquires the credentials (userid and password) for this connector service. - * The search order for the password is as follows:

    + * Acquires the credentials (userid and password) for this connector + * service. The search order for the password is as follows: + *

    *
      - *
    1. First check if the password is already known by this - * connector service and that it is still valid. - *
    2. If password not known then look in the password - * store and verify that it is still valid. - *
    3. If a valid password is not found or is to be reacquired - * then prompt the user + *
    4. First check if the password is already known by this connector + * service and that it is still valid. + *
    5. If password not known then look in the password store and verify that + * it is still valid. + *
    6. If a valid password is not found or is to be re-acquired then prompt + * the user *
    - * @param reacquire if true then present the prompt even - * if the password was found and is valid. - * @throws OperationCanceledException if user is prompted and user - * cancels that prompt or if {@link #isSuppressed()} is true. - * @since 3.0 throws {@link OperationCanceledException} rather than {@link InterruptedException} + * + * @param reacquire if true then present the prompt even if the password was + * found and is valid. + * @throws OperationCanceledException if user is prompted and user cancels + * that prompt or if {@link #isSuppressed()} is true. Before RSE 3.0, + * the method would have thrown {@link InterruptedException} in that + * case. + * @since 3.0 */ public final void acquireCredentials(boolean reacquire) throws OperationCanceledException { if (isSuppressed()) {