mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-20 06:35:50 +02:00
Code Issues Wiki Activity

[cleanup] fix javadoc

Browse source
This commit is contained in:
Martin Oberhuber 2007-02-19 09:17:10 +00:00
parent 6ed4f11856
commit 42a9ac446a
1 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
rse/plugins/org.eclipse.rse.ui/UI/org/eclipse/rse/ui/view/SubSystemConfigurationAdapter.java
View file

@ -179,7 +179,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <ul> * <ul>
* <li>The wizard pages must implement ISystemNewConnectionWizardPage, so as to fit into the wizard's framework * <li>The wizard pages must implement ISystemNewConnectionWizardPage, so as to fit into the wizard's framework
* <li>When the user successfully presses Finish, the createConnection method in the SystemRegistry will call * <li>When the user successfully presses Finish, the createConnection method in the SystemRegistry will call
* your {@link #createSubSystem(org.eclipse.rse.model.IHost,boolean, ISystemNewConnectionWizardPage[])} method to create the * your {@link SubSystemConfiguration#createSubSystem(org.eclipse.rse.core.model.IHost,boolean, ISystemNewConnectionWizardPage[])} method to create the
* your subsystem for the connection. The same pages you return here are passed back to you so you can * your subsystem for the connection. The same pages you return here are passed back to you so you can
* interrogate them for the user-entered data and use it when creating the default subsystem instance. * interrogate them for the user-entered data and use it when creating the default subsystem instance.
* </ul> * </ul>
@ -428,8 +428,8 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <p> * <p>
* If you wish to support more actions, override getAdditionalSubSystemActions to return a Vector * If you wish to support more actions, override getAdditionalSubSystemActions to return a Vector
* of IAction objects. * of IAction objects.
* @see #getSubSystemNewFilterPoolActions(ISubSystem, Shell) * @see #getSubSystemNewFilterPoolActions(ISubSystemConfiguration, ISubSystem, Shell)
* @see #getAdditionalSubSystemActions(ISubSystem, Shell) * @see #getAdditionalSubSystemActions(ISubSystemConfiguration, ISubSystem, Shell)
* @param selectedSubSystem the currently selected subsystem * @param selectedSubSystem the currently selected subsystem
* @param shell The Shell of the view where this action was launched from * @param shell The Shell of the view where this action was launched from
* @return array of IAction objects to contribute to the popup menu * @return array of IAction objects to contribute to the popup menu
@ -693,7 +693,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <p> * <p>
* By default, returns null. * By default, returns null.
* @return Vector of IAction objects. * @return Vector of IAction objects.
* @see #getSubSystemActions(ISubSystem,Shell) * @see #getSubSystemActions(ISubSystemConfiguration, ISubSystem, Shell)
*/ */
protected Vector getAdditionalSubSystemActions(ISubSystemConfiguration factory, ISubSystem selectedSubSystem, Shell shell) protected Vector getAdditionalSubSystemActions(ISubSystemConfiguration factory, ISubSystem selectedSubSystem, Shell shell)
{ {
@ -771,7 +771,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <p> * <p>
* Most actions are handled in this base, except if you have your own action for * Most actions are handled in this base, except if you have your own action for
* creating a new filter. In this case, <b>override getNewFilterAction()</b> * creating a new filter. In this case, <b>override getNewFilterAction()</b>
* To add additional actions, override {@link #getAdditionalFilterPoolActions(ISystemFilterPool selectedPool, Shell shell)}. * To add additional actions, override {@link #getAdditionalFilterPoolActions(ISubSystemConfiguration, ISystemFilterPool, Shell)}.
* *
* @param selectedPool the currently selected pool * @param selectedPool the currently selected pool
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
@ -824,10 +824,10 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* default supplied actions. * default supplied actions.
* <p> * <p>
* By default, this returns null. * By default, this returns null.
* @param pool the currently selected pool * @param selectedPool the currently selected pool
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
* @return Vector of IAction objects. * @return Vector of IAction objects.
* @see #getFilterPoolActions(ISystemFilterPool,Shell) * @see #getFilterPoolActions(ISubSystemConfiguration, ISystemFilterPool, Shell)
*/ */
protected Vector getAdditionalFilterPoolActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) protected Vector getAdditionalFilterPoolActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell)
{ {
@ -835,13 +835,13 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
} }
/** /**
* Overridable method to return the actions for creating a new filter in a filter pool. * Overridable method to return the actions for creating a new filter in a filter pool.
* By default returns one action created by calling {@link #getNewFilterPoolFilterAction(ISystemFilterPool, Shell)}. * By default returns one action created by calling {@link #getNewFilterPoolFilterAction(ISubSystemConfiguration, ISystemFilterPool, Shell)}.
* <p> * <p>
* If you have multiple actions for creating new filters, override this. * If you have multiple actions for creating new filters, override this.
* <p> * <p>
* If you have only a single action for creating new filters, override getNewFilterPoolFilterAction (without the 's'). * If you have only a single action for creating new filters, override getNewFilterPoolFilterAction (without the 's').
* <p> * <p>
* @param pool the currently selected pool * @param selectedPool the currently selected pool
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
*/ */
protected IAction[] getNewFilterPoolFilterActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) protected IAction[] getNewFilterPoolFilterActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell)
@ -858,7 +858,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <p> * <p>
* If you have only a single action for creating new filters, override this. * If you have only a single action for creating new filters, override this.
* <p> * <p>
* @param pool the currently selected pool * @param selectedPool the currently selected pool
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
*/ */
protected IAction getNewFilterPoolFilterAction(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) protected IAction getNewFilterPoolFilterAction(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell)
@ -871,7 +871,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
/** /**
* Overridable method to return the action for creating a new nested filter inside another filter. * Overridable method to return the action for creating a new nested filter inside another filter.
* By default returns getNewFilterPoolFilterAction(selectedFilter.getParentFilterPool(),shell). * By default returns getNewFilterPoolFilterAction(selectedFilter.getParentFilterPool(),shell).
* @param pool the currently selected pool * @param selectedFilter the currently selected filter
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
*/ */
protected IAction getNewNestedFilterAction(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell) protected IAction getNewNestedFilterAction(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell)
@ -906,7 +906,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* via a Properties page for filters. When this page is activated, this method is called * via a Properties page for filters. When this page is activated, this method is called
* to enable customization of the page, given the selected filter. * to enable customization of the page, given the selected filter.
* <p> * <p>
* By default, this method will call {@link #getChangeFilterAction(ISystemFilter, Shell)} to get * By default, this method will call {@link #getChangeFilterAction(ISubSystemConfiguration, ISystemFilter, Shell)} to get
* your change filter action, and will configure the given page from the dialog created by your * your change filter action, and will configure the given page from the dialog created by your
* change filter action. * change filter action.
* <p> * <p>
@ -966,7 +966,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* this method is called to enable customization of the page, given the selected filter string. * this method is called to enable customization of the page, given the selected filter string.
* *
* <p> * <p>
* By default, this method will call {@link #getChangeFilterAction(ISystemFilter, Shell)} to get * By default, this method will call {@link #getChangeFilterAction(ISubSystemConfiguration, ISystemFilter, Shell)} to get
* your change filter action, and will configure the given page from the dialog created by your * your change filter action, and will configure the given page from the dialog created by your
* change filter action. * change filter action.
* <p> * <p>
@ -1050,10 +1050,10 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* default supplied actions. * default supplied actions.
* <p> * <p>
* By default, this returns null. * By default, this returns null.
* @param pool the currently selected pool * @param selectedPool the currently selected pool
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
* @return Vector of IAction objects. * @return Vector of IAction objects.
* @see #getFilterPoolReferenceActions(ISystemFilterPoolReference,Shell) * @see #getFilterPoolReferenceActions(ISubSystemConfiguration, ISystemFilterPoolReference, Shell)
*/ */
protected Vector getAdditionalFilterPoolReferenceActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) protected Vector getAdditionalFilterPoolReferenceActions(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell)
{ {
@ -1062,7 +1062,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
/** /**
* Overridable method to return the action for removing a filter pool reference. * Overridable method to return the action for removing a filter pool reference.
* By default returns new SystemRemoveFilterPoolReferenceAction. * By default returns new SystemRemoveFilterPoolReferenceAction.
* @param pool the currently selected pool * @param selectedPool the currently selected pool
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
*/ */
protected IAction getRemoveFilterPoolReferenceAction(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell) protected IAction getRemoveFilterPoolReferenceAction(ISubSystemConfiguration factory, ISystemFilterPool selectedPool, Shell shell)
@ -1204,7 +1204,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <p> * <p>
* By default, this returns null. * By default, this returns null.
* @return Vector of IAction objects. * @return Vector of IAction objects.
* @see #getFilterActions(ISystemFilter,Shell) * @see #getFilterActions(ISubSystemConfiguration, ISystemFilter, Shell)
*/ */
protected Vector getAdditionalFilterActions(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell) protected Vector getAdditionalFilterActions(ISubSystemConfiguration factory, ISystemFilter selectedFilter, Shell shell)
{ {
@ -1224,7 +1224,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
* <p> * <p>
* Most actions are handled in this base, except if you have your own action for * Most actions are handled in this base, except if you have your own action for
* creating a new filter. In this case, <b>override getNewFilterAction()</b> * creating a new filter. In this case, <b>override getNewFilterAction()</b>
* To add additional actions, override {@link #getAdditionalFilterReferenceActions(ISystemFilterReference, Shell)}. * To add additional actions, override {@link #getAdditionalFilterReferenceActions(ISubSystemConfiguration, ISystemFilterReference, Shell)}.
* *
* @param selectedFilterRef the currently selected filter reference * @param selectedFilterRef the currently selected filter reference
* @param shell parent shell of viewer where the popup menu is being constructed * @param shell parent shell of viewer where the popup menu is being constructed
@ -1404,10 +1404,10 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
/** /**
* Return the form used in the property page, etc for this server launcher. * Return the form used in the property page, etc for this server launcher.
* Only called if {@link #supportsServerLaunchProperties()} returns true. * Only called if {@link ISubSystemConfiguration#supportsServerLaunchProperties(org.eclipse.rse.core.model.IHost)} returns true.
* <p> * <p>
* We return {@link org.eclipse.rse.ui.widgets.ServerLauncherForm}.
* Override if appropriate. * Override if appropriate.
* @return the UI form for the server launcher.
*/ */
public IServerLauncherForm getServerLauncherForm(ISubSystemConfiguration factory, Shell shell, ISystemMessageLine msgLine) public IServerLauncherForm getServerLauncherForm(ISubSystemConfiguration factory, Shell shell, ISystemMessageLine msgLine)
{ {