Class mkdoxy::generatorAuto::GeneratorAuto

ClassList > mkdoxy > generatorAuto > GeneratorAuto

Public Attributes

Type	Name
	apiPath
	debug
	doxygen
	fullDocFiles
	generatorBase
	siteDir
	tempDoxyDir
	useDirectoryUrls

Public Functions

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

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__

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

---

function annotated

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

---

function classes

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

---

function example

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

---

function examples

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

---

function file

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

---

function fileindex

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

---

function files

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

---

function fullDoc

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

---

function hierarchy

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

---

function index

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

---

function member

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

---

function members

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

---

function modules

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

---

function namespaces

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

---

function page

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

---

function pages

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

---

function programlisting

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

---

function relatedpages

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

---

function save

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

---

function summary

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

---

---

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