Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
rootDocPreprocessor.py File Reference

Namespaces

namespace  rootDocPreprocessor
 A tool to preprocess root documentation in order to provide missing functionality in the documentation tools like doxygen or pandoc.

Functions

 rootDocPreprocessor.applyFilters (filename)
 Apply a series of filters to the file modifiying its content.
 rootDocPreprocessor.checkInvocation (argv)
 Check if the invocation is correct.
 rootDocPreprocessor.createPreprocessedName (filename)
 Create a name for the preprocessed version of filename.
 rootDocPreprocessor.includeFilter (text)
 If a line of the form @ROOT_INCLUDE_FILE filename is encountered, it is replaced with the content of filename.
 rootDocPreprocessor.preprocessFile ()
 Apply a series of "filters" to the input file.
 rootDocPreprocessor.printErrAndUsage (msg)

Variables

list rootDocPreprocessor.textFilters = [includeFilter]
str rootDocPreprocessor.usage = "Usage: %s fileToBeTreated.md\n" %__file__