mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-04 07:35:24 +02:00
Code Issues Wiki Activity

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

Browse source
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
Show stats Download patch file Download diff file Expand all files Collapse all files

3
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/AbstractRSESystemType.java
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()
* @since org.eclipse.rse.core 3.0
*/

9
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractConnectorService.java
View file

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

11
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/AbstractDelegatingConnectorService.java
View file

@ -786,10 +786,7 @@ public abstract class AbstractDelegatingConnectorService implements IDelegatingC
}
/**
* Sets the attribute for this connector service instance that denies a
* password to be saved.
*
* @see IConnectorService#setDenyPasswordSave(boolean)
* {@inheritDoc}
* @since org.eclipse.rse.core 3.0
*/
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
* connector service. If the value has never been set, this will return
* false.
*
* @return true if password saving is denied.
* {@inheritDoc}
* @since org.eclipse.rse.core 3.0
*/
public boolean getDenyPasswordSave() {

50
rse/plugins/org.eclipse.rse.core/src/org/eclipse/rse/core/subsystems/IConnectorService.java
View file

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