validation.DocumentationVerticalSpacingValidator Class Reference

Inheritance diagram for validation.DocumentationVerticalSpacingValidator:

Collaboration diagram for validation.DocumentationVerticalSpacingValidator:

Public Member Functions
def	__init__ (self, errorReporter)
def	check (self, lineNumber, line)
def	reportError (self, lineNumber, line, message)
Public Member Functions inherited from SimpleValidator.SimpleValidator
def	reset (self, path)
def	finalize (self)

Static Public Member Functions
def	formatError (err)

Public Attributes
	previousStrippedLine
Public Attributes inherited from SimpleValidator.SimpleValidator
	errorReporter
	path

Static Public Attributes
string	SUITE_NAME = 'DocumentationVerticalSpacingChecker'
string	NAME = 'documentationVerticalSpacingChecker'

Detailed Description

Validator for ensuring documentation has appropriate vertical spacing.

Constructor & Destructor Documentation

__init__()

def validation.DocumentationVerticalSpacingValidator.__init__	(		self,
			errorReporter
	)

Reimplemented from SimpleValidator.SimpleValidator.

Member Function Documentation

check()

def validation.DocumentationVerticalSpacingValidator.check	(		self,
			lineNumber,
			line
	)

Here is the call graph for this function:

formatError()

def validation.DocumentationVerticalSpacingValidator.formatError (   err )

static

reportError()

def validation.DocumentationVerticalSpacingValidator.reportError	(		self,
			lineNumber,
			line,
			message
	)

Here is the caller graph for this function:

Member Data Documentation

NAME

string validation.DocumentationVerticalSpacingValidator.NAME = 'documentationVerticalSpacingChecker'

static

previousStrippedLine

validation.DocumentationVerticalSpacingValidator.previousStrippedLine

SUITE_NAME

string validation.DocumentationVerticalSpacingValidator.SUITE_NAME = 'DocumentationVerticalSpacingChecker'

static

---

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

• validation.py