Maslosoft Zamm API
Class Zamm
Zamm: PHP Doc extractor for code fragments This class allows extracting code fragments into documentation. It is designed to be IDE friendly. It should autocomplete and automatically reflect code refactors if properly used. This documentation is also processed with Zamm.
- Maslosoft\Zamm\Zamm implements Maslosoft\Zamm\Interfaces\SourceAccessorInterface uses Maslosoft\Zamm\Traits\SourceMagic
Methods summary
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public
|
|
public static
|
|
public
|
Methods used from Maslosoft\Zamm\Traits\SourceMagic
Constants summary
string |
Version
|
#
'1.0.0'
|
string |
MadeBy
|
#
'Generated by Maslosoft Zamm'
|
string |
DefaultInstanceId
|
#
'zamm'
|
Properties summary
public
string[]
|
$input
Input for documentation Array of folders and files to process. |
#
[
'docs'
]
|
public
array
|
$output
|
#
[
]
|
public
string[][]
|
$decorators
Configuration of decorators. This should be array with keys of renderer interface names and values of decorator classes. |
#
[
// All around decorators
RendererInterface::class => [
StarRemover::class
],
// Class decorators
ClassRendererInterface::class => [
],
// Property decorators
PropertyRendererInterface::class => [
],
// Method decorators
MethodRendererInterface::class => [
],
]
|
public
string[][]
|
$fileDecorators
Configuration of file decorators. This should be array with keys of converter names and values of file decorator classes. |
#
[
// All file decorators
FileDecoratorInterface::class => [
MadeByFileDecorator::class
],
// PHP converter decorators
PhpConverter::class => [
IgnoreFileDecorator::class
]
]
|
public
string[]
|
$converters
Converters
Array of class names of converters. These will be applied in order specified here, to all files.
All converters should implement |
#
[
PhpConverter::class
]
|
public
string[]
|
$outputs
Outputs classes
Array of class names of outputs. These will be applied in order specified here, to all files.
All outputs should implement |
#
[
FileOutput::class
]
|
public
string
|
$extractor
Extractor class name.
This class will be used to extract source fragments. Defaults to |
#
Maslosoft\Zamm\AddendumExtractor::class
|