zenilib  0.5.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
sources.SourceProcessor Class Reference

SOURCE PROCESSOR CLASS. More...

Public Member Functions

def __init__
 
def add_block_lines
 
def dump
 
def parse_file
 
def process_normal_line
 
def reset
 

Public Attributes

 blocks
 
 filename
 
 format
 
 lineno
 
 lines
 

Detailed Description

SOURCE PROCESSOR CLASS.

The SourceProcessor is in charge of reading a C source file and decomposing it into a series of different "SourceBlock" objects.

each one of these blocks can be made of the following data:

  • A documentation comment block that starts with "/**" and whose exact format will be discussed later
  • normal sources lines, include comments

Definition at line 270 of file sources.py.

Constructor & Destructor Documentation

def sources.SourceProcessor.__init__ (   self)
initialize a source processor

Definition at line 272 of file sources.py.

Member Function Documentation

def sources.SourceProcessor.dump (   self)
print all blocks in a processor

Definition at line 342 of file sources.py.

References formatter.Formatter.blocks, internal_state.blocks, sources.SourceProcessor.blocks, and content.DocSection.blocks.

Member Data Documentation

sources.SourceProcessor.blocks

Definition at line 274 of file sources.py.

Referenced by sources.SourceProcessor.dump(), and sources.SourceProcessor.reset().

sources.SourceProcessor.filename
sources.SourceProcessor.lineno
sources.SourceProcessor.lines

Definition at line 277 of file sources.py.

Referenced by sources.SourceProcessor.add_block_lines().


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