python.packages.createParamFiles Namespace Reference

Classes
class	Flag

Functions
def	write_if_changed (f, text, header=None)

Variables
string	process_encoding = 'latin1'
string	read_encoding = 'latin1'
string	scriptPattern_rel = "../../packages/python/*.py"
string	target_dir_rel = "../../packages/doc"
	file_dir = os.path.split(__file__)[0]
	scriptPattern = os.path.abspath(os.path.join(file_dir,scriptPattern_rel))
	target_dir = os.path.abspath(os.path.join(file_dir,target_dir_rel))
	files = glob(scriptPattern)
list	skip = ['__init__.py', 'runStripAdjust.py', '_writeQgisProj.py', 'pyDM.py', 'metaShape2stripAdjust.py']
bool	delVarR_HOME = False
string	suffix_param = "Param.xml"
string	suffix_dox = ".dox"
	opals_root_dir = os.path.abspath(__file__+"/../../../..")
	reducedFilePath = os.path.abspath(__file__).split(opals_root_dir)[1][1:]
string	header_param = "<!-- This file has been automatically generated by "+reducedFilePath+" - do not edit! --> \n\n"
string	header_dox = "\n// This file has been automatically generated by "+reducedFilePath+" - remove this header line to avoid overwriting in the future!\n\n"
int	max_compare_len = 50
string	dox_template
int	counterError = 0
int	counterOk = 0
int	counterSkip = 0
	fpath = os.path.abspath(f)
	fname = os.path.split(f)[1]
	sname = os.path.splitext(fname)[0]
	fparam = os.path.join(target_dir,sname+suffix_param)
	fdox = os.path.join(target_dir,sname+suffix_dox)
	end
	p
	out = out.replace("\r\n","\n")
	err = out
string	text = header_param+out

Detailed Description

Create doxygen param files for all packages scripts

See also

createParamFiles

Variable Documentation

dox_template

string dox_template

Initial value:

= header_dox+"""
/*!
\\page {0} Python script {0}
 
\\tableofcontents
 
\\see python.packages.{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
\\include{{doc}} {0}Param.xml
 
\\section {0}_examples Examples
 
To be written.
*/
 
"""

p

p

Initial value:

=  subprocess.Popen([sys.executable, fpath, '-_doxygen'], stdout=subprocess.PIPE, stderr=subprocess.PIPE,
                         encoding=process_encoding)