mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-23 00:03:53 +02:00
[cleanup] Fix and clean up Javadocs
This commit is contained in:
parent
d2a39dbeb8
commit
40fee31989
2 changed files with 749 additions and 508 deletions
File diff suppressed because it is too large
Load diff
|
@ -36,6 +36,7 @@ import org.eclipse.rse.ui.SystemMenuManager;
|
|||
import org.eclipse.rse.ui.validators.ISystemValidator;
|
||||
import org.eclipse.swt.widgets.Shell;
|
||||
import org.eclipse.ui.IActionFilter;
|
||||
import org.eclipse.ui.model.IWorkbenchAdapter;
|
||||
import org.eclipse.ui.views.properties.IPropertyDescriptor;
|
||||
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);
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
public ImageDescriptor getImageDescriptor(Object element);
|
||||
/**
|
||||
* Return the label for this object
|
||||
* Return the label for this object.
|
||||
*/
|
||||
public String getText(Object element);
|
||||
/**
|
||||
* Return the alternate label for this object
|
||||
* Return the alternate label for this object.
|
||||
*/
|
||||
public String getAlternateText(Object element);
|
||||
/**
|
||||
|
@ -169,11 +173,12 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD
|
|||
*/
|
||||
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);
|
||||
/**
|
||||
* 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);
|
||||
|
||||
|
@ -190,7 +195,10 @@ public interface ISystemViewElementAdapter extends IPropertySource, ISystemDragD
|
|||
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);
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue