ParityReport

How far the doc engine's output is from QDoc's, at the four levels of doc-engine §DED-4.

In the namespace octomy::apidocs. Declared in src/libs/libapidocs/apidocs/ParityReport.hpp.

Detailed description

The doc engine replaces QDoc only when the two give the same reference (gate G1). The report compares two outputs of the same tree:

  • Pages: the two folders hold the same DocBook page names.
  • Content: the projection makes the same markdown from each pair of pages. A difference in the XML that the projection does not read is no difference, because the markdown is what ships.
  • Index: the index entries that the projection reads are equal, attribute by attribute.
  • Warnings: the two sets of file, line and message are equal.

It needs no clang, so its suite runs on every host.

See also Projection, ConfigPlan.

In this section