Flutter Engine
The Flutter Engine
Public Member Functions | Public Attributes | List of all members
xrefs.XrefExtension Class Reference
Inheritance diagram for xrefs.XrefExtension:

Public Member Functions

None __init__ (self)
 
def extendMarkdown (self, md)
 

Public Attributes

 symbols_index
 
 packages
 

Detailed Description

Markdown extension which handles xrefs and links to markdown files.

Definition at line 131 of file xrefs.py.

Constructor & Destructor Documentation

◆ __init__()

None xrefs.XrefExtension.__init__ (   self)

Definition at line 136 of file xrefs.py.

136 def __init__(self) -> None:
137 super().__init__()
138 self.symbols_index = load_index('xref.json')
139 self.packages = XrefExtension._load_package_config()
140
SymbolsIndex load_index(str filename)
Definition: cpp_indexer.py:272

Member Function Documentation

◆ extendMarkdown()

def xrefs.XrefExtension.extendMarkdown (   self,
  md 
)

Definition at line 141 of file xrefs.py.

141 def extendMarkdown(self, md):
142 md.xrefs = {}
143 md.treeprocessors.register(_MdLinkFixerTreeprocessor(), 'mdlinkfixer',
144 0)
145 md.inlinePatterns.register(
146 _XrefPattern(md, self.symbols_index, self.packages), 'xref', 200)
147

Member Data Documentation

◆ packages

xrefs.XrefExtension.packages

Definition at line 139 of file xrefs.py.

◆ symbols_index

xrefs.XrefExtension.symbols_index

Definition at line 138 of file xrefs.py.


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