doxybuild Namespace Reference

Functions
def	find_program (filenames)
def	do_subst_in_file (targetfile, sourcefile, dict)
def	run_doxygen (doxygen_path, config_file, working_dir, is_silent)
def	build_doc (options, make_release=False)
def	main ()

Detailed Description

Script to generate doxygen documentation.

Function Documentation

build_doc()

def doxybuild.build_doc	(		options,
			make_release = False
	)

do_subst_in_file()

def doxybuild.do_subst_in_file	(		targetfile,
			sourcefile,
			dict
	)

Replace all instances of the keys of dict with their values.
For example, if dict is {'%VERSION%': '1.2345', '%BASE%': 'MyProg'},
then all instances of %VERSION% in the file will be replaced with 1.2345 etc.

find_program()

def doxybuild.find_program

(

filenames

)

find a program in folders path_lst, and sets env[var]
@param filenames: a list of possible names of the program to search for
@return: the full path of the filename if found, or '' if filename could not be found

main()

def doxybuild.main

(

void

)

run_doxygen()

def doxybuild.run_doxygen	(		doxygen_path,
			config_file,
			working_dir,
			is_silent
	)