Module implementing a docstring generator base class.
None |
BaseDocstringGenerator | Class implementing a docstring generator base class. |
DocstringMenuForEnterOnly | Class implementing a special menu reacting to the enter/return keys only. |
FunctionInfo | Class implementing an object to store function information. |
getIndentStr | Function to get the indentation of a text. |
Class implementing a docstring generator base class.
None |
None |
BaseDocstringGenerator | Constructor |
_generateDocstringList | Protected method to generate type specific docstrings based on the extracted function information. |
getDocstringType | Public method to determine the docstring type to be generated. |
hasFunctionDefinition | Public method to test, if the cursor is right below a function definition. |
insertDocstring | Public method to insert a docstring for the function at the cursor position. |
insertDocstringFromShortcut | Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut. |
isDocstringIntro | Public function to test, if the line up to the cursor position might be introducing a docstring. |
isFunctionStart | Public method to test, if a text is the start of a function or method definition. |
None |
Constructor
Protected method to generate type specific docstrings based on the extracted function information.
Public method to determine the docstring type to be generated.
Public method to test, if the cursor is right below a function definition.
Public method to insert a docstring for the function at the cursor position.
Public method to insert a docstring for the function at the cursor position initiated via a keyboard shortcut.
Public function to test, if the line up to the cursor position might be introducing a docstring.
Public method to test, if a text is the start of a function or method definition.
Class implementing a special menu reacting to the enter/return keys only.
If a keyboard input is not the "enter key", the menu is closed and the input is inserted to the code editor.
None |
None |
DocstringMenuForEnterOnly | Constructor |
keyPressEvent | Protected method to handle key press events. |
None |
Constructor
Protected method to handle key press events.
Class implementing an object to store function information.
Methods to extract the relevant information need to be implemented in language specific subclasses.
None |
None |
FunctionInfo | Constructor |
parseBody | Public method to parse the function body text. |
parseDefinition | Public method to parse the function definition text. |
None |
Constructor
Public method to parse the function body text.
Note: This method should be overwritten in subclasses.
Public method to parse the function definition text.
Note: This method should be overwritten in subclasses.
Function to get the indentation of a text.