Class AddJavaDocStubAction

  • All Implemented Interfaces:
    IAction, ISelectionChangedListener

    public class AddJavaDocStubAction
    extends SelectionDispatchAction
    Create Javadoc comment stubs for the selected members.

    Will open the parent compilation unit in a Java editor. The result is unsaved, so the user can decide if the changes are acceptable.

    The action is applicable to structured selections containing elements of type IMember.

    This class may be instantiated; it is not intended to be subclassed.

    Since:
    2.0
    Restriction:
    This class is not intended to be subclassed by clients.
    • Constructor Detail

      • AddJavaDocStubAction

        public AddJavaDocStubAction​(IWorkbenchSite site)
        Creates a new AddJavaDocStubAction. The action requires that the selection provided by the site's selection provider is of type org.eclipse.jface.viewers.IStructuredSelection.
        Parameters:
        site - the site providing context information for this action
      • AddJavaDocStubAction

        public AddJavaDocStubAction​(org.eclipse.jdt.internal.ui.javaeditor.CompilationUnitEditor editor)
        Note: This constructor is for internal use only. Clients should not call this constructor.
        Parameters:
        editor - the compilation unit editor
        Restriction:
        This constructor is not intended to be referenced by clients.