1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-15 04:55:22 +02:00

[226969][cleanup] Use {@inheritDoc} rather than duplicating comment

This commit is contained in:
Martin Oberhuber 2008-04-18 09:19:53 +00:00
parent 7b9b88c272
commit a2d40ccafa
4 changed files with 33 additions and 40 deletions

View file

@ -158,8 +158,7 @@ public abstract class AbstractRSESystemType extends PlatformObject implements IR
} }
/** /**
* Tests whether the system type is currently enabled. * {@inheritDoc}
*
* @see IRSESystemType#isEnabled() * @see IRSESystemType#isEnabled()
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */

View file

@ -478,9 +478,7 @@ public abstract class AbstractConnectorService extends RSEModelObject implements
} }
/** /**
* Sets the attribute for this connector service instance that denies a * {@inheritDoc}
* password to be saved.
*
* @see IConnectorService#setDenyPasswordSave(boolean) * @see IConnectorService#setDenyPasswordSave(boolean)
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */
@ -493,10 +491,7 @@ public abstract class AbstractConnectorService extends RSEModelObject implements
} }
/** /**
* Retrieves the value of the "DENY_PASSWORD_SAVE" property of this * {@inheritDoc}
* connector service.
*
* @return <code>true</code> if password saving is denied.
* @see IConnectorService#getDenyPasswordSave() * @see IConnectorService#getDenyPasswordSave()
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */

View file

@ -786,10 +786,7 @@ public abstract class AbstractDelegatingConnectorService implements IDelegatingC
} }
/** /**
* Sets the attribute for this connector service instance that denies a * {@inheritDoc}
* password to be saved.
*
* @see IConnectorService#setDenyPasswordSave(boolean)
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */
public int setDenyPasswordSave(boolean deny) { public int setDenyPasswordSave(boolean deny) {
@ -802,11 +799,7 @@ public abstract class AbstractDelegatingConnectorService implements IDelegatingC
} }
/** /**
* Retrieves the value of the "DENY_PASSWORD_SAVE" property of this * {@inheritDoc}
* connector service. If the value has never been set, this will return
* false.
*
* @return true if password saving is denied.
* @since org.eclipse.rse.core 3.0 * @since org.eclipse.rse.core 3.0
*/ */
public boolean getDenyPasswordSave() { public boolean getDenyPasswordSave() {

View file

@ -85,21 +85,26 @@ public interface IConnectorService extends IRSEModelObject {
public boolean isConnected(); public boolean isConnected();
/** /**
* Connects to the remote system. * Connect to the remote system.
* @param monitor a monitor for tracking the progress and canceling a connect *
* operation. * @param monitor a monitor for tracking the progress and canceling a
* @throws Exception an exception of there is a failure to connect. * connect operation.
* Typically, this will be a {@link SystemMessageException}. * @throws OperationCanceledException if the connect was cancelled by the
* @since 3.0 throws an {@link OperationCanceledException} if the connect was cancelled by the user * user
* @throws Exception if there is a failure connecting. Typically, this will
* be a {@link SystemMessageException}.
* @since org.eclipse.rse.core 3.0 throws OperationCanceledException instead
* of InterruptedException
*/ */
public void connect(IProgressMonitor monitor) throws Exception; public void connect(IProgressMonitor monitor) throws Exception;
/** /**
* Disconnects from the remote system. * Disconnect from the remote system.
* @param monitor a monitor for tracking the progress and canceling a disconnect *
* operation. * @param monitor a monitor for tracking the progress and canceling a
* @throws Exception an exception of the disconnect fails. * disconnect operation.
* Typically, this will be a {@link SystemMessageException}. * @throws Exception an exception of the disconnect fails. Typically, this
* will be a {@link SystemMessageException}.
*/ */
public void disconnect(IProgressMonitor monitor) throws Exception; public void disconnect(IProgressMonitor monitor) throws Exception;
@ -270,18 +275,19 @@ public interface IConnectorService extends IRSEModelObject {
public void clearCredentials(); public void clearCredentials();
/** /**
* Acquire the credentials for this connector service. * Acquire the credentials for this connector service. Acquisition may be
* Acquisition may be temporarily suppressed * temporarily suppressed by using the {@link #setSuppressed(boolean)}.
* by using the {@link #setSuppressed(boolean)}.
* <p> * <p>
* Implementations may retain a remembered credentials or * Implementations may retain a remembered credentials or use this to
* use this to acquire the credentials using some implementation defined means. * acquire the credentials using some implementation defined means.
* <p> * <p>
* Throws {@link OperationCanceledException} if acquisition of the *
* credentials is cancelled or is being suppressed. * @param refresh if true will force the connector service to discard any
* @param refresh if true will force the connector service to discard * remembered value and reacquire the credentials.
* any remembered value and reacquire the credentials. * @throws OperationCanceledException if acquisition of the credentials is
* @since 3.0 throws OperationCanceledException instead of InterruptedException * cancelled or is being suppressed.
* @since org.eclipse.rse.core 3.0 throws OperationCanceledException instead
* of InterruptedException
*/ */
public void acquireCredentials(boolean refresh) throws OperationCanceledException; public void acquireCredentials(boolean refresh) throws OperationCanceledException;
@ -395,7 +401,7 @@ public interface IConnectorService extends IRSEModelObject {
* false. If set to true, it will clear any saved passwords for this system * false. If set to true, it will clear any saved passwords for this system
* and not allow any further passwords to be stored. This property of a * and not allow any further passwords to be stored. This property of a
* system is persistent from session to session, but is not sharable. * system is persistent from session to session, but is not sharable.
* *
* @param deny If true, forget any saved passwords and do not allow any * @param deny If true, forget any saved passwords and do not allow any
* others to be saved. If false, allow passwords to be saved in * others to be saved. If false, allow passwords to be saved in
* the keyring. * the keyring.