Public Member Functions | Public Attributes | Private Attributes | List of all members
roslint.cpplint._BlockInfo Class Reference
Inheritance diagram for roslint.cpplint._BlockInfo:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, linenum, seen_open_brace)
 
def CheckBegin (self, filename, clean_lines, linenum, error)
 
def CheckEnd (self, filename, clean_lines, linenum, error)
 
def IsBlockInfo (self)
 

Public Attributes

 check_namespace_indentation
 
 inline_asm
 
 open_parentheses
 
 seen_open_brace
 
 starting_linenum
 

Private Attributes

 __class__
 

Detailed Description

Stores information about a generic block of code.

Definition at line 2208 of file cpplint.py.

Constructor & Destructor Documentation

◆ __init__()

def roslint.cpplint._BlockInfo.__init__ (   self,
  linenum,
  seen_open_brace 
)

Definition at line 2211 of file cpplint.py.

Member Function Documentation

◆ CheckBegin()

def roslint.cpplint._BlockInfo.CheckBegin (   self,
  filename,
  clean_lines,
  linenum,
  error 
)
Run checks that applies to text up to the opening brace.

This is mostly for checking the text after the class identifier
and the "{", usually where the base class is specified.  For other
blocks, there isn't much to check, so we always pass.

Args:
  filename: The name of the current file.
  clean_lines: A CleansedLines instance containing the file.
  linenum: The number of the line to check.
  error: The function to call with any errors found.

Definition at line 2218 of file cpplint.py.

◆ CheckEnd()

def roslint.cpplint._BlockInfo.CheckEnd (   self,
  filename,
  clean_lines,
  linenum,
  error 
)
Run checks that applies to text after the closing brace.

This is mostly used for checking end of namespace comments.

Args:
  filename: The name of the current file.
  clean_lines: A CleansedLines instance containing the file.
  linenum: The number of the line to check.
  error: The function to call with any errors found.

Definition at line 2233 of file cpplint.py.

◆ IsBlockInfo()

def roslint.cpplint._BlockInfo.IsBlockInfo (   self)
Returns true if this block is a _BlockInfo.

This is convenient for verifying that an object is an instance of
a _BlockInfo, but not an instance of any of the derived classes.

Returns:
  True for this class, False for derived classes.

Definition at line 2246 of file cpplint.py.

Member Data Documentation

◆ __class__

roslint.cpplint._BlockInfo.__class__
private

Definition at line 2255 of file cpplint.py.

◆ check_namespace_indentation

roslint.cpplint._BlockInfo.check_namespace_indentation

Definition at line 2216 of file cpplint.py.

◆ inline_asm

roslint.cpplint._BlockInfo.inline_asm

Definition at line 2215 of file cpplint.py.

◆ open_parentheses

roslint.cpplint._BlockInfo.open_parentheses

Definition at line 2214 of file cpplint.py.

◆ seen_open_brace

roslint.cpplint._BlockInfo.seen_open_brace

Definition at line 2213 of file cpplint.py.

◆ starting_linenum

roslint.cpplint._BlockInfo.starting_linenum

Definition at line 2212 of file cpplint.py.


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


roslint
Author(s): Mike Purvis, Jack O'Quin
autogenerated on Sun Mar 5 2023 03:27:29