Pelzini

This is the code documentation for the Pelzini project

Page options:

Inherited members

class FakeNamespaceDirsTransformer

This is a transformer that does quality checks on the codebase

It checks that the documentation has the required tags. Currently the 'required tags' are only the summary

The documentation is created in a report called the Quality check report.

Authors

Functions

NameVisibilityDescription
__constructpublicSet up the quality check transformer
transformpublicTransforms the data model before outputting.

public __construct

void $FakeNamespaceDirsTransformer->__construct ( );

Set up the quality check transformer

public transform

array $FakeNamespaceDirsTransformer->transform ( array &$parser_model );

Transforms the data model before outputting.

This transformer generates a report of objects that do not have good enough documentation