Maslosoft Zamm Documentation
Zamm is a documentation tool
Zamm Configuration Guide
Configuration variables
Following public properies are defined to configure behavior of Zamm generator.
Default values should suffice. These can also be configured in .zamm.yml.
| Property | Documentation |
|---|---|
$converters |
Converters
Array of class names of converters. These will be applied in order specified here, to all files.
All converters should implement |
$decorators |
Configuration of decorators. This should be array with keys of renderer interface names and values of decorator classes. |
$extractor |
Extractor class name.
This class will be used to extract source fragments. Defaults to |
$fileDecorators |
Configuration of file decorators. This should be array with keys of converter names and values of file decorator classes. |
$input |
Input for documentation Array of folders and files to process. |
$output |
|
$outputs |
Outputs classes
Array of class names of outputs. These will be applied in order specified here, to all files.
All outputs should implement |
.zamm.yml
Configuration can also be stored within your project root in file .zamm.yml (dont forget dot at beginning).
Configuration variables are same as properties of Zamm class.