XML Literate Documentation - Tangle Tool - Register

 

This documentation desribes the tool for creating libraries that require registration
to the xmlobj system.
This file is used by "toolrun" to provide information to run "tangle_tool" for
producing all of the files needed to create a library which has a register function for all it's objects
defined.



	Parameters

	
		
			objname
			jamfile_path
			src_path
			text_path
			license_path
			register
			jampathvar
			library
			lib_namespace
			typename_path
			otherlibs
			otherdlls
			ignoreobjects
			ignoreincludes
			extradefs
		
	



	objname

	The name of the object to process.



	jamfile_path

	location of the jamfile



	src_path

	location of the source



	text_path

	location of text folder (for names, disclaimers etc)



	license_path

	location of license file.



	register

	The name of the register function.



	jampathvar

	The variable name of the source path in the jam file.



	library

	The name of the library we are making



	lib_namespace

	The namespace to use for all this source.



	typename_path

	Location of the typenames (in the schema).



	otherlibs

	the schema file.



	otherdlls

	the schema file.



	ignoreobjects

	Classes which are ignored while parseing.



	ignoreincludes

	Include files for any of the ignored classes above.



	extradefs

	Extra definitions that belong at the bottom of the jam rules.