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.
This is the code documentation for the Pelzini project
Search documentation |
class FakeNamespaceDirsTransformerThis 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, 2025-12-07
**/
class NewClassName extends FakeNamespaceDirsTransformer {
/**
* Set up the quality check transformer
**/
public function __construct () {
// 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
}
}
?>
|
| Powered by Pelzini, version 0.9.0 |
Documentation is made available under the
GNU Free Documentation License 1.2. Generated: Thursday, 15th March, 2018 at 02:05 pm |
|