Class mkdoxy::generatorSnippets::GeneratorSnippets

ClassList > mkdoxy > generatorSnippets > GeneratorSnippets

Public Attributes

Type	Name
	config
	debug
	doxy_arguments
	doxygen
	finder
	generatorBase
	markdown
	page
	pageUrlPrefix
	projects
	useDirectoryUrls

Public Functions

Type	Name
def	__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)
def	codeStrip (self self, codeRaw codeRaw, str codeLanguage, int start=1, int end=None)
def	doxyClass (self self, snippet snippet, str project, dict config)
def	doxyClassHierarchy (self self, snippet snippet, str project, config config)
def	doxyClassIndex (self self, snippet snippet, str project, config config)
def	doxyClassList (self self, snippet snippet, str project, config config)
def	doxyClassMethod (self self, snippet snippet, str project, config config)
def	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.
def	doxyFileList (self self, snippet snippet, str project, config config)
def	doxyFunction (self self, snippet snippet, str project, dict config)
def	doxyNamespaceList (self self, snippet snippet, str project, config config)
str	doxyNodeIsNone (self self, str project, dict config, str snippet)
def	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)
def	is_doxy_inactive (self self, dict config)
def	is_project_exist (self self, str project)
def	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)

Public Attributes Documentation

variable config

mkdoxy.generatorSnippets.GeneratorSnippets::config;

---

variable debug

mkdoxy.generatorSnippets.GeneratorSnippets::debug;

---

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__

def 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

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

---

function doxyClass

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

---

function doxyClassHierarchy

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

---

function doxyClassIndex

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

---

function doxyClassList

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

---

function doxyClassMethod

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

---

function doxyCode

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

---

function doxyError

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

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

---

function doxyFunction

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

---

function doxyNamespaceList

def 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

def 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

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

---

function is_project_exist

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

---

function replace_markdown

def 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
) 

---

---

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