Christopher M. Punches
267529bee3
Module APIs and the library's exported ABI are versioned and retired deliberately: a break ships as a new table version or a new symbol version node, and consumers judge the versions they are handed. Document src/libdpm-core.map — what it pins, what belongs in it, and how a generation is retired — and declare DPM_CORE_0.1 as the shape the next retired node takes.
821 B
821 B
Generating the Code Reference
When Doxygen is present, the build offers a docs target that generates the API and source reference from the documentation comments carried in the headers and sources. Two output formats are available as configure-time options:
-DDPM_DOCS_PDF(default ON) — PDF reference, via Doxygen's native LaTeX output; requirespdflatexandmakeindex-DDPM_DOCS_HTML(default OFF) — HTML reference
Generate and compile the PDF reference:
cmake --build <build-dir> --target docs-pdf
The PDF lands at <build-dir>/docs/latex/refman.pdf.
With DPM_DOCS_HTML enabled at configure time, the docs target additionally produces the HTML reference in <build-dir>/docs/html:
cmake -B <build-dir> -DDPM_DOCS_HTML=ON
cmake --build <build-dir> --target docs
