Resolve "Add documentation for environment variables"
Release notes
- Added auto-generated documentation for (CAF specific) environment variables interpreted by the framework
- Made TQPathManager's temporary storage location configurable via environment variable: "CAFTEMPDIR"
- The use of a temporary storage can now be disabled using the environment variables "CAFUSETEMPDIR" or (at lower priority if both are set) "CAFUSELOCALSTORAGE". Simply set one of these to "false", "no", or "0" to have outputs written directly to their target destination.
Details
- makeTagDoc.py now supports "env" as a trigger in addition to "tag" and "observable".
- makeTagDoc.py can now also parse python files (must end in
.pyto trigger correct parsing). Syntax for doc comments only supports single-line type comments (can be multiple single-line comments though which are concatenated, just like in the c++ case when using multiple lines with//@tag: [key] ... //@tag ... //@taginstead of/* @tag: [key] ... */). Example for use in python scripts:#@env: [CAF_PRELOAD_LIBRARIES] this env var specifies a list of library names which should be automatically loaded when the QFramework python module is loaded.
Closes #365 (closed)
Edited by Ralf Gugel