mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-23 14:42:11 +02:00
Code Issues Wiki Activity

[cleanup] Fix javadoc warnings

Browse source
This commit is contained in:
Martin Oberhuber 2006-08-10 12:32:22 +00:00
parent 7e125bb084
commit 8adfb164bb
23 changed files with 118 additions and 59 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/Activator.java
View file

@ -39,8 +39,9 @@ public class Activator extends SystemBasePlugin {
plugin = this;
}
/**
* This method is called upon plug-in activation
/*
* (non-Javadoc)
* @see org.eclipse.rse.core.SystemBasePlugin#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
super.start(context);
@ -49,8 +50,9 @@ public class Activator extends SystemBasePlugin {
manager.registerAdapters(factory, DaytimeResource.class);
}
/**
* This method is called when the plug-in is stopped
/*
* (non-Javadoc)
* @see org.eclipse.rse.core.SystemBasePlugin#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
super.stop(context);

2
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/DaytimeResources.java
View file

@ -26,6 +26,8 @@ public class DaytimeResources extends NLS {
public static String Daytime_Resource_Type;
public static String DaytimeConnectorService_NotAvailable;
public static String DaytimeWizard_TestFieldText;
static {
// load message values from bundle file

1
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/DaytimeResources.properties
View file

@ -15,3 +15,4 @@ Daytime_Connector_Name=Daytime Connector Service
Daytime_Connector_Description=The Daytime Connector Service manages connections to TCP port 13 on a remote host.
Daytime_Resource_Type=daytime resource
DaytimeConnectorService_NotAvailable=Daytime service is not available on {0}.
DaytimeWizard_TestFieldText=This is the Daytime Wizard Test Field.

1
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/connectorservice/DaytimeConnectorServiceManager.java
View file

@ -37,6 +37,7 @@ public class DaytimeConnectorServiceManager extends AbstractConnectorServiceMana
/**
* Return singleton instance
* @return the singleton instance
*/
public static DaytimeConnectorServiceManager getTheDaytimeConnectorServiceManager() {
if (fInstance == null) {

5
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/model/DaytimeResource.java
View file

@ -27,7 +27,10 @@ public class DaytimeResource extends AbstractResource {
super();
}
/** Constructor when parent subsystem is given */
/**
* Constructor when parent subsystem is given
* @param subsystem the parent subsystem
*/
public DaytimeResource(ISubSystem subsystem) {
super(subsystem);
}

4
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/ui/DaytimeNewConnectionWizardPage.java
View file

@ -2,6 +2,7 @@ package org.eclipse.rse.examples.daytime.ui;
import org.eclipse.jface.wizard.IWizard;
import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
import org.eclipse.rse.examples.daytime.DaytimeResources;
import org.eclipse.rse.ui.wizards.AbstractSystemNewConnectionWizardPage;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Composite;
@ -19,8 +20,7 @@ public class DaytimeNewConnectionWizardPage extends
public Control createContents(Composite parent) {
Text field = new Text(parent, SWT.NONE);
field.setText("this is a test");
field.setText(DaytimeResources.DaytimeWizard_TestFieldText);
// TODO Auto-generated method stub
return field;

25
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/ui/DaytimeSubSystemConfigurationAdapter.java
View file

@ -18,37 +18,20 @@ package org.eclipse.rse.examples.daytime.ui;
import java.util.Vector;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.wizard.IWizard;
import org.eclipse.rse.core.SystemBasePlugin;
import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
import org.eclipse.rse.filters.ISystemFilter;
import org.eclipse.rse.filters.ISystemFilterPool;
import org.eclipse.rse.model.ISystemRegistry;
import org.eclipse.rse.ui.RSEUIPlugin;
import org.eclipse.rse.ui.actions.SystemPasteFromClipboardAction;
import org.eclipse.rse.core.subsystems.ISubSystemConfiguration;
import org.eclipse.rse.ui.view.SubsystemConfigurationAdapter;
import org.eclipse.rse.ui.wizards.ISystemNewConnectionWizardPage;
import org.eclipse.swt.dnd.Clipboard;
import org.eclipse.swt.widgets.Shell;
public class DaytimeSubSystemConfigurationAdapter extends SubsystemConfigurationAdapter
{
Vector _additionalActions;
// -----------------------------------
// WIZARD PAGE CONTRIBUTION METHODS... (defects 43194 and 42780)
// -----------------------------------
/**
* Optionally return one or more wizard pages to append to the New Connection Wizard if
* the user selects a system type that this subsystem factory supports.
* <p>
* Tip: consider extending AbstractSystemWizardPage for your wizard page class.
/*
* (non-Javadoc)
* @see org.eclipse.rse.ui.view.SubsystemConfigurationAdapter#getNewConnectionWizardPages(org.eclipse.rse.core.subsystems.ISubSystemConfiguration, org.eclipse.jface.wizard.IWizard)
*/
public ISystemNewConnectionWizardPage[] getNewConnectionWizardPages(ISubSystemConfiguration factory, IWizard wizard)
{

15
rse/examples/org.eclipse.rse.examples.daytime/src/org/eclipse/rse/examples/daytime/ui/DaytimeSubSystemConfigurationAdapterFactory.java
View file

@ -7,27 +7,32 @@ import org.eclipse.rse.examples.daytime.subsystems.DaytimeSubsystemConfiguration
public class DaytimeSubSystemConfigurationAdapterFactory implements IAdapterFactory {
private ISubsystemConfigurationAdapter ssFactoryAdapter = new DaytimeSubSystemConfigurationAdapter();
/**
* @see IAdapterFactory#getAdapterList()
/*
* (non-Javadoc)
* @see org.eclipse.core.runtime.IAdapterFactory#getAdapterList()
*/
public Class[] getAdapterList()
{
return new Class[] {ISubsystemConfigurationAdapter.class};
}
/**
* Called by our plugin's startup method to register our adaptable object types
* with the platform. We prefer to do it here to isolate/encapsulate all factory
* logic in this one place.
*
* @param manager Platform adapter manager to register with
*/
public void registerWithManager(IAdapterManager manager)
{
manager.registerAdapters(this, DaytimeSubsystemConfiguration.class);
}
/**
* @see IAdapterFactory#getAdapter(java.lang.Object, java.lang.Class)
/*
* (non-Javadoc)
* @see org.eclipse.core.runtime.IAdapterFactory#getAdapter(java.lang.Object, java.lang.Class)
*/
public Object getAdapter(Object adaptableObject, Class adapterType)
{

30
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/RSESamplesPlugin.java
View file

@ -48,8 +48,9 @@ public class RSESamplesPlugin extends SystemBasePlugin {
plugin = this;
}
/**
* This method is called upon plug-in activation
/*
* (non-Javadoc)
* @see org.eclipse.rse.core.SystemBasePlugin#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
super.start(context);
@ -65,8 +66,9 @@ public class RSESamplesPlugin extends SystemBasePlugin {
}
/**
* This method is called when the plug-in is stopped
/*
* (non-Javadoc)
* @see org.eclipse.rse.core.SystemBasePlugin#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
super.stop(context);
@ -76,6 +78,7 @@ public class RSESamplesPlugin extends SystemBasePlugin {
/**
* Returns the shared instance.
* @return the shared instance
*/
public static RSESamplesPlugin getDefault() {
return plugin;
@ -83,6 +86,7 @@ public class RSESamplesPlugin extends SystemBasePlugin {
/**
* Returns the workspace instance.
* @return the singleton Workspace from Eclipse Resources plugin
*/
public static IWorkspace getWorkspace() {
return ResourcesPlugin.getWorkspace();
@ -91,6 +95,10 @@ public class RSESamplesPlugin extends SystemBasePlugin {
/**
* Returns the string from the plugin's resource bundle,
* or 'key' if not found.
* @see java.util.ResourceBundle#getString(String)
*
* @param key the key for the desired string
* @return the string for the given key
*/
public static String getResourceString(String key) {
ResourceBundle bundle= RSESamplesPlugin.getDefault().getResourceBundle();
@ -102,7 +110,8 @@ public class RSESamplesPlugin extends SystemBasePlugin {
}
/**
* Returns the plugin's resource bundle,
* Return the plugin's Resource bundle.
* @return the Resource bundle
*/
public ResourceBundle getResourceBundle() {
try {
@ -146,7 +155,9 @@ public class RSESamplesPlugin extends SystemBasePlugin {
}
/**
* Return our message file
* Return our message file.
*
* @return the RSE message file
*/
public static SystemMessageFile getPluginMessageFile()
{
@ -154,7 +165,12 @@ public class RSESamplesPlugin extends SystemBasePlugin {
}
/**
* Retrieve a message from this plugin's message file
* Retrieve a message from this plugin's message file,
* or <code>null</code> if the message cannot be found.
* @see SystemMessageFile#getMessage(String)
*
* @param msgId message id
* @return the message object referenced by the given id
*/
public static SystemMessage getPluginMessage(String msgId)
{

1
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/model/DeveloperResource.java
View file

@ -38,6 +38,7 @@ public class DeveloperResource extends AbstractResource {
/**
* Constructor for DeveloperResource when given parent subsystem.
* @param parentSubSystem the parent subsystem
*/
public DeveloperResource(ISubSystem parentSubSystem)
{

1
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/model/TeamResource.java
View file

@ -36,6 +36,7 @@ public class TeamResource extends AbstractResource {
}
/**
* Constructor for TeamResource when given a parent subsystem.
* @param parentSubSystem the parent subsystem
*/
public TeamResource(ISubSystem parentSubSystem)
{

16
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/model/TeamResourceAdapter.java
View file

@ -105,7 +105,7 @@ public class TeamResourceAdapter extends AbstractSystemViewAdapter implements
return ((TeamResource)element).getDevelopers();
}
/**
/* (non-Javadoc)
* @see org.eclipse.rse.ui.view.AbstractSystemViewAdapter#internalGetPropertyDescriptors()
*/
protected IPropertyDescriptor[] internalGetPropertyDescriptors()
@ -119,10 +119,13 @@ public class TeamResourceAdapter extends AbstractSystemViewAdapter implements
protected Object internalGetPropertyValue(Object key)
{
return null;
}
}
/**
* Intercept of parent method to indicate these objects can be renamed using the RSE-supplied
* rename action.
* Intercept of parent method to indicate these objects
* can be renamed using the RSE-supplied rename action.
*
* @see org.eclipse.rse.ui.view.AbstractSystemViewAdapter#canRename(java.lang.Object)
*/
public boolean canRename(Object element)
{
@ -131,13 +134,16 @@ public class TeamResourceAdapter extends AbstractSystemViewAdapter implements
/**
* Intercept of parent method to actually do the rename. RSE supplies the rename GUI, but
* defers the action work of renaming to this adapter method.
* defers the action work of renaming to this adapter method.
*
* @see org.eclipse.rse.ui.view.AbstractSystemViewAdapter#doRename(Shell, Object, String)
*/
public boolean doRename(Shell shell, Object element, String newName)
{
((TeamResource)element).setName(newName);
return true;
}
// --------------------------------------
// ISystemRemoteElementAdapter methods...
// --------------------------------------

1
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperConnectorServiceManager.java
View file

@ -41,6 +41,7 @@ public class DeveloperConnectorServiceManager extends
/**
* Return singleton instance
* @return the singleton instance
*/
public static DeveloperConnectorServiceManager getTheDeveloperConnectorServiceManager()
{

9
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperFilterStringEditPane.java
View file

@ -101,9 +101,12 @@ public class DeveloperFilterStringEditPane extends SystemFilterStringEditPane {
);
return composite_prompts;
}
/**
* Override of parent method.
* Return the control to recieve initial focus.
* Return the control to recieve initial focus.
*
* @see org.eclipse.rse.ui.filters.SystemFilterStringEditPane#getInitialFocusControl()
*/
public Control getInitialFocusControl()
{
@ -157,7 +160,9 @@ public class DeveloperFilterStringEditPane extends SystemFilterStringEditPane {
* Override of parent method.
* Get the filter string in its current form.
* Functional opposite of doInitializeFields, which tears apart the input string in update mode,
* to populate the GUIs. This method creates the filter string from the information in the GUI.
* to populate the GUIs. This method creates the filter string from the information in the GUI.
*
* @see org.eclipse.rse.ui.filters.SystemFilterStringEditPane#getFilterString()
*/
public String getFilterString()
{

7
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperSubSystem.java
View file

@ -64,7 +64,10 @@ public class DeveloperSubSystem extends SubSystem
* the specified unique ID. Because each subsystem maintains it's own
* objects, it's the responsability of the subsystem to determine
* how an ID (or key) for a given object maps to the real object.
* By default this returns null.
* By default this returns null.
*
* @param key internal unique ID for object
* @return Object identified by the given key
*/
public Object getObjectWithAbsoluteName(String key)
{
@ -176,6 +179,7 @@ public class DeveloperSubSystem extends SubSystem
/**
* Get the list of all teams. Normally this would involve a trip the server, but we
* fake it out and return a hard-coded local list.
* @return array of all teams
*/
public TeamResource[] getAllTeams()
{
@ -186,6 +190,7 @@ public class DeveloperSubSystem extends SubSystem
/**
* Get the list of all developers. Normally this would involve a trip the server, but we
* fake it out and return a hard-coded local list.
* @return array of all developers
*/
public DeveloperResource[] getAllDevelopers()
{

4
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperSubSystemConfiguration.java
View file

@ -43,6 +43,7 @@ public class DeveloperSubSystemConfiguration extends SubSystemConfiguration {
/**
* Create an instance of our subsystem.
* @see org.eclipse.rse.core.subsystems.SubSystemConfiguration#createSubSystemInternal(org.eclipse.rse.model.IHost)
*/
public ISubSystem createSubSystemInternal(IHost conn) {
return new DeveloperSubSystem(conn, getConnectorService(conn));
@ -81,9 +82,10 @@ public class DeveloperSubSystemConfiguration extends SubSystemConfiguration {
/**
* Intercept of parent method so we can supply our own value shown in the property
* sheet for the "type" property when a filter is selected within our subsystem.
* sheet for the "type" property when a filter is selected within our subsystem.
*
* Requires this line in rseSamplesResources.properties: property.type.teamfilter=Team filter
* @see org.eclipse.rse.core.subsystems.SubSystemConfiguration#getTranslatedFilterTypeProperty(org.eclipse.rse.filters.ISystemFilter)
*/
public String getTranslatedFilterTypeProperty(ISystemFilter selectedFilter)
{

1
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperSubSystemConfigurationAdapter.java
View file

@ -92,6 +92,7 @@ public class DeveloperSubSystemConfigurationAdapter extends
/**
* Override of parent method for returning the image for filters in our subsystem.
* @see org.eclipse.rse.ui.view.SubsystemConfigurationAdapter#getSystemFilterImage(org.eclipse.rse.filters.ISystemFilter)
*/
public ImageDescriptor getSystemFilterImage(ISystemFilter filter)
{

1
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/subsystems/DeveloperSubSystemConfigurationAdapterFactory.java
View file

@ -41,6 +41,7 @@ public class DeveloperSubSystemConfigurationAdapterFactory implements
* Called by our plugin's startup method to register our adaptable object types
* with the platform. We prefer to do it here to isolate/encapsulate all factory
* logic in this one place.
* @param manager Platform adapter manager
*/
public void registerWithManager(IAdapterManager manager)
{

8
rse/examples/org.eclipse.rse.examples.tutorial/src/samples/ui/propertypages/FolderInfoPropertyPage.java
View file

@ -103,6 +103,7 @@ public class FolderInfoPropertyPage
/**
* Intercept from PreferencePage. Called when user presses Cancel button.
* We stop the background thread.
* @see org.eclipse.jface.preference.PreferencePage#performCancel()
*/
public boolean performCancel()
{
@ -142,6 +143,7 @@ public class FolderInfoPropertyPage
/**
* From SelectionListener
* @see SelectionListener#widgetSelected(SelectionEvent)
*/
public void widgetSelected(SelectionEvent event)
{
@ -153,9 +155,11 @@ public class FolderInfoPropertyPage
}
/**
* From SelectionListener
* @see SelectionListener#widgetDefaultSelected(SelectionEvent)
*/
public void widgetDefaultSelected(SelectionEvent event) {}
public void widgetDefaultSelected(SelectionEvent event)
{
}
// ----------------
// Inner classes...

1
rse/plugins/org.eclipse.rse.connectorservice.ssh/src/org/eclipse/rse/connectorservice/ssh/SshConnectorServiceManager.java
View file

@ -39,6 +39,7 @@ public class SshConnectorServiceManager extends AbstractConnectorServiceManager
/**
* Return singleton instance of this class
* @return the singleton instance
*/
public static SshConnectorServiceManager getInstance()
{

12
rse/plugins/org.eclipse.rse.services.ssh/src/org/eclipse/rse/services/ssh/Activator.java
View file

@ -40,17 +40,17 @@ public class Activator extends Plugin {
plugin = this;
}
/**
* This method is called upon plug-in activation
/*
* (non-Javadoc)
* @see org.eclipse.core.runtime.Plugin#start(org.osgi.framework.BundleContext)
*/
public void start(BundleContext context) throws Exception {
super.start(context);
// make sure files.ui is activated
// org.eclipse.rse.files.ui.Activator.getDefault();
}
/**
* This method is called when the plug-in is stopped
/*
* (non-Javadoc)
* @see org.eclipse.core.runtime.Plugin#stop(org.osgi.framework.BundleContext)
*/
public void stop(BundleContext context) throws Exception {
super.stop(context);

20
rse/plugins/org.eclipse.rse.services.ssh/src/org/eclipse/rse/services/ssh/files/SftpHostFile.java
View file

@ -135,11 +135,29 @@ public class SftpHostFile implements IHostFile {
return fLinkTarget;
}
/** Extended data: name:value pairs */
/**
* Set Extended data as key,value pairs.
*
* The data is maintained as a String array, where every element
* with an even index refers to a key, and the next element
* refers to its value. Example
* extended[0] = "acl"
* extended[1] = "joe,tim"
* extended[2] = "version"
* extended[3] = "/main/3"
*
* @param extended String[] array of key,value pairs
*/
public void setExtendedData(String[] extended) {
fExtended = extended;
}
/**
* Return extended data as name,value pairs.
* @see #setExtendedData(String[])
*
* @return String[] array of key,value pairs
*/
public String[] getExtendedData() {
return fExtended;
}

2
rse/plugins/org.eclipse.rse.services.ssh/src/org/eclipse/rse/services/ssh/shell/SshShellWriterThread.java
View file

@ -31,7 +31,7 @@ public class SshShellWriterThread extends Thread
/**
* constructor for ssh shell writer thread
* @param outputStream Stream to write to in separate Thread
* @param outputWriter PrintWriter to write to in separate Thread
*/
public SshShellWriterThread(PrintWriter outputWriter)
{