Class mkdoxy::node::Node¶

ClassList > mkdoxy > node > Node

Public Attributes¶

Type	Name
	children
	debug
	project

Public Functions¶

Type	Name
	__init__ (self self, str xml_file, Element xml, ProjectContext project, XmlParser parser, "Node" parent, str refid=None, bool debug=False)
	__repr__ (self self)
	add_child (self self, "Node" child)
str	anchor (self self)
["Node"]	base_classes (self self)
str	base_name (self self)
str	base_url (self self)
str	brief (self self)
["Node"]	children (self self)
str	code_language (self self)
str	codeblock (self self)
str	definition (self self)
["Node"]	derived_classes (self self)
str	details (self self)
str	filename (self self)
bool	has (self self, str visibility, kinds kinds, bool static)
bool	has_base_classes (self self)
bool	has_brief (self self)
bool	has_children (self self)
bool	has_definition (self self)
bool	has_derived_classes (self self)
bool	has_details (self self)
bool	has_includes (self self)
bool	has_initializer (self self)
bool	has_location (self self)
bool	has_params (self self)
bool	has_programlisting (self self)
bool	has_specifiers (self self)
bool	has_templateparams (self self)
bool	has_type (self self)
bool	has_values (self self)
str	includes (self self)
str	initializer (self self)
bool	is_class (self self)
bool	is_class_or_struct (self self)
bool	is_const (self self)
bool	is_define (self self)
bool	is_dir (self self)
bool	is_enum (self self)
bool	is_example (self self)
bool	is_explicit (self self)
bool	is_file (self self)
bool	is_friend (self self)
bool	is_function (self self)
bool	is_group (self self)
bool	is_inline (self self)
bool	is_interface (self self)
bool	is_language (self self)
bool	is_mutable (self self)
bool	is_namespace (self self)
bool	is_operator (self self)
bool	is_overloaded (self self)
bool	is_page (self self)
bool	is_parent (self self)
bool	is_pure (self self)
bool	is_resolved (self self)
bool	is_root (self self)
bool	is_static (self self)
bool	is_struct (self self)
bool	is_typedef (self self)
bool	is_union (self self)
bool	is_variable (self self)
bool	is_virtual (self self)
str	kind (self self)
str	location (self self)
int	location_bodyend (self self)
int	location_bodystart (self self)
str	name (self self)
str	name_full_unescaped (self self)
str	name_long (self self)
str	name_params (self self)
str	name_short (self self)
[str]	name_tokens (self self)
str	name_url_safe (self self)
int	operator_num (self self)
int	operators_total (self self)
int	overload_num (self self)
str	overload_suffix (self self)
int	overload_total (self self)
str	params (self self)
"Node"	parent (self self)
["Node"]	parents (self self)
str	prefix (self self)
str	print_node_recursive (self self)
str	programlisting (self self)
["Node"]	query (self self, str visibility, kinds kinds, bool static)
str	refid (self self)
"Node"	reimplements (self self)
"Node"	root (self self)
	sort_children (self self)
str	specifiders (self self)
str	suffix (self self)
str	templateparams (self self)
str	title (self self)
str	type (self self)
str	url (self self)
str	url_source (self self)
str	values (self self)

Protected Attributes¶

Type	Name
	_brief
	_cache
	_children
	_const
	_definition
	_details
	_dirname
	_explicit
	_includes
	_initializer
	_inline
	_kind
	_language
	_location
	_mutable
	_name
	_params
	_parent
	_parser
	_programlisting
	_pure
	_refid
	_specifiers
	_static
	_templateparams
	_title
	_type
	_values
	_virtual
	_visibility
	_xml

Protected Functions¶

Type	Name
	_check_attrs (self self)
	_check_for_children (self self)
str	_print_node_recursive_md (self self, Element node, int depth)

Public Attributes Documentation¶

variable children [1/2]¶

mkdoxy.node.Node::children;

variable debug¶

mkdoxy.node.Node::debug;

variable project¶

mkdoxy.node.Node::project;

Public Functions Documentation¶

function init¶

mkdoxy::node::Node::__init__ (
    self self,
    str xml_file,
    Element xml,
    ProjectContext project,
    XmlParser parser,
    "Node" parent,
    str refid=None,
    bool debug=False
)

function repr¶

mkdoxy::node::Node::__repr__ (
    self self
)

function add_child¶

mkdoxy::node::Node::add_child (
    self self,
    "Node" child
)

function anchor¶

str mkdoxy::node::Node::anchor (
    self self
)

function base_classes¶

["Node"] mkdoxy::node::Node::base_classes (
    self self
)

function base_name¶

str mkdoxy::node::Node::base_name (
    self self
)

function base_url¶

str mkdoxy::node::Node::base_url (
    self self
)

function brief¶

str mkdoxy::node::Node::brief (
    self self
)

function children [2/2]¶

["Node"] mkdoxy::node::Node::children (
    self self
)

function code_language¶

str mkdoxy::node::Node::code_language (
    self self
)

function codeblock¶

str mkdoxy::node::Node::codeblock (
    self self
)

function definition¶

str mkdoxy::node::Node::definition (
    self self
)

function derived_classes¶

["Node"] mkdoxy::node::Node::derived_classes (
    self self
)

function details¶

str mkdoxy::node::Node::details (
    self self
)

function filename¶

str mkdoxy::node::Node::filename (
    self self
)

function has¶

bool mkdoxy::node::Node::has (
    self self,
    str visibility,
    kinds kinds,
    bool static
)

function has_base_classes¶

bool mkdoxy::node::Node::has_base_classes (
    self self
)

function has_brief¶

bool mkdoxy::node::Node::has_brief (
    self self
)

function has_children¶

bool mkdoxy::node::Node::has_children (
    self self
)

function has_definition¶

bool mkdoxy::node::Node::has_definition (
    self self
)

function has_derived_classes¶

bool mkdoxy::node::Node::has_derived_classes (
    self self
)

function has_details¶

bool mkdoxy::node::Node::has_details (
    self self
)

function has_includes¶

bool mkdoxy::node::Node::has_includes (
    self self
)

function has_initializer¶

bool mkdoxy::node::Node::has_initializer (
    self self
)

function has_location¶

bool mkdoxy::node::Node::has_location (
    self self
)

function has_params¶

bool mkdoxy::node::Node::has_params (
    self self
)

function has_programlisting¶

bool mkdoxy::node::Node::has_programlisting (
    self self
)

function has_specifiers¶

bool mkdoxy::node::Node::has_specifiers (
    self self
)

function has_templateparams¶

bool mkdoxy::node::Node::has_templateparams (
    self self
)

function has_type¶

bool mkdoxy::node::Node::has_type (
    self self
)

function has_values¶

bool mkdoxy::node::Node::has_values (
    self self
)

function includes¶

str mkdoxy::node::Node::includes (
    self self
)

function initializer¶

str mkdoxy::node::Node::initializer (
    self self
)

function is_class¶

bool mkdoxy::node::Node::is_class (
    self self
)

function is_class_or_struct¶

bool mkdoxy::node::Node::is_class_or_struct (
    self self
)

function is_const¶

bool mkdoxy::node::Node::is_const (
    self self
)

function is_define¶

bool mkdoxy::node::Node::is_define (
    self self
)

function is_dir¶

bool mkdoxy::node::Node::is_dir (
    self self
)

function is_enum¶

bool mkdoxy::node::Node::is_enum (
    self self
)

function is_example¶

bool mkdoxy::node::Node::is_example (
    self self
)

function is_explicit¶

bool mkdoxy::node::Node::is_explicit (
    self self
)

function is_file¶

bool mkdoxy::node::Node::is_file (
    self self
)

function is_friend¶

bool mkdoxy::node::Node::is_friend (
    self self
)

function is_function¶

bool mkdoxy::node::Node::is_function (
    self self
)

function is_group¶

bool mkdoxy::node::Node::is_group (
    self self
)

function is_inline¶

bool mkdoxy::node::Node::is_inline (
    self self
)

function is_interface¶

bool mkdoxy::node::Node::is_interface (
    self self
)

function is_language¶

bool mkdoxy::node::Node::is_language (
    self self
)

function is_mutable¶

bool mkdoxy::node::Node::is_mutable (
    self self
)

function is_namespace¶

bool mkdoxy::node::Node::is_namespace (
    self self
)

function is_operator¶

bool mkdoxy::node::Node::is_operator (
    self self
)

function is_overloaded¶

bool mkdoxy::node::Node::is_overloaded (
    self self
)

function is_page¶

bool mkdoxy::node::Node::is_page (
    self self
)

function is_parent¶

bool mkdoxy::node::Node::is_parent (
    self self
)

function is_pure¶

bool mkdoxy::node::Node::is_pure (
    self self
)

function is_resolved¶

bool mkdoxy::node::Node::is_resolved (
    self self
)

function is_root¶

bool mkdoxy::node::Node::is_root (
    self self
)

function is_static¶

bool mkdoxy::node::Node::is_static (
    self self
)

function is_struct¶

bool mkdoxy::node::Node::is_struct (
    self self
)

function is_typedef¶

bool mkdoxy::node::Node::is_typedef (
    self self
)

function is_union¶

bool mkdoxy::node::Node::is_union (
    self self
)

function is_variable¶

bool mkdoxy::node::Node::is_variable (
    self self
)

function is_virtual¶

bool mkdoxy::node::Node::is_virtual (
    self self
)

function kind¶

str mkdoxy::node::Node::kind (
    self self
)

function location¶

str mkdoxy::node::Node::location (
    self self
)

function location_bodyend¶

int mkdoxy::node::Node::location_bodyend (
    self self
)

function location_bodystart¶

int mkdoxy::node::Node::location_bodystart (
    self self
)

function name¶

str mkdoxy::node::Node::name (
    self self
)

function name_full_unescaped¶

str mkdoxy::node::Node::name_full_unescaped (
    self self
)

function name_long¶

str mkdoxy::node::Node::name_long (
    self self
)

function name_params¶

str mkdoxy::node::Node::name_params (
    self self
)

function name_short¶

str mkdoxy::node::Node::name_short (
    self self
)

function name_tokens¶

[str] mkdoxy::node::Node::name_tokens (
    self self
)

function name_url_safe¶

str mkdoxy::node::Node::name_url_safe (
    self self
)

function operator_num¶

int mkdoxy::node::Node::operator_num (
    self self
)

function operators_total¶

int mkdoxy::node::Node::operators_total (
    self self
)

function overload_num¶

int mkdoxy::node::Node::overload_num (
    self self
)

function overload_suffix¶

str mkdoxy::node::Node::overload_suffix (
    self self
)

function overload_total¶

int mkdoxy::node::Node::overload_total (
    self self
)

function params¶

str mkdoxy::node::Node::params (
    self self
)

function parent¶

"Node" mkdoxy::node::Node::parent (
    self self
)

function parents¶

["Node"] mkdoxy::node::Node::parents (
    self self
)

function prefix¶

str mkdoxy::node::Node::prefix (
    self self
)

function print_node_recursive¶

str mkdoxy::node::Node::print_node_recursive (
    self self
)

function programlisting¶

str mkdoxy::node::Node::programlisting (
    self self
)

function query¶

["Node"] mkdoxy::node::Node::query (
    self self,
    str visibility,
    kinds kinds,
    bool static
)

function refid¶

str mkdoxy::node::Node::refid (
    self self
)

function reimplements¶

"Node" mkdoxy::node::Node::reimplements (
    self self
)

function root¶

"Node" mkdoxy::node::Node::root (
    self self
)

function sort_children¶

mkdoxy::node::Node::sort_children (
    self self
)

function specifiders¶

str mkdoxy::node::Node::specifiders (
    self self
)

function suffix¶

str mkdoxy::node::Node::suffix (
    self self
)

function templateparams¶

str mkdoxy::node::Node::templateparams (
    self self
)

function title¶

str mkdoxy::node::Node::title (
    self self
)

function type¶

str mkdoxy::node::Node::type (
    self self
)

function url¶

str mkdoxy::node::Node::url (
    self self
)

function url_source¶

str mkdoxy::node::Node::url_source (
    self self
)

function values¶

str mkdoxy::node::Node::values (
    self self
)

Protected Attributes Documentation¶

variable _brief¶

mkdoxy.node.Node::_brief;

variable _cache¶

mkdoxy.node.Node::_cache;

variable _children¶

mkdoxy.node.Node::_children;

variable _const¶

mkdoxy.node.Node::_const;

variable _definition¶

mkdoxy.node.Node::_definition;

variable _details¶

mkdoxy.node.Node::_details;

variable _dirname¶

mkdoxy.node.Node::_dirname;

variable _explicit¶

mkdoxy.node.Node::_explicit;

variable _includes¶

mkdoxy.node.Node::_includes;

variable _initializer¶

mkdoxy.node.Node::_initializer;

variable _inline¶

mkdoxy.node.Node::_inline;

variable _kind¶

mkdoxy.node.Node::_kind;

variable _language¶

mkdoxy.node.Node::_language;

variable _location¶

mkdoxy.node.Node::_location;

variable _mutable¶

mkdoxy.node.Node::_mutable;

variable _name¶

mkdoxy.node.Node::_name;

variable _params¶

mkdoxy.node.Node::_params;

variable _parent¶

mkdoxy.node.Node::_parent;

variable _parser¶

mkdoxy.node.Node::_parser;

variable _programlisting¶

mkdoxy.node.Node::_programlisting;

variable _pure¶

mkdoxy.node.Node::_pure;

variable _refid¶

mkdoxy.node.Node::_refid;

variable _specifiers¶

mkdoxy.node.Node::_specifiers;

variable _static¶

mkdoxy.node.Node::_static;

variable _templateparams¶

mkdoxy.node.Node::_templateparams;

variable _title¶

mkdoxy.node.Node::_title;

variable _type¶

mkdoxy.node.Node::_type;

variable _values¶

mkdoxy.node.Node::_values;

variable _virtual¶

mkdoxy.node.Node::_virtual;

variable _visibility¶

mkdoxy.node.Node::_visibility;

variable _xml¶

mkdoxy.node.Node::_xml;

Protected Functions Documentation¶

function _check_attrs¶

mkdoxy::node::Node::_check_attrs (
    self self
)

function _check_for_children¶

mkdoxy::node::Node::_check_for_children (
    self self
)

function _print_node_recursive_md¶

str mkdoxy::node::Node::_print_node_recursive_md (
    self self,
    Element node,
    int depth
)

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

Class mkdoxy::node::Node¶

Public Attributes¶

Public Functions¶

Protected Attributes¶

Protected Functions¶

Public Attributes Documentation¶

variable children [1/2]¶

variable debug¶

variable project¶

Public Functions Documentation¶

function __init__¶

function __repr__¶

function add_child¶

function anchor¶

function base_classes¶

function base_name¶

function base_url¶

function brief¶

function children [2/2]¶

function code_language¶

function codeblock¶

function definition¶

function derived_classes¶

function details¶

function filename¶

function has¶

function has_base_classes¶

function has_brief¶

function has_children¶

function has_definition¶

function has_derived_classes¶

function has_details¶

function has_includes¶

function has_initializer¶

function has_location¶

function has_params¶

function has_programlisting¶

function has_specifiers¶

function has_templateparams¶

function has_type¶

function has_values¶

function includes¶

function initializer¶

function is_class¶

function is_class_or_struct¶

function is_const¶

function is_define¶

function is_dir¶

function is_enum¶

function is_example¶

function is_explicit¶

function is_file¶

function is_friend¶

function is_function¶

function is_group¶

function is_inline¶

function is_interface¶

function is_language¶

function is_mutable¶

function is_namespace¶

function is_operator¶

function is_overloaded¶

function is_page¶

function is_parent¶

function is_pure¶

function is_resolved¶

function is_root¶

function is_static¶

function is_struct¶

function is_typedef¶

function is_union¶

function is_variable¶

function is_virtual¶

function kind¶

function location¶

function location_bodyend¶

function location_bodystart¶

function name¶

function name_full_unescaped¶

function name_long¶

function init¶

function repr¶