Pelzini

This is the code documentation for the Pelzini project

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.

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2024-06-21
**/
class NewClassName extends QualityCheckTransformer {
    
    /**
    * Checks that an interface has high-enough quality documentation
    **/
    private function check_interface ($item) {
        // Method code goes here
    }
    
    /**
    * Checks that a function has high-enough quality documentation
    **/
    private function check_function ($item, $from) {
        // Method code goes here
    }
    
    /**
    * Set up the quality check transformer
    **/
    public function __construct (array $required_tags) {
        // Method code goes here
    }
    
    /**
    * Transforms the data model before outputting.
    * 
    * This transformer generates a report of objects that do not have good enough documentation
    **/
    public function transform (array $parser_model) {
        // Method code goes here
    }
    
    /**
    * Checks that a file has high-enough quality documentation
    **/
    private function check_files ($item) {
        // Method code goes here
    }
    
    /**
    * Checks that a class has high-enough quality documentation
    **/
    private function check_class ($item) {
        // Method code goes here
    }
    
}
?>