Menu

#657 GTK3V2MAIN: Doxygen main-page/dev-docs improvements, Phase B (add a real Main Page)

closed
nobody
None
1 day ago
3 days ago
No

Second phase of the effort to make the generated Doxygen internals docs (docs/doxygen/) usable. Follows Phase A (SF #656). Full plan: git's .claude/doxygen-mainpage-plan.md (working notes, not committed).

The generated docs' Main Page was completely empty -- USE_MDFILE_AS_MAINPAGE was unset and there was no \mainpage anywhere in the tree.

Added a new docs/doxygen/mainpage.md with:

  • A short project description (reusing CLAUDE.md's summary of what XTrkCAD is).
  • An architecture breakdown of the source tree (app/bin, app/wlib, app/cornu, app/dynstring, app/cJSON, app/lib), also sourced from CLAUDE.md.
  • A short "where to start reading" pointer (track.c/track.h, draw.c).

Wired in via USE_MDFILE_AS_MAINPAGE, with the file also added to INPUT -- Doxygen requires a file referenced by USE_MDFILE_AS_MAINPAGE to also be listed in INPUT, or it isn't actually processed.

Verification: docs-doxygen exits 0 with FAIL_ON_WARNINGS active (CI-pinned Doxygen 1.15.0 binary). Confirmed by parsing the generated index.html that the title now reads "XTrkCAD: Developer Documentation" and the intended content renders (previously just an empty page). Full rebuild clean, ctest 10/10 pass. Git PR: https://github.com/adbyrne/XTrkCAD/pull/26 (GTK3V2MAIN).

Discussion

Anonymous
Anonymous

Add attachments
Cancel





MongoDB Logo MongoDB