Extension¶

class JuliusHaertl\PHPDocToRst\Extension\Extension¶

Source:	/Extension/Extension.php#27

Summary¶

Methods¶

public __construct($project, $arguments)
public prepare()
public render($type, $builder, $element)
public shouldRenderElement($element)
public shouldRenderIndex($type, $element)

Properties¶

protected static property JuliusHaertl\PHPDocToRst\Extension\Extension::$project¶

Source:	/Extension/Extension.php#30
Type:	`\phpDocumentor\Reflection\Php\Project`

protected static property JuliusHaertl\PHPDocToRst\Extension\Extension::$arguments¶

Source:	/Extension/Extension.php#33
Type:	array

Methods¶

public JuliusHaertl\PHPDocToRst\Extension\Extension::__construct($project, $arguments=[])¶

Source:	/Extension/Extension.php#35

public JuliusHaertl\PHPDocToRst\Extension\Extension::prepare()¶

Method that will be ran before generating any documentation files
This is useful for preparing own data structures
to be used in the output documentation.

Source:	/Extension/Extension.php#46

public JuliusHaertl\PHPDocToRst\Extension\Extension::render($type, &$builder, $element)¶

Implement custom rendering functionality here.

It will be executed by Builder classes depending on the given type.

Currently supported types:

- PhpDomainBuilder::SECTION_BEFORE_DESCRIPTION

- PhpDomainBuilder::SECTION_AFTER_DESCRIPTION

Source:	/Extension/Extension.php#63
Parameters:	$type (string) $builder (`JuliusHaertl\PHPDocToRst\Builder\ExtensionBuilder`) $element (`phpDocumentor\Reflection\Element`) context for the render type

public JuliusHaertl\PHPDocToRst\Extension\Extension::shouldRenderElement($element)¶

This method will be called to check if a certain element should

be rendered in the documentation.

An example extension that makes use of it is PublicOnlyExtension

Source:	/Extension/Extension.php#77
Parameters:	$element (`phpDocumentor\Reflection\Element`)
Returns:	bool

public JuliusHaertl\PHPDocToRst\Extension\Extension::shouldRenderIndex($type, $element)¶

Source:	/Extension/Extension.php#82