octomy::apidocs::Projection
Turns QDoc's DocBook pages and its index into the markdown tree of the API reference: one page per class, struct and namespace, two lists, and QDoc's own overview page.
| Declared in | src/libs/libapidocs/apidocs/Projection.hpp |
Detailed description
What comes from where
The DocBook page is the content: the brief, the requisites, the detailed description, every documented member, the see-also lines. The index adds two facts the DocBook page does not carry. QDoc leaves the DocBook title of a struct empty, so the qualified name comes from the index's fullname. And the DocBook "Header" line is QDoc's guess from the class name, so the declaring header comes from the index's filepath.
Where each page lands
| QDoc page | Lands at, below the API root |
|---|---|
| a class or a struct | classes/<base>/index.md |
| a namespace | namespaces/<base>/index.md |
index, QDoc's landing page |
overview/index.md |
octomy-classes, QDoc's class list |
classes/index.md, rendered here |
any other \\page |
pages/<base>/index.md |
<base> is QDoc's own page name, so the URL of a class is the name of its HTML page without the extension, and an old html/<base>.html link redirects to one place (api-reference §APD-A15).
See also DocBookPage, ConfigPlan.