rosdoc::doxygenator Namespace Reference

Functions
def	_msg_srv_tmpl
def	_write_to_file
	utility to write string data to files and handle unicode
def	create_package_template
def	generate_doxygen
	Main entrypoint into creating doxygen files.
def	generate_msg_srv_includes
	create include files for messages and services
def	get_doxygen_version
def	header_template_name
def	load_manifest_vars
	Processes manifest for package and then generates templates for header, footer, and manifest include file.
def	run_doxygen
Variables
tuple	doxy_template = load_tmpl('doxy.template')
tuple	footer_template = load_tmpl('footer.html')
tuple	header_template = load_tmpl(header_template_filename)
tuple	header_template_filename = header_template_name()
tuple	manifest_template = load_tmpl('manifest.html')

---

Function Documentation

def rosdoc.doxygenator._msg_srv_tmpl	(		ext,
			type,
			text
	)		[private]

Parameters:

ext	str: extension (msg or srv)
type	str: type name
text	str: full text definition of type

Definition at line 50 of file doxygenator.py.

def rosdoc.doxygenator._write_to_file	(		f,
			tmpl
	)		[private]

utility to write string data to files and handle unicode

Definition at line 172 of file doxygenator.py.

def rosdoc.doxygenator.create_package_template	(		package,
			rd_config,
			m,
			path,
			html_dir,
			header_filename,
			footer_filename,
			example_path
	)

Parameters:

package	str: package name
rd_config	dict: rosdoc configuration parameters for this doxygen build
m	Manifest : package manifest
html_dir	str: directory to store doxygen files

Definition at line 75 of file doxygenator.py.

def rosdoc.doxygenator.generate_doxygen

(

ctx

)

Main entrypoint into creating doxygen files.

Returns:

[str]: list of directories in which documentation was generated (aka the list of successful packages)

Definition at line 231 of file doxygenator.py.

def rosdoc.doxygenator.generate_msg_srv_includes	(		package,
			tmp,
			to_delete
	)

create include files for messages and services

Definition at line 61 of file doxygenator.py.

def rosdoc.doxygenator.get_doxygen_version

(

)

Definition at line 183 of file doxygenator.py.

def rosdoc.doxygenator.header_template_name

(

)

Definition at line 194 of file doxygenator.py.

def rosdoc.doxygenator.load_manifest_vars	(		ctx,
			rd_config,
			package,
			path,
			docdir,
			package_htmldir,
			m
	)

Processes manifest for package and then generates templates for header, footer, and manifest include file.

Parameters:

package,:	package to create templates for package: str
rd_config,:	rosdoc configuration dictionary rd_config: dict
path,:	file path to package path: str
m,:	package manifest or None m: manifest.Manifest

Returns:

: header, footer, manifest : (str, str, str)

Definition at line 132 of file doxygenator.py.

def rosdoc.doxygenator.run_doxygen	(		package,
			doxygen_file,
			quiet = False
	)

Definition at line 212 of file doxygenator.py.

---

Variable Documentation

tuple rosdoc::doxygenator::doxy_template = load_tmpl('doxy.template')

Definition at line 337 of file doxygenator.py.

tuple rosdoc::doxygenator::footer_template = load_tmpl('footer.html')

Definition at line 344 of file doxygenator.py.

tuple rosdoc::doxygenator::header_template = load_tmpl(header_template_filename)

Definition at line 343 of file doxygenator.py.

tuple rosdoc::doxygenator::header_template_filename = header_template_name()

Definition at line 339 of file doxygenator.py.

tuple rosdoc::doxygenator::manifest_template = load_tmpl('manifest.html')

Definition at line 345 of file doxygenator.py.