1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-23 08:13:50 +02:00

[cleanup] Fix and clean up Javadocs

This commit is contained in:
Martin Oberhuber 2008-05-05 10:13:09 +00:00
parent d2a39dbeb8
commit 40fee31989
2 changed files with 749 additions and 508 deletions

View file

@ -36,6 +36,7 @@ import org.eclipse.rse.ui.SystemMenuManager;
import org.eclipse.rse.ui.validators.ISystemValidator; import org.eclipse.rse.ui.validators.ISystemValidator;
import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.IActionFilter; import org.eclipse.ui.IActionFilter;
import org.eclipse.ui.model.IWorkbenchAdapter;
import org.eclipse.ui.views.properties.IPropertyDescriptor; import org.eclipse.ui.views.properties.IPropertyDescriptor;
import org.eclipse.ui.views.properties.IPropertySource; import org.eclipse.ui.views.properties.IPropertySource;
@ -152,16 +153,19 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD
*/ */
public void addActions(SystemMenuManager menu, IStructuredSelection selection, Shell parent, String menuGroup); public void addActions(SystemMenuManager menu, IStructuredSelection selection, Shell parent, String menuGroup);
/** /**
* Returns an image descriptor for the image. More efficient than getting the image. * Returns an image descriptor for the image. More efficient than getting
* the image. Implements {@link IWorkbenchAdapter#getImageDescriptor(Object)
* }.
*
* @param element The element for which an image is desired * @param element The element for which an image is desired
*/ */
public ImageDescriptor getImageDescriptor(Object element); public ImageDescriptor getImageDescriptor(Object element);
/** /**
* Return the label for this object * Return the label for this object.
*/ */
public String getText(Object element); public String getText(Object element);
/** /**
* Return the alternate label for this object * Return the alternate label for this object.
*/ */
public String getAlternateText(Object element); public String getAlternateText(Object element);
/** /**
@ -169,11 +173,12 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD
*/ */
public String getName(Object element); public String getName(Object element);
/** /**
* Return a value for the type property for this object * Return a value for the type property for this object.
*/ */
public String getType(Object element); public String getType(Object element);
/** /**
* Return the string to display in the status line when the given object is selected * Return the string to display in the status line when the given object is
* selected.
*/ */
public String getStatusLineText(Object element); public String getStatusLineText(Object element);
@ -190,7 +195,10 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD
public boolean exists(Object element); public boolean exists(Object element);
/** /**
* Return the parent of this object * Return the parent of this object. This is required by eclipse UI
* adapters, but we try desperately not to use in the RSE. So, you are
* probably safe returning null, but if you can return a parent, why not, go
* for it.
*/ */
public Object getParent(Object element); public Object getParent(Object element);