Doxypy Class Reference
List of all members.
Detailed Description
Definition at line 85 of file doxypy.py.
Member Function Documentation
| def catchall |
( |
|
self, |
|
|
|
input | |
|
) |
| | |
The catchall-condition, always returns true.
Definition at line 198 of file doxypy.py.
| def resetCommentSearch |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Restarts a new comment search for a different triggering line.
Closes the current commentblock and starts a new comment search.
Definition at line 205 of file doxypy.py.
| def startCommentSearch |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Starts a new comment search.
Saves the triggering line, resets the current comment and saves the current indentation.
Definition at line 214 of file doxypy.py.
| def stopCommentSearch |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Stops a comment search.
Closes the current commentblock, resets the triggering line and appends the current line to the output.
Definition at line 224 of file doxypy.py.
| def appendFileheadLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a line in the FILEHEAD state.
Closes the open comment block, resets it and appends the current line.
Definition at line 234 of file doxypy.py.
| def appendCommentLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a comment line.
The comment delimiter is removed from multiline start and ends as well as singleline comments.
Definition at line 244 of file doxypy.py.
| def appendNormalLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a line to the output.
Definition at line 280 of file doxypy.py.
| def appendDefclassLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a line to the triggering block.
Definition at line 285 of file doxypy.py.
| def makeCommentBlock |
( |
|
self |
) |
|
Indents the current comment block with respect to the current indentation level.
- Returns:
- a list of indented comment lines
Definition at line 293 of file doxypy.py.
| def parse |
( |
|
self, |
|
|
|
input | |
|
) |
| | |
Parses a python file given as input string and returns the doxygen- compatible representation.
- Parameters:
-
| input | the python code to parse |
- Returns:
- the modified python code
Definition at line 309 of file doxypy.py.
| def catchall |
( |
|
self, |
|
|
|
input | |
|
) |
| | |
The catchall-condition, always returns true.
Definition at line 198 of file doxypy.py.
| def resetCommentSearch |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Restarts a new comment search for a different triggering line.
Closes the current commentblock and starts a new comment search.
Definition at line 205 of file doxypy.py.
| def startCommentSearch |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Starts a new comment search.
Saves the triggering line, resets the current comment and saves the current indentation.
Definition at line 214 of file doxypy.py.
| def stopCommentSearch |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Stops a comment search.
Closes the current commentblock, resets the triggering line and appends the current line to the output.
Definition at line 224 of file doxypy.py.
| def appendFileheadLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a line in the FILEHEAD state.
Closes the open comment block, resets it and appends the current line.
Definition at line 234 of file doxypy.py.
| def appendCommentLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a comment line.
The comment delimiter is removed from multiline start and ends as well as singleline comments.
Definition at line 244 of file doxypy.py.
| def appendNormalLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a line to the output.
Definition at line 280 of file doxypy.py.
| def appendDefclassLine |
( |
|
self, |
|
|
|
match | |
|
) |
| | |
Appends a line to the triggering block.
Definition at line 285 of file doxypy.py.
| def makeCommentBlock |
( |
|
self |
) |
|
Indents the current comment block with respect to the current indentation level.
- Returns:
- a list of indented comment lines
Definition at line 293 of file doxypy.py.
| def parse |
( |
|
self, |
|
|
|
input | |
|
) |
| | |
Parses a python file given as input string and returns the doxygen- compatible representation.
- Parameters:
-
| input | the python code to parse |
- Returns:
- the modified python code
Definition at line 309 of file doxypy.py.
Member Data Documentation
Transition list format ["FROM", "TO", condition, action].
Definition at line 159 of file doxypy.py.
The documentation for this class was generated from the following files:
