eric3.DocumentationTools.__init__

Package implementing interfaces to source code documentation tools.

It implements the high level interface and all the supporting dialogs for the supported source code documentors.

Classes

DocumentationTools Class implementing the high level interface.

Functions

None


DocumentationTools

Class implementing the high level interface.

Derived from

QObject

Methods

DocumentationTools Constructor
getActions Public method to get a list of all actions.
handleEricapi Private slot to perform the eric3-api api generation.
handleEricdoc Private slot to perform the eric3-doc api documentation generation.
initActions Private method to initialize the API documentation actions.
initMenu Private method called to build the project API documentation submenu.

DocumentationTools (Constructor)

DocumentationTools(project, parent)

Constructor

project
project object of the current project
parent
parent object of this class (QObject)

DocumentationTools.getActions

getActions()

Public method to get a list of all actions.

Returns:
list of all actions (list of E3Action)

DocumentationTools.handleEricapi

handleEricapi()

Private slot to perform the eric3-api api generation.

DocumentationTools.handleEricdoc

handleEricdoc()

Private slot to perform the eric3-doc api documentation generation.

DocumentationTools.initActions

initActions()

Private method to initialize the API documentation actions.

DocumentationTools.initMenu

initMenu()

Private method called to build the project API documentation submenu.

Returns:
the menu or None

Up