[RFC] doc: updating doxy-api-index.md and doxy-api.conf.in

Thomas Monjalon thomas at monjalon.net
Tue Jun 30 18:10:59 CEST 2026


Hello,

30/06/2026 11:03, Marat Khalili:
> I noticed that a few header files contain docstring-like comments but are not
> present in doc/api/doxy-api-index.md and/or (fewer) in doc/api/doxy-api.conf.in
> There seem to be no checks anywhere in the process that would make sure these
> index files are updated. Do we even care, or is it unsupported legacy? If we do
> care, would a check or an automatic generation fix be more promising?

Some internal files have doxygen comments, not sure why,
probably to run Doxygen manually on these files.

In the scope of our public documentation,
the goal was to document all and only public API.

If you see some public API not referenced, it is a bug.
And yes a script to check this may be useful.




More information about the dev mailing list