rosdoc.rdcore.RosdocContext Class Reference

List of all members.

Public Member Functions
def	__init__
def	has_builder
def	init
def	should_document
Public Attributes
	doc_packages
	docdir
	external_docs
	manifests
	name
	package_filters
	packages
	path_filters
	quiet
	rd_configs
	stack_manifests
	stacks
	template_dir
	timings
Private Member Functions
def	_crawl_deps

---

Detailed Description

Definition at line 47 of file rdcore.py.

---

Constructor & Destructor Documentation

def rosdoc.rdcore.RosdocContext.__init__	(		self,
			name,
			docdir,
			package_filters = None,
			path_filters = None
	)

Definition at line 49 of file rdcore.py.

---

Member Function Documentation

def rosdoc.rdcore.RosdocContext._crawl_deps

(

self

)

[private]

Crawl manifest.xml dependencies

Definition at line 154 of file rdcore.py.

def rosdoc.rdcore.RosdocContext.has_builder	(		self,
			package,
			builder
	)

@return: True if package is configured to use builder. NOTE:
if there is no config, package is assumed to define a doxygen
builder
@rtype: bool

Definition at line 79 of file rdcore.py.

def rosdoc.rdcore.RosdocContext.init

(

self

)

Definition at line 119 of file rdcore.py.

def rosdoc.rdcore.RosdocContext.should_document	(		self,
			package
	)

@return: True if package should be documented
@rtype: bool

Definition at line 101 of file rdcore.py.

---

Member Data Documentation

rosdoc::rdcore.RosdocContext::doc_packages

Definition at line 119 of file rdcore.py.

rosdoc::rdcore.RosdocContext::docdir

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::external_docs

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::manifests

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::name

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::package_filters

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::packages

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::path_filters

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::quiet

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::rd_configs

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::stack_manifests

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::stacks

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::template_dir

Definition at line 49 of file rdcore.py.

rosdoc::rdcore.RosdocContext::timings

Definition at line 49 of file rdcore.py.

---

The documentation for this class was generated from the following file:

• rdcore.py