Skip to content

Draft: Add ECMGenerateQDoc

Nicolas Fella requested to merge work/nico/qdoc into master

This adds a new module for generating API documentation using qdoc

For this a function ecm_generate_qdoc needs to be called for each to-be-documented target. It takes a .qdocconf file as arguments.

The documentation build happens in two phases:

  • prepare: Here the code is parsed and an .index file generated
  • generate: Here the final output (i.e. HTML) is generated, based on index files from dependencies

Intermediate and final results are collected in a configurable DOC_DESTDIR so that it can be combined with the artifacts from other projects

This is roughly based on what Qt does internally, but simplified and adapted for our use case.

See https://mail.kde.org/pipermail/kde-devel/2024-August/002930.html for the larger picture

Draft because:

  • Needs documentation
  • Needs error handling
  • Currently only supports online HTML docs, not offline HTML or qch docs
Edited by Nicolas Fella

Merge request reports