Skip to content

Namespace mkdoxy::filters

Namespace List > mkdoxy > filters

Public Attributes

Type Name
PLAIN_CODE_BLOCK = = re.compile(r"(\n.\*?\n)", re.DOTALL)

Public Functions

Type Name
def use_code_language (value value, Optional code_language)
Jinja2 filter to apply a code language to all plain code blocks.

Public Attributes Documentation

variable PLAIN_CODE_BLOCK

mkdoxy::filters.PLAIN_CODE_BLOCK;

Public Functions Documentation

function use_code_language

Jinja2 filter to apply a code language to all plain code blocks.

def mkdoxy::filters::use_code_language (
    value value,
    Optional code_language
) 

Parameters:

  • value the value to apply the filter to.
  • code_language (str|None): the code language to apply.
Returns:

The filtered value.



The documentation for this class was generated from the following file mkdoxy/filters.py