python.packages.createParamFiles Namespace Reference

Create doxygen param files for all packages scripts. More...

Classes
class	Flag

Functions
def	write_if_changed

Variables
string	scriptPattern_rel = "../../packages/python/*.py"
string	target_dir_rel = "../../packages/doc"
tuple	file_dir = os.path.split(__file__)
tuple	scriptPattern = os.path.abspath(os.path.join(file_dir,scriptPattern_rel))
tuple	target_dir = os.path.abspath(os.path.join(file_dir,target_dir_rel))
tuple	files = glob(scriptPattern)
list	skip = ['__init__.py', 'runStripAdjust.py', '_writeQgisProj.py', 'pyDM.py']
	delVarR_HOME = False
string	suffix_param = "Param.dox"
string	suffix_dox = ".dox"
string	header_param = "\n// This file has been automatically generated by "
string	header_dox = "\n// This file has been automatically generated by "
string	dox_template
int	counterError = 0
int	counterOk = 0
int	counterSkip = 0
tuple	fpath = os.path.abspath(f)
tuple	fname = os.path.split(f)
tuple	sname = os.path.splitext(fname)
tuple	fparam = os.path.join(target_dir,sname+suffix_param)
tuple	fdox = os.path.join(target_dir,sname+suffix_dox)
tuple	p = subprocess.Popen(['python', fpath, '-doxygen'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
	err = out
tuple	out = out.replace("\r\n","\n")
	text = header_param+out

Detailed Description

Create doxygen param files for all packages scripts.

See Also

createParamFiles

Variable Documentation

string dox_template

Initial value:

"""
/*!
\\page {0} Python script {0}

\\tableofcontents

\\see python.{0}

\\section {0}_aim Aim of module

\\copybrief python::packages::{0}

\\section {0}_general_description General description
\\copydetails python::packages::{0}

\\section {0}_parameter_description Parameter description
\\copydoc {0}Param.dox

\\section {0}_examples Examples

To be written.
*/

"""