Visualization Library 2.0.0-b5

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Public Attributes | List of all members
sources.SourceBlock Class Reference

SOURCE BLOCK CLASS. More...

Public Member Functions

def __init__ (self, processor, filename, lineno, lines)
 
def location (self)
 
def dump (self)
 

Public Attributes

 processor
 
 filename
 
 lineno
 
 lines
 
 format
 
 content
 

Detailed Description

SOURCE BLOCK CLASS.

A SourceProcessor is in charge of reading a C source file and decomposing it into a series of different "SourceBlocks". each one of these blocks can be made of the following data:

the important fields in a text block are the following ones:

self.lines : a list of text lines for the corresponding block

self.content : for documentation comment blocks only, this is the block content that has been "unboxed" from its decoration. This is None for all other blocks (i.e. sources or ordinary comments with no starting markup tag)

Definition at line 201 of file sources.py.

Constructor & Destructor Documentation

◆ __init__()

def sources.SourceBlock.__init__ (   self,
  processor,
  filename,
  lineno,
  lines 
)

Definition at line 203 of file sources.py.

Member Function Documentation

◆ dump()

def sources.SourceBlock.dump (   self)

◆ location()

def sources.SourceBlock.location (   self)

Definition at line 233 of file sources.py.

References sources.SourceBlock.filename, and sources.SourceBlock.lineno.

Member Data Documentation

◆ content

sources.SourceBlock.content

Definition at line 209 of file sources.py.

Referenced by sources.SourceBlock.dump().

◆ filename

sources.SourceBlock.filename

◆ format

sources.SourceBlock.format

◆ lineno

sources.SourceBlock.lineno

◆ lines

sources.SourceBlock.lines

◆ processor

sources.SourceBlock.processor

Definition at line 204 of file sources.py.


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