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

[cleanup] Fix Javadoc

Browse source
This commit is contained in:
Martin Oberhuber 2008-05-05 13:56:50 +00:00
parent 70335f5e8d
commit 5b15779ff6
3 changed files with 56 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/SystemAbstractAPIProvider.java
View file

@ -64,7 +64,9 @@ public abstract class SystemAbstractAPIProvider
*/ */
protected SystemMessageObject nullObject = null; 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 * @deprecated don't use this field
*/ */
protected SystemMessageObject cancelledObject = null; 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); errorObject = new SystemMessageObject(RSEUIPlugin.getPluginMessage(ISystemMessages.MSG_EXPAND_FAILED),ISystemMessageObject.MSGTYPE_ERROR, null);
} }
/** /**
* <i>Callable by subclasses. Do not override.</i><br>
* In getChildren, return <samp>checkForEmptyList(children, parent, * In getChildren, return <samp>checkForEmptyList(children, parent,
* true/false)</samp> versus your array directly. This method checks for a * true/false)</samp> versus your array directly. This method checks for a
* null array which is not allowed and replaces it with an empty array. If * 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 * true is passed then it returns the "Empty list" message object if the
* array is null or empty * array is null or empty.
* <p>
* <i>Callable by subclasses. Do not override.</i> <br>
* *
* @param children The list of children. * @param children The list of children.
* @param parent The parent for the children. * @param parent The parent for the children.
* @param returnNullMsg <code>true</code> if an "Empty List" message * @param returnNullMsg <code>true</code> if an "Empty List" message should
* should be returned. * be returned.
* @return The list of children, a list with the "Empty List" message object * @return The list of children, a list with the "Empty List" message object
* or an empty list. * or an empty list.
* @noextend This method is not intended to be extended by clients. * @nooverride This method is not intended to be re-implemented or extended
* by clients.
*/ */
protected Object[] checkForEmptyList(Object[] children, Object parent, boolean returnNullMsg) { protected Object[] checkForEmptyList(Object[] children, Object parent, boolean returnNullMsg) {
if ((children == null) || (children.length == 0)) { if ((children == null) || (children.length == 0)) {

48
rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/core/subsystems/SubSystemConfiguration.java
View file

@ -480,10 +480,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
* Return vendor of this subsystem configuration. This comes from the xml * Return vendor of this subsystem configuration. This comes from the xml
* "vendor" attribute of the extension point. * "vendor" attribute of the extension point.
* *
* @noextend This method is not intended to be extended by clients. It will * @nooverride This method is not intended to be re-implemented or extended
* likely be declared <tt>final</tt> in the next release in * by clients. It will likely be declared <tt>final</tt> in the next
* order to ensure consistency with static xml markup in the * release in order to ensure consistency with static xml markup in the
* extension. * extension.
*/ */
public String getVendor() public String getVendor()
{ {
@ -494,10 +494,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
* Return name of this subsystem configuration. This comes from the xml * Return name of this subsystem configuration. This comes from the xml
* "name" attribute of the extension point. * "name" attribute of the extension point.
* *
* @noextend This method is not intended to be extended by clients. It will * @nooverride This method is not intended to be re-implemented or extended
* likely be declared <tt>final</tt> in the next release in * by clients. It will likely be declared <tt>final</tt> in the next
* order to ensure consistency with static xml markup in the * release in order to ensure consistency with static xml markup in the
* extension. * extension.
*/ */
public String getName() public String getName()
{ {
@ -508,10 +508,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
* Return name of this subsystem configuration. This comes from the xml * Return name of this subsystem configuration. This comes from the xml
* "description" attribute of the extension point. * "description" attribute of the extension point.
* *
* @noextend This method is not intended to be extended by clients. It will * @nooverride This method is not intended to be re-implemented or extended
* likely be declared <tt>final</tt> in the next release in * by clients. It will likely be declared <tt>final</tt> in the next
* order to ensure consistency with static xml markup in the * release in order to ensure consistency with static xml markup in the
* extension. * extension.
*/ */
public String getDescription() 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 * Return unique id of this subsystem configuration. This comes from the xml
* "id" attribute of the extension point. * "id" attribute of the extension point.
* *
* @noextend This method is not intended to be extended by clients. It will * @nooverride This method is not intended to be re-implemented or extended
* likely be declared <tt>final</tt> in the next release in * by clients. It will likely be declared <tt>final</tt> in the next
* order to ensure consistency with static xml markup in the * release in order to ensure consistency with static xml markup in the
* extension. * extension.
*/ */
public String getId() public String getId()
{ {
@ -538,10 +538,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
* *
* @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories * @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories
* *
* @noextend This method is not intended to be extended by clients. It will * @nooverride This method is not intended to be re-implemented or extended
* likely be declared <tt>final</tt> in the next release in * by clients. It will likely be declared <tt>final</tt> in the next
* order to ensure consistency with static xml markup in the * release in order to ensure consistency with static xml markup in the
* extension. * extension.
*/ */
public String getCategory() public String getCategory()
{ {
@ -554,10 +554,10 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
* <tt>org.eclipse.rse.core.subsystemConfigurations</tt> and * <tt>org.eclipse.rse.core.subsystemConfigurations</tt> and
* <tt>org.eclipse.rse.core.systemTypes</tt> extension points. * <tt>org.eclipse.rse.core.systemTypes</tt> extension points.
* *
* @noextend This method is not intended to be extended by clients. It will * @nooverride This method is not intended to be re-implemented or extended
* likely be declared <tt>final</tt> in the next release in * by clients. It will likely be declared <tt>final</tt> in the next
* order to ensure consistency with static xml markup in the * release in order to ensure consistency with static xml markup in the
* extension. * extension.
*/ */
public IRSESystemType[] getSystemTypes() public IRSESystemType[] getSystemTypes()
{ {

31
rse/plugins/org.eclipse.rse.ui/subsystems/org/eclipse/rse/ui/subsystems/StandardCredentialsProvider.java
View file

@ -158,22 +158,25 @@ public class StandardCredentialsProvider extends AbstractCredentialsProvider {
} }
/** /**
* @noimplement * Acquires the credentials (userid and password) for this connector
* Acquires the credentials (userid and password) for this connector service. * service. The search order for the password is as follows:
* The search order for the password is as follows:</p> * </p>
* <ol> * <ol>
* <li>First check if the password is already known by this * <li>First check if the password is already known by this connector
* connector service and that it is still valid. * service and that it is still valid.
* <li>If password not known then look in the password * <li>If password not known then look in the password store and verify that
* store and verify that it is still valid. * it is still valid.
* <li>If a valid password is not found or is to be reacquired * <li>If a valid password is not found or is to be re-acquired then prompt
* then prompt the user * the user
* </ol> * </ol>
* @param reacquire if true then present the prompt even *
* if the password was found and is valid. * @param reacquire if true then present the prompt even if the password was
* @throws OperationCanceledException if user is prompted and user * found and is valid.
* cancels that prompt or if {@link #isSuppressed()} is true. * @throws OperationCanceledException if user is prompted and user cancels
* @since 3.0 throws {@link OperationCanceledException} rather than {@link InterruptedException} * 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 { public final void acquireCredentials(boolean reacquire) throws OperationCanceledException {
if (isSuppressed()) { if (isSuppressed()) {