QualityCheckTransformer class - Documentation for Pelzini

Info Page:

Page options:

class QualityCheckTransformer

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.

File: /processor/quality_check_transformer.php
Namespace: processor
Extends: Transformer
Available since:

Authors

Josh

Variables

Name	Visibility	Description
`$offending_items`
`$required_tags`

Functions

Name	Visibility	Description
__construct	public	Set up the quality check transformer
check_class	private	Checks that a class has high-enough quality documentation
check_files	private	Checks that a file has high-enough quality documentation
check_function	private	Checks that a function has high-enough quality documentation
check_interface	private	Checks that an interface has high-enough quality documentation
transform	public	Transforms the data model before outputting.

public __construct

void $QualityCheckTransformer->__construct ( [ array $required_tags ] );

Set up the quality check transformer

private check_class

void $QualityCheckTransformer->check_class ( mixed $item );

Checks that a class has high-enough quality documentation

private check_files

void $QualityCheckTransformer->check_files ( mixed $item );

Checks that a file has high-enough quality documentation

private check_function

void $QualityCheckTransformer->check_function ( mixed $item [, mixed $from ] );

Checks that a function has high-enough quality documentation

private check_interface

void $QualityCheckTransformer->check_interface ( mixed $item );

Checks that an interface has high-enough quality documentation

public transform

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

Transforms the data model before outputting.

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

Pelzini

Search documentation