doxypy::Doxypy Class Reference

List of all members.

Public Member Functions

def __init__
def catchall
 The catchall-condition, always returns true.
def resetCommentSearch
 Restarts a new comment search for a different triggering line.
def startCommentSearch
 Starts a new comment search.
def stopCommentSearch
 Stops a comment search.
def appendFileheadLine
 Appends a line in the FILEHEAD state.
def appendCommentLine
 Appends a comment line.
def appendNormalLine
 Appends a line to the output.
def appendDefclassLine
 Appends a line to the triggering block.
def makeCommentBlock
 Indents the current comment block with respect to the current indentation level.
def parse
 Parses a python file given as input string and returns the doxygen- compatible representation.

Public Attributes

 start_single_comment_re
 end_single_comment_re
 start_double_comment_re
 end_double_comment_re
 single_comment_re
 double_comment_re
 defclass_re
 empty_re
 hashline_re
 importline_re
 multiline_defclass_start_re
 multiline_defclass_end_re
 fsm
 Transition list format ["FROM", "TO", condition, action].
 output
 comment
 filehead
 defclass
 indent


Member Function Documentation

def doxypy::Doxypy::__init__ (   self  ) 

def doxypy::Doxypy::appendCommentLine (   self,
  match 
)

Appends a comment line.

The comment delimiter is removed from multiline start and ends as well as singleline comments.

def doxypy::Doxypy::appendDefclassLine (   self,
  match 
)

Appends a line to the triggering block.

def doxypy::Doxypy::appendFileheadLine (   self,
  match 
)

Appends a line in the FILEHEAD state.

Closes the open comment block, resets it and appends the current line.

def doxypy::Doxypy::appendNormalLine (   self,
  match 
)

Appends a line to the output.

def doxypy::Doxypy::catchall (   self,
  input 
)

The catchall-condition, always returns true.

def doxypy::Doxypy::makeCommentBlock (   self  ) 

Indents the current comment block with respect to the current indentation level.

Returns:
a list of indented comment lines

def doxypy::Doxypy::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

def doxypy::Doxypy::resetCommentSearch (   self,
  match 
)

Restarts a new comment search for a different triggering line.

Closes the current commentblock and starts a new comment search.

def doxypy::Doxypy::startCommentSearch (   self,
  match 
)

Starts a new comment search.

Saves the triggering line, resets the current comment and saves the current indentation.

def doxypy::Doxypy::stopCommentSearch (   self,
  match 
)

Stops a comment search.

Closes the current commentblock, resets the triggering line and appends the current line to the output.


Member Data Documentation

Transition list format ["FROM", "TO", condition, action].


The documentation for this class was generated from the following file:

Generated on Thu Mar 5 09:03:55 2009 for GNU Radio 3.1.3 by  doxygen 1.5.8