Class mkdoxy::generatorAuto::GeneratorAuto

ClassList > mkdoxy > generatorAuto > GeneratorAuto

Public Attributes

Type	Name
	apiPath
	debug
	doxygen
	fullDocFiles
	generatorBase
	siteDir
	tempDoxyDir
	useDirectoryUrls

Public Functions

Type	Name
	__init__ (self self, GeneratorBase generatorBase, str tempDoxyDir, str siteDir, str apiPath, Doxygen doxygen, bool useDirectoryUrls)
	annotated (self self, nodes nodes, dict config=None)
	classes (self self, nodes nodes, dict config=None)
	example (self self, Node node, dict config=None)
	examples (self self, nodes nodes, dict config=None)
	file (self self, Node node, dict config=None)
	fileindex (self self, nodes nodes, dict config=None)
	files (self self, nodes nodes, dict config=None)
	fullDoc (self self, dict defaultTemplateConfig)
	hierarchy (self self, nodes nodes, dict config=None)
	index (self self, nodes nodes, Kind kind_filters, kind_parents kind_parents, str title, dict config=None)
	member (self self, Node node, dict config=None)
	members (self self, nodes nodes, dict config=None)
	modules (self self, nodes nodes, dict config=None)
	namespaces (self self, nodes nodes, dict config=None)
	page (self self, Node node, dict config=None)
	pages (self self, nodes nodes, dict config=None)
	programlisting (self self, node node, dict config=None)
	relatedpages (self self, nodes nodes, dict config=None)
	save (self self, str path, str output)
	summary (self self, dict defaultTemplateConfig)

Protected Functions

Type	Name
	_generate_recursive (self self, str output_summary, Node node, int level)
	_generate_recursive_examples (self self, str output_summary, Node node, int level)
	_generate_recursive_files (self self, str output_summary, Node node, int level, dict config=None)
	_generate_recursive_groups (self self, str output_summary, Node node, int level)
	_generate_recursive_pages (self self, str output_summary, Node node, int level)

Public Attributes Documentation

variable apiPath

mkdoxy.generatorAuto.GeneratorAuto::apiPath;

---

variable debug

mkdoxy.generatorAuto.GeneratorAuto::debug;

---

variable doxygen

mkdoxy.generatorAuto.GeneratorAuto::doxygen;

---

variable fullDocFiles

mkdoxy.generatorAuto.GeneratorAuto::fullDocFiles;

---

variable generatorBase

mkdoxy.generatorAuto.GeneratorAuto::generatorBase;

---

variable siteDir

mkdoxy.generatorAuto.GeneratorAuto::siteDir;

---

variable tempDoxyDir

mkdoxy.generatorAuto.GeneratorAuto::tempDoxyDir;

---

variable useDirectoryUrls

mkdoxy.generatorAuto.GeneratorAuto::useDirectoryUrls;

---

Public Functions Documentation

function __init__

mkdoxy::generatorAuto::GeneratorAuto::__init__ (
    self self,
    GeneratorBase generatorBase,
    str tempDoxyDir,
    str siteDir,
    str apiPath,
    Doxygen doxygen,
    bool useDirectoryUrls
) 

---

function annotated

mkdoxy::generatorAuto::GeneratorAuto::annotated (
    self self,
    nodes nodes,
    dict config=None
) 

---

function classes

mkdoxy::generatorAuto::GeneratorAuto::classes (
    self self,
    nodes nodes,
    dict config=None
) 

---

function example

mkdoxy::generatorAuto::GeneratorAuto::example (
    self self,
    Node node,
    dict config=None
) 

---

function examples

mkdoxy::generatorAuto::GeneratorAuto::examples (
    self self,
    nodes nodes,
    dict config=None
) 

---

function file

mkdoxy::generatorAuto::GeneratorAuto::file (
    self self,
    Node node,
    dict config=None
) 

---

function fileindex

mkdoxy::generatorAuto::GeneratorAuto::fileindex (
    self self,
    nodes nodes,
    dict config=None
) 

---

function files

mkdoxy::generatorAuto::GeneratorAuto::files (
    self self,
    nodes nodes,
    dict config=None
) 

---

function fullDoc

mkdoxy::generatorAuto::GeneratorAuto::fullDoc (
    self self,
    dict defaultTemplateConfig
) 

---

function hierarchy

mkdoxy::generatorAuto::GeneratorAuto::hierarchy (
    self self,
    nodes nodes,
    dict config=None
) 

---

function index

mkdoxy::generatorAuto::GeneratorAuto::index (
    self self,
    nodes nodes,
    Kind kind_filters,
    kind_parents kind_parents,
    str title,
    dict config=None
) 

---

function member

mkdoxy::generatorAuto::GeneratorAuto::member (
    self self,
    Node node,
    dict config=None
) 

---

function members

mkdoxy::generatorAuto::GeneratorAuto::members (
    self self,
    nodes nodes,
    dict config=None
) 

---

function modules

mkdoxy::generatorAuto::GeneratorAuto::modules (
    self self,
    nodes nodes,
    dict config=None
) 

---

function namespaces

mkdoxy::generatorAuto::GeneratorAuto::namespaces (
    self self,
    nodes nodes,
    dict config=None
) 

---

function page

mkdoxy::generatorAuto::GeneratorAuto::page (
    self self,
    Node node,
    dict config=None
) 

---

function pages

mkdoxy::generatorAuto::GeneratorAuto::pages (
    self self,
    nodes nodes,
    dict config=None
) 

---

function programlisting

mkdoxy::generatorAuto::GeneratorAuto::programlisting (
    self self,
    node node,
    dict config=None
) 

---

function relatedpages

mkdoxy::generatorAuto::GeneratorAuto::relatedpages (
    self self,
    nodes nodes,
    dict config=None
) 

---

function save

mkdoxy::generatorAuto::GeneratorAuto::save (
    self self,
    str path,
    str output
) 

---

function summary

mkdoxy::generatorAuto::GeneratorAuto::summary (
    self self,
    dict defaultTemplateConfig
) 

---

Protected Functions Documentation

function _generate_recursive

mkdoxy::generatorAuto::GeneratorAuto::_generate_recursive (
    self self,
    str output_summary,
    Node node,
    int level
) 

---

function _generate_recursive_examples

mkdoxy::generatorAuto::GeneratorAuto::_generate_recursive_examples (
    self self,
    str output_summary,
    Node node,
    int level
) 

---

function _generate_recursive_files

mkdoxy::generatorAuto::GeneratorAuto::_generate_recursive_files (
    self self,
    str output_summary,
    Node node,
    int level,
    dict config=None
) 

---

function _generate_recursive_groups

mkdoxy::generatorAuto::GeneratorAuto::_generate_recursive_groups (
    self self,
    str output_summary,
    Node node,
    int level
) 

---

function _generate_recursive_pages

mkdoxy::generatorAuto::GeneratorAuto::_generate_recursive_pages (
    self self,
    str output_summary,
    Node node,
    int level
) 

---

---

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