BuilderDoxygen Namespace Reference

Functions
	DoxyfileParse (file_contents, conf_dir, data=None)
	Parse a Doxygen source file and return a dictionary of all the values.
	DoxySourceFiles (node, env)
	Scan the given node's contents (a Doxygen file) and add any files used to generate docs to the list of source files.
	DoxySourceScan (node, env, path)
	Doxygen Doxyfile source scanner.
	DoxySourceScanCheck (node, env)
	Check if we should scan this file.
	DoxyEmitter (target, source, env)
	Doxygen Doxyfile emitter.
	generate (env)
	Add builders and construction variables for the Doxygen tool.
	exists (env)
	Make sure doxygen exists.

Variables
dict	output_formats

Function Documentation

DoxyfileParse()

DoxyfileParse	(		file_contents,
			conf_dir,
			data = None
	)

Parse a Doxygen source file and return a dictionary of all the values.

Values will be strings and lists of strings.

Definition at line 49 of file BuilderDoxygen.py.

References DoxyfileParse().

Referenced by DoxyfileParse(), and DoxySourceFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

DoxySourceFiles()

DoxySourceFiles	(		node,
			env
	)

Scan the given node's contents (a Doxygen file) and add any files used to generate docs to the list of source files.

Definition at line 137 of file BuilderDoxygen.py.

References DoxyfileParse().

Referenced by DoxySourceScan().

Here is the call graph for this function:

Here is the caller graph for this function:

DoxySourceScan()

DoxySourceScan	(		node,
			env,
			path
	)

Doxygen Doxyfile source scanner.

This should scan the Doxygen file and add any files used to generate docs to the list of source files.

Definition at line 273 of file BuilderDoxygen.py.

References DoxySourceFiles().

Here is the call graph for this function:

DoxySourceScanCheck()

DoxySourceScanCheck	(		node,
			env
	)

Check if we should scan this file.

Definition at line 283 of file BuilderDoxygen.py.

DoxyEmitter()

DoxyEmitter	(		target,
			source,
			env
	)

Doxygen Doxyfile emitter.

Definition at line 288 of file BuilderDoxygen.py.

generate()

generate

(

env

)

Add builders and construction variables for the Doxygen tool.

This is currently for Doxygen 1.4.6.

Definition at line 371 of file BuilderDoxygen.py.

exists()

exists

(

env

)

Make sure doxygen exists.

Definition at line 403 of file BuilderDoxygen.py.

Variable Documentation

output_formats

dict output_formats

Initial value:

=  {
    "HTML": ("YES", "html", "index", ".html", "HTML_FILE_EXTENSION"),
    "LATEX": ("YES", "latex", "refman", ".tex", ""),
    "RTF": ("NO", "rtf", "refman", ".rtf", ""),
    "MAN": ("NO", "man", "", ".3", "MAN_EXTENSION"),
    "XML": ("NO", "xml", "index", ".xml", ""),
}

Definition at line 40 of file BuilderDoxygen.py.