How it works

How it works – The global picture

How it works

The documentation analysis report generation is split into
two processes:

Collect data and save it

Generate different reports from saved data

This was chosen because the data collection step takes
a long time (~ 1 minute), but it's needed for every single report.
So if you want to generate the simple doc coverage, and the extended
one, you need the same base data - you just display it in a different
way.

generateCoverage() in
QA_Peardoc_Coverage generates and returns
the array with the computed coverage data.
It can be serialized and saved, since all the Renderer
classes use it as input.

Classes implementing the QA_Peardoc_Coverage_Renderer
interface provide a render() method that takes
the data returned by generateCoverage() and return
the analysis, most times a string containing HTML code.