Code_Saturne
CFD tool
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Data Fields
Doxypy Class Reference
Inheritance diagram for Doxypy:
Inheritance graph
Collaboration diagram for Doxypy:
Collaboration graph

Public Member Functions

def __init__
 
def catchall
 
def resetCommentSearch
 
def startCommentSearch
 
def stopCommentSearch
 
def appendFileheadLine
 
def appendCommentLine
 
def appendNormalLine
 
def appendDefclassLine
 
def makeCommentBlock
 
def parse
 
def parseFile
 
def parseLine
 

Data Fields

 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]. More...
 
 outstream
 
 output
 
 comment
 
 filehead
 
 defclass
 
 indent
 

Constructor & Destructor Documentation

def __init__ (   self)

Member Function Documentation

def appendCommentLine (   self,
  match 
)
Appends a comment line.

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

Here is the call graph for this function:

def appendDefclassLine (   self,
  match 
)
Appends a line to the triggering block.
def appendFileheadLine (   self,
  match 
)
Appends a line in the FILEHEAD state.

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

Here is the call graph for this function:

def appendNormalLine (   self,
  match 
)
Appends a line to the output.
def catchall (   self,
  input 
)
The catchall-condition, always returns true.
def makeCommentBlock (   self)
Indents the current comment block with respect to the current
indentation level.

@returns a list of indented comment lines
def parse (   self,
  input 
)
Parses a python file given as input string and returns the doxygen-
compatible representation.

@param  input   the python code to parse
@returns the modified python code

Here is the call graph for this function:

def parseFile (   self,
  filename 
)
Parses a python file given as input string and returns the doxygen-
compatible representation.

@param  input   the python code to parse
@returns the modified python code

Here is the call graph for this function:

def parseLine (   self,
  line 
)
Parse one line of python and flush the resulting output to the 
outstream.

@param  line    the python code line to parse

Here is the call graph for this function:

def resetCommentSearch (   self,
  match 
)
Restarts a new comment search for a different triggering line.

Closes the current commentblock and starts a new comment search.

Here is the call graph for this function:

def startCommentSearch (   self,
  match 
)
Starts a new comment search.

Saves the triggering line, resets the current comment and saves
the current indentation.
def stopCommentSearch (   self,
  match 
)
Stops a comment search.

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

Here is the call graph for this function:

Field Documentation

comment
defclass
defclass_re
double_comment_re
empty_re
end_double_comment_re
end_single_comment_re
filehead
fsm

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

FILEHEAD DEFCLASS DEFCLASS_BODY DEFCLASS_MULTI

hashline_re
importline_re
indent
multiline_defclass_end_re
multiline_defclass_start_re
output
outstream
single_comment_re
start_double_comment_re
start_single_comment_re

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