mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-04 23:05:47 +02:00
[releng][cleanup] Fix @since tags according to API Tooling
This commit is contained in:
Martin Oberhuber
parent
47465ec4e0
commit
e71b4c784d
24 changed files with 794 additions and 716 deletions
|
|
@ -38,7 +38,7 @@ public class SafeTreeViewer extends TreeViewer {
|
|||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param parent The parant control.
|
||||
* @param parent The parent control.
|
||||
*/
|
||||
public SafeTreeViewer(Composite parent) {
|
||||
super(parent);
|
||||
|
|
|
|||
|
|
@ -164,10 +164,9 @@ public interface ISystemMessages
|
|||
// --------------------------
|
||||
// UNIVERSAL FILE MESSAGES...
|
||||
// --------------------------
|
||||
/** @since 3.0 */
|
||||
public static final String FILEMSG_RENAME_INTERRUPTED = "RSEG1246"; //$NON-NLS-1$
|
||||
/**
|
||||
* @since 3.0
|
||||
*/
|
||||
/** @since 3.0 */
|
||||
public static final String FILEMSG_DELETE_INTERRUPTED = "RSEG1247"; //$NON-NLS-1$
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -19,8 +19,10 @@ package org.eclipse.rse.ui;
|
|||
import org.eclipse.ui.model.WorkbenchAdapter;
|
||||
|
||||
/**
|
||||
* Abstract base class with basic implementations of the <code>IRSEAdapter</code> interface.
|
||||
* Intended to be subclassed.
|
||||
* Abstract base class with basic implementations of the
|
||||
* <code>IRSEAdapter</code> interface. Intended to be subclassed.
|
||||
*
|
||||
* @since org.eclipse.rse.ui 3.0
|
||||
*/
|
||||
public abstract class RSEAdapter extends WorkbenchAdapter implements IRSEAdapter {
|
||||
|
||||
|
|
|
|||
|
|
@ -413,9 +413,11 @@ public class RSEUIPlugin extends SystemBasePlugin
|
|||
}
|
||||
|
||||
/**
|
||||
* For fastpath access to our adapters for non-local objects in our model.
|
||||
* Exploits the knowledge we use singleton adapters.
|
||||
*/
|
||||
* For fastpath access to our adapters for non-local objects in our model.
|
||||
* Exploits the knowledge we use singleton adapters.
|
||||
*
|
||||
* @since 3.0 returning IAdapterFactory rather than SystemViewAdapterFactory
|
||||
*/
|
||||
public IAdapterFactory getSystemViewAdapterFactory()
|
||||
{
|
||||
return svaf;
|
||||
|
|
|
|||
|
|
@ -22,6 +22,9 @@ public class DisplayHidableSystemMessageAction extends
|
|||
{
|
||||
protected IPreferenceStore _store;
|
||||
protected String _prefID;
|
||||
/**
|
||||
* @since 3.0
|
||||
*/
|
||||
protected boolean _showYesNo = true;
|
||||
|
||||
public DisplayHidableSystemMessageAction(SystemMessage message, IPreferenceStore prefStore, String prefID)
|
||||
|
|
@ -31,6 +34,9 @@ public class DisplayHidableSystemMessageAction extends
|
|||
_prefID = prefID;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 3.0
|
||||
*/
|
||||
public DisplayHidableSystemMessageAction(SystemMessage message, IPreferenceStore prefStore, String prefID, boolean showYesNo)
|
||||
{
|
||||
super(message);
|
||||
|
|
|
|||
|
|
@ -277,6 +277,7 @@ public abstract class SystemBaseCopyAction extends SystemBaseDialogAction
|
|||
/**
|
||||
* Called after all the copy/move operations end, be it successfully or not.
|
||||
* Your opportunity to display completion or do post-copy selections/refreshes
|
||||
* @since 3.0 taking String argument
|
||||
*/
|
||||
public void copyComplete(String operation) {}
|
||||
|
||||
|
|
|
|||
|
|
@ -265,10 +265,14 @@ public abstract class SystemBaseSubMenuAction
|
|||
|
||||
|
||||
|
||||
/**
|
||||
* Overridable method that instantiates the menu listener who job is to add mnemonics.
|
||||
* @param setMnemonicsOnlyOnce true if the menu is static and so mnemonics need only be set once. False if it is dynamic
|
||||
*/
|
||||
/**
|
||||
* Overridable method that instantiates the menu listener who job is to add
|
||||
* mnemonics.
|
||||
*
|
||||
* @param setMnemonicsOnlyOnce true if the menu is static and so mnemonics
|
||||
* need only be set once. False if it is dynamic
|
||||
* @since 3.0 replaced SystemViewMenuListener by ISystemViewMenuListener
|
||||
*/
|
||||
protected ISystemViewMenuListener createMnemonicsListener(boolean setMnemonicsOnlyOnce)
|
||||
{
|
||||
return new SystemViewMenuListener(setMnemonicsOnlyOnce);
|
||||
|
|
|
|||
|
|
@ -46,7 +46,10 @@ public abstract class SystemRemoteResourceDialog extends SystemPromptDialog
|
|||
private SystemActionViewerFilter _customViewerFilter;
|
||||
private String _message, _tip;
|
||||
|
||||
|
||||
/**
|
||||
* @since 3.0 replaced SystemResourceSelectionInputProvider by
|
||||
* ISystemResourceSelectionInputProvider
|
||||
*/
|
||||
public SystemRemoteResourceDialog(Shell shell, String title,
|
||||
ISystemResourceSelectionInputProvider inputProvider)
|
||||
{
|
||||
|
|
@ -255,6 +258,7 @@ public abstract class SystemRemoteResourceDialog extends SystemPromptDialog
|
|||
return closeDialog;
|
||||
}
|
||||
|
||||
/** @since 3.0 */
|
||||
public void setShowNewConnectionPrompt(boolean showNewConnectionPrompt)
|
||||
{
|
||||
_inputProvider.setAllowNewConnection(showNewConnectionPrompt);
|
||||
|
|
@ -281,7 +285,9 @@ public abstract class SystemRemoteResourceDialog extends SystemPromptDialog
|
|||
|
||||
/**
|
||||
* Returns the system tree
|
||||
*
|
||||
* @return the system tree
|
||||
* @since 3.0
|
||||
*/
|
||||
public ISystemTree getSystemTree()
|
||||
{
|
||||
|
|
@ -290,7 +296,9 @@ public abstract class SystemRemoteResourceDialog extends SystemPromptDialog
|
|||
|
||||
/**
|
||||
* Indicates whether the page for the form is complete or not.
|
||||
*
|
||||
* @return true if the page associated with the form is complete
|
||||
* @since 3.0
|
||||
*/
|
||||
public boolean isPageComplete()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -146,13 +146,20 @@ public class SystemRenameSingleDialog extends SystemPromptDialog
|
|||
|
||||
}
|
||||
/**
|
||||
* Constructor with an input object and validator
|
||||
* This constructor is in copy/move dialogs when there is a collision
|
||||
* Constructor with an input object and validator This constructor is in
|
||||
* copy/move dialogs when there is a collision
|
||||
*
|
||||
* @param shell The parent dialog
|
||||
* @param copyCollisionMode true if this is being called because of a name collision on a copy or move operation
|
||||
* @param inputObject The object that is being renamed, or on a copy/move the object in the target container which already exists. Used to get the old name and the name validator
|
||||
* @param nameValidator The name validator to use. Can be null, in which case it is queried from the adapter of the input object
|
||||
* @param nameInUse the List of names that have been previously selected for other files that are to be renamed for multiple file renaming.
|
||||
* @param copyCollisionMode true if this is being called because of a name
|
||||
* collision on a copy or move operation
|
||||
* @param inputObject The object that is being renamed, or on a copy/move
|
||||
* the object in the target container which already exists. Used
|
||||
* to get the old name and the name validator
|
||||
* @param nameValidator The name validator to use. Can be null, in which
|
||||
* case it is queried from the adapter of the input object
|
||||
* @param nameInUse the List of names that have been previously selected for
|
||||
* other files that are to be renamed for multiple file renaming.
|
||||
* @since 3.0 added nameInUse argument
|
||||
*/
|
||||
public SystemRenameSingleDialog(Shell shell, boolean copyCollisionMode, Object inputObject, ISystemValidator nameValidator, List nameInUse)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -95,10 +95,13 @@ public class SystemSelectAnythingDialog extends SystemPromptDialog
|
|||
_selected = selection.getFirstElement();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Use this method to limit the objects that are seen in the view of this dialog.
|
||||
* Use this method to limit the objects that are seen in the view of this
|
||||
* dialog.
|
||||
*
|
||||
* @param filter the filter that limits the visible objects
|
||||
* @since 3.0
|
||||
*/
|
||||
public void setViewerFilter(SystemActionViewerFilter filter)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -21,6 +21,8 @@ import org.eclipse.rse.ui.wizards.ISystemWizard;
|
|||
|
||||
/**
|
||||
* An interface for filter pool wizards to implement
|
||||
*
|
||||
* @since 3.0 moved from "internal" to API
|
||||
*/
|
||||
public interface SystemFilterPoolWizardInterface
|
||||
extends ISystemWizard, SystemFilterPoolDialogInterface
|
||||
|
|
|
|||
|
|
@ -327,8 +327,12 @@ public class SystemNewFilterWizard
|
|||
return mainPage;
|
||||
}
|
||||
/**
|
||||
* By default, this page uses the wizard page title as set in setWizardPageTitle(...) or the constructor.
|
||||
* @return the wizard page prompting for the filter name and parent filter pool
|
||||
* By default, this page uses the wizard page title as set in
|
||||
* setWizardPageTitle(...) or the constructor.
|
||||
*
|
||||
* @return the wizard page prompting for the filter name and parent filter
|
||||
* pool
|
||||
* @since 3.0 moved SystemNewFilterWizardNamePage from internal to API
|
||||
*/
|
||||
protected SystemNewFilterWizardNamePage createNamePage()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ import org.eclipse.swt.widgets.Text;
|
|||
|
||||
/**
|
||||
* Second page of the New Filter wizard that prompts for the name of the filter.
|
||||
*
|
||||
* @since 3.0 moved from internal to API
|
||||
*/
|
||||
public class SystemNewFilterWizardNamePage
|
||||
extends AbstractSystemWizardPage
|
||||
|
|
|
|||
|
|
@ -62,6 +62,10 @@ public abstract class ServicesPropertyPage extends SystemBasePropertyPage
|
|||
_form.init(_rootElement);
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 3.0 returning ISubSystem rather than IServiceSubSystem
|
||||
* @return
|
||||
*/
|
||||
protected ISubSystem getServiceSubSystem()
|
||||
{
|
||||
return (ISubSystem)getElement();
|
||||
|
|
|
|||
|
|
@ -17,6 +17,9 @@ package org.eclipse.rse.ui.view;
|
|||
import org.eclipse.ui.IEditorPart;
|
||||
import org.eclipse.ui.IWorkbenchPage;
|
||||
|
||||
/**
|
||||
* @since 3.0
|
||||
*/
|
||||
public interface IViewLinker {
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -193,6 +193,8 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
|
|||
* interrogate them for the user-entered data and use it when creating the default subsystem instance.
|
||||
* </ul>
|
||||
* Tip: consider extending {@link org.eclipse.rse.ui.wizards.AbstractSystemNewConnectionWizardPage} for your wizard page class.
|
||||
*
|
||||
* @since 3.0 ISystemNewConnectionWizardPage moved from Core to UI
|
||||
*/
|
||||
public ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(ISubSystemConfiguration config, IWizard wizard)
|
||||
{
|
||||
|
|
@ -612,6 +614,7 @@ public class SubSystemConfigurationAdapter implements ISubSystemConfigurationAda
|
|||
/**
|
||||
* Overridable entry for child classes to supply their own flavour of ISystemFilterPoolWrapperInformation for
|
||||
* the new filter wizards.
|
||||
* @since 3.0 replaced SystemFilterPoolWrapperInformation by ISystemFilterPoolWrapperInformation
|
||||
*/
|
||||
protected ISystemFilterPoolWrapperInformation getNewFilterWizardPoolWrapperInformation()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -366,6 +366,10 @@ public class SystemTableView
|
|||
_downI = RSEUIPlugin.getDefault().getImage(ISystemIconConstants.ICON_SYSTEM_ARROW_DOWN_ID);
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 3.0 Moved SystemTableViewProvider from internal to API
|
||||
* @return
|
||||
*/
|
||||
protected SystemTableViewProvider getProvider()
|
||||
{
|
||||
if (_provider == null)
|
||||
|
|
@ -495,6 +499,11 @@ public class SystemTableView
|
|||
return new IPropertyDescriptor[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 3.0 replaced SystemTableViewColumnManager by
|
||||
* ISystemTableViewColumnManager
|
||||
* @return
|
||||
*/
|
||||
public ISystemTableViewColumnManager getColumnManager()
|
||||
{
|
||||
return _columnManager;
|
||||
|
|
@ -1413,9 +1422,12 @@ public class SystemTableView
|
|||
return _refreshAction;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Rather than pre-defining this common action we wait until it is first needed,
|
||||
* for performance reasons.
|
||||
* Rather than pre-defining this common action we wait until it is first
|
||||
* needed, for performance reasons.
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
public IAction getNewConnectionAction() {
|
||||
if (_newConnectionAction == null) _newConnectionAction = new SystemNewConnectionAction(getShell(), true, this); // true=>from popup menu
|
||||
|
|
@ -1700,6 +1712,8 @@ public class SystemTableView
|
|||
|
||||
/**
|
||||
* Get the specific "Renaming %1..."
|
||||
*
|
||||
* @since 3.0
|
||||
*/
|
||||
protected SystemMessage getRenamingMessage(String oldName)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -46,10 +46,11 @@ import org.eclipse.ui.views.properties.IPropertyDescriptor;
|
|||
|
||||
|
||||
/**
|
||||
* This is the content and label provider for the SystemTableView.
|
||||
* This class is used both to populate the SystemTableView but also
|
||||
* to resolve the icon and labels for the cells in the table.
|
||||
* This is the content and label provider for the SystemTableView. This class is
|
||||
* used both to populate the SystemTableView but also to resolve the icon and
|
||||
* labels for the cells in the table.
|
||||
*
|
||||
* @since 3.0 Moved from internal to API
|
||||
*/
|
||||
public class SystemTableViewProvider implements ILabelProvider, ITableLabelProvider, ITreeContentProvider
|
||||
{
|
||||
|
|
|
|||
|
|
@ -129,6 +129,13 @@ public class SubSystemServiceWizardPage extends AbstractSystemNewConnectionWizar
|
|||
return _serviceElements;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param systemType
|
||||
* @param serviceType
|
||||
* @return
|
||||
* @since 3.0 returning ISubSystemConfiguration instead of
|
||||
* IServiceSubSystemConfiguration
|
||||
*/
|
||||
protected ISubSystemConfiguration[] getServiceSubSystemConfigurations(IRSESystemType systemType, Class serviceType)
|
||||
{
|
||||
List results = new ArrayList();
|
||||
|
|
@ -264,6 +271,10 @@ public class SubSystemServiceWizardPage extends AbstractSystemNewConnectionWizar
|
|||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 3.0 taking ISubSystemConfiguration instead of
|
||||
* IServiceSubSystemConfiguration
|
||||
*/
|
||||
protected IConnectorService getCustomConnectorService(ISubSystemConfiguration config)
|
||||
{
|
||||
ServiceElement[] children = _root.getChildren();
|
||||
|
|
|
|||
|
|
@ -20,10 +20,10 @@ import org.eclipse.rse.core.model.ISubSystemConfigurator;
|
|||
*
|
||||
* @see org.eclipse.rse.ui.wizards.AbstractSystemNewConnectionWizardPage
|
||||
* @see org.eclipse.rse.ui.view.SubSystemConfigurationAdapter#
|
||||
* getNewConnectionWizardPages
|
||||
* (org.eclipse.rse.core.subsystems.ISubSystemConfiguration,
|
||||
* org.eclipse.jface.wizard.IWizard)
|
||||
* @since 3.0
|
||||
* getNewConnectionWizardPages
|
||||
* (org.eclipse.rse.core.subsystems.ISubSystemConfiguration,
|
||||
* org.eclipse.jface.wizard.IWizard)
|
||||
* @since 3.0 moved from Core to UI and extends ISubSystemConfigurator
|
||||
*/
|
||||
public interface ISystemNewConnectionWizardPage extends ISubSystemConfigurator {
|
||||
|
||||
|
|
|
|||
|
|
@ -56,6 +56,7 @@ import org.eclipse.ui.IWorkbench;
|
|||
public class RSEMainNewConnectionWizard extends Wizard implements INewWizard, ISelectionProvider {
|
||||
/**
|
||||
* Dialog settings slot id: Last selected system type id within the wizard.
|
||||
* @since 3.0 made protected String public
|
||||
*/
|
||||
public static final String LAST_SELECTED_SYSTEM_TYPE_ID = "lastSelectedSystemTypeId"; //$NON-NLS-1$
|
||||
|
||||
|
|
|
|||
|
|
@ -191,6 +191,7 @@ public class RSENewConnectionWizardSelectionPage extends WizardPage {
|
|||
* Returns the list of system types the page is restricted to.
|
||||
*
|
||||
* @return The list of system types the page is restricted to or <code>null</code>.
|
||||
* @since 3.0 made protected method public
|
||||
*/
|
||||
public IRSESystemType[] getRestrictToSystemTypes() {
|
||||
return restrictedSystemTypes;
|
||||
|
|
|
|||
|
|
@ -541,10 +541,9 @@ implements IAdaptable, ISubSystem, ISystemFilterPoolReferenceManagerProvider
|
|||
system.clearCredentials();
|
||||
}
|
||||
|
||||
/*
|
||||
* (non-Javadoc)
|
||||
*
|
||||
* @see org.eclipse.rse.core.subsystems.ISubSystem#checkIsConnected(org.eclipse.core.runtime.IProgressMonitor)
|
||||
/**
|
||||
* @{inheritDoc
|
||||
* @since 3.0
|
||||
*/
|
||||
public void checkIsConnected(IProgressMonitor monitor) throws SystemMessageException
|
||||
{
|
||||
|
|
|
|||
|
|
@ -1605,8 +1605,9 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
|
|||
return getFilterPoolManager(profile, false);
|
||||
}
|
||||
|
||||
/* (non-Javadoc)
|
||||
* @see org.eclipse.rse.core.subsystems.ISubSystemConfiguration#getFilterPoolManager(org.eclipse.rse.core.model.ISystemProfile, boolean)
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
* @since 3.0 added boolean argument
|
||||
*/
|
||||
public ISystemFilterPoolManager getFilterPoolManager(ISystemProfile profile, boolean force) {
|
||||
// it is important to key by profile object not profile name, since that name can change but the object never should for any one session.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue