Class mkdoxy::generatorSnippets::GeneratorSnippets¶

ClassList > mkdoxy > generatorSnippets > GeneratorSnippets

Public Attributes¶

Type	Name
	config
	debug
	doxyClass
	doxyClassHierarchy
	doxyClassIndex
	doxyClassList
	doxyClassMethod
	doxyCode
	doxyFileList
	doxyFunction
	doxyNamespaceFunction
	doxyNamespaceList
	doxy_arguments
	doxygen
	finder
	generatorBase
	markdown
	page
	pageUrlPrefix
	projects
	useDirectoryUrls

Public Functions¶

Type	Name
	__init__ (self self, str markdown, dict generatorBase, dict doxygen, dict] projects, bool useDirectoryUrls, pages.Page page, dict config, bool debug=False)
str	call_doxy_by_name (self self, snippet snippet, str project, str argument, dict config)
bool	checkConfig (self self, snippet snippet, str project, config config, required_params required_params)
	codeStrip (self self, codeRaw codeRaw, str codeLanguage, int start=1, int end=None)
	doxyClass (self self, snippet snippet, str project, dict config)
	doxyClassHierarchy (self self, snippet snippet, str project, config config)
	doxyClassIndex (self self, snippet snippet, str project, config config)
	doxyClassList (self self, snippet snippet, str project, config config)
	doxyClassMethod (self self, snippet snippet, str project, config config)
	doxyCode (self self, snippet snippet, str project, config config)
str	doxyError (self self, project project, dict config, str title, str description, str code_header="", str code="", str code_language="", str snippet_code="") Create documentation generator callbacks.
	doxyFileList (self self, snippet snippet, str project, config config)
	doxyFunction (self self, snippet snippet, str project, dict config)
	doxyNamespaceFunction (self self, snippet snippet, str project, config config)
	doxyNamespaceList (self self, snippet snippet, str project, config config)
str	doxyNodeIsNone (self self, str project, dict config, str snippet)
	generate (self self)
str	incorrect_argument (self self, str project, str argument, dict config, str snippet)
str	incorrect_project (self self, str project, dict config, str snippet)
	is_doxy_inactive (self self, dict config)
	is_project_exist (self self, str project)
	replace_markdown (self self, int start, int end, str replacement)
dict	try_load_yaml (self self, str yaml_raw, str project, str snippet, dict config)

Protected Functions¶

Type	Name
	_setLinkPrefixNode (self self, Node node, str linkPrefix)
	_setLinkPrefixNodes (self self, list nodes, str linkPrefix)

Public Attributes Documentation¶

variable config¶

mkdoxy.generatorSnippets.GeneratorSnippets::config;

variable debug¶

mkdoxy.generatorSnippets.GeneratorSnippets::debug;

variable doxyClass [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyClass;

variable doxyClassHierarchy [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyClassHierarchy;

variable doxyClassIndex [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyClassIndex;

variable doxyClassList [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyClassList;

variable doxyClassMethod [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyClassMethod;

variable doxyCode [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyCode;

variable doxyFileList [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyFileList;

variable doxyFunction [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyFunction;

variable doxyNamespaceFunction [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyNamespaceFunction;

variable doxyNamespaceList [1/2]¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxyNamespaceList;

variable doxy_arguments¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxy_arguments;

variable doxygen¶

mkdoxy.generatorSnippets.GeneratorSnippets::doxygen;

variable finder¶

mkdoxy.generatorSnippets.GeneratorSnippets::finder;

variable generatorBase¶

mkdoxy.generatorSnippets.GeneratorSnippets::generatorBase;

variable markdown¶

mkdoxy.generatorSnippets.GeneratorSnippets::markdown;

variable page¶

mkdoxy.generatorSnippets.GeneratorSnippets::page;

variable pageUrlPrefix¶

mkdoxy.generatorSnippets.GeneratorSnippets::pageUrlPrefix;

variable projects¶

mkdoxy.generatorSnippets.GeneratorSnippets::projects;

variable useDirectoryUrls¶

mkdoxy.generatorSnippets.GeneratorSnippets::useDirectoryUrls;

Public Functions Documentation¶

function init¶

mkdoxy::generatorSnippets::GeneratorSnippets::__init__ (
    self self,
    str markdown,
    dict generatorBase,
    dict doxygen,
    dict] projects,
    bool useDirectoryUrls,
    pages.Page page,
    dict config,
    bool debug=False
)

function call_doxy_by_name¶

str mkdoxy::generatorSnippets::GeneratorSnippets::call_doxy_by_name (
    self self,
    snippet snippet,
    str project,
    str argument,
    dict config
)

function checkConfig¶

bool mkdoxy::generatorSnippets::GeneratorSnippets::checkConfig (
    self self,
    snippet snippet,
    str project,
    config config,
    required_params required_params
)

function codeStrip¶

mkdoxy::generatorSnippets::GeneratorSnippets::codeStrip (
    self self,
    codeRaw codeRaw,
    str codeLanguage,
    int start=1,
    int end=None
)

function doxyClass [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyClass (
    self self,
    snippet snippet,
    str project,
    dict config
)

function doxyClassHierarchy [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyClassHierarchy (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyClassIndex [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyClassIndex (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyClassList [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyClassList (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyClassMethod [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyClassMethod (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyCode [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyCode (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyError¶

Create documentation generator callbacks.

str mkdoxy::generatorSnippets::GeneratorSnippets::doxyError (
    self self,
    project project,
    dict config,
    str title,
    str description,
    str code_header="",
    str code="",
    str code_language="",
    str snippet_code=""
)

function doxyFileList [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyFileList (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyFunction [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyFunction (
    self self,
    snippet snippet,
    str project,
    dict config
)

function doxyNamespaceFunction [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyNamespaceFunction (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyNamespaceList [2/2]¶

mkdoxy::generatorSnippets::GeneratorSnippets::doxyNamespaceList (
    self self,
    snippet snippet,
    str project,
    config config
)

function doxyNodeIsNone¶

str mkdoxy::generatorSnippets::GeneratorSnippets::doxyNodeIsNone (
    self self,
    str project,
    dict config,
    str snippet
)

function generate¶

mkdoxy::generatorSnippets::GeneratorSnippets::generate (
    self self
)

function incorrect_argument¶

str mkdoxy::generatorSnippets::GeneratorSnippets::incorrect_argument (
    self self,
    str project,
    str argument,
    dict config,
    str snippet
)

function incorrect_project¶

str mkdoxy::generatorSnippets::GeneratorSnippets::incorrect_project (
    self self,
    str project,
    dict config,
    str snippet
)

function is_doxy_inactive¶

mkdoxy::generatorSnippets::GeneratorSnippets::is_doxy_inactive (
    self self,
    dict config
)

function is_project_exist¶

mkdoxy::generatorSnippets::GeneratorSnippets::is_project_exist (
    self self,
    str project
)

function replace_markdown¶

mkdoxy::generatorSnippets::GeneratorSnippets::replace_markdown (
    self self,
    int start,
    int end,
    str replacement
)

function try_load_yaml¶

dict mkdoxy::generatorSnippets::GeneratorSnippets::try_load_yaml (
    self self,
    str yaml_raw,
    str project,
    str snippet,
    dict config
)

Protected Functions Documentation¶

function _setLinkPrefixNode¶

mkdoxy::generatorSnippets::GeneratorSnippets::_setLinkPrefixNode (
    self self,
    Node node,
    str linkPrefix
)

function _setLinkPrefixNodes¶

mkdoxy::generatorSnippets::GeneratorSnippets::_setLinkPrefixNodes (
    self self,
    list nodes,
    str linkPrefix
)

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

Class mkdoxy::generatorSnippets::GeneratorSnippets¶

Public Attributes¶

Public Functions¶

Protected Functions¶

Public Attributes Documentation¶

variable config¶

variable debug¶

variable doxyClass [1/2]¶

variable doxyClassHierarchy [1/2]¶

variable doxyClassIndex [1/2]¶

variable doxyClassList [1/2]¶

variable doxyClassMethod [1/2]¶

variable doxyCode [1/2]¶

variable doxyFileList [1/2]¶

variable doxyFunction [1/2]¶

variable doxyNamespaceFunction [1/2]¶

variable doxyNamespaceList [1/2]¶

variable doxy_arguments¶

variable doxygen¶

variable finder¶

variable generatorBase¶

variable markdown¶

variable page¶

variable pageUrlPrefix¶

variable projects¶

variable useDirectoryUrls¶

Public Functions Documentation¶

function __init__¶

function call_doxy_by_name¶

function checkConfig¶

function codeStrip¶

function doxyClass [2/2]¶

function doxyClassHierarchy [2/2]¶

function doxyClassIndex [2/2]¶

function doxyClassList [2/2]¶

function doxyClassMethod [2/2]¶

function doxyCode [2/2]¶

function doxyError¶

function doxyFileList [2/2]¶

function doxyFunction [2/2]¶

function doxyNamespaceFunction [2/2]¶

function doxyNamespaceList [2/2]¶

function doxyNodeIsNone¶

function generate¶

function incorrect_argument¶

function incorrect_project¶

function is_doxy_inactive¶

function is_project_exist¶

function replace_markdown¶

function try_load_yaml¶

Protected Functions Documentation¶

function _setLinkPrefixNode¶

function _setLinkPrefixNodes¶

function init¶