Summary
All public headers in libew and ewpresenter already use Doxygen-style /// comments, but no Doxyfile or published API reference exists. The comments are invisible to users who don't read the source.
Action needed
-
Add a Doxyfile (or docs/Doxyfile) configured for:
INPUT = libew/include ewpresenter/include
- HTML output to
docs/html/ (gitignored)
EXTRACT_ALL = NO (only document explicitly commented symbols)
GENERATE_LATEX = NO
-
Add a docs CI job (or post-build step) that:
- Runs
doxygen Doxyfile
- Optionally publishes to GitHub Pages on tag pushes.
-
Update README.md to link to the published docs (or instruct how to build them locally).
Files
Doxyfile — new at repo root (or docs/Doxyfile)
.github/workflows/ci.yml — optional docs publish job
README.md — link to docs
Summary
All public headers in
libewandewpresenteralready use Doxygen-style///comments, but noDoxyfileor published API reference exists. The comments are invisible to users who don't read the source.Action needed
Add a
Doxyfile(ordocs/Doxyfile) configured for:INPUT = libew/include ewpresenter/includedocs/html/(gitignored)EXTRACT_ALL = NO(only document explicitly commented symbols)GENERATE_LATEX = NOAdd a
docsCI job (or post-build step) that:doxygen DoxyfileUpdate
README.mdto link to the published docs (or instruct how to build them locally).Files
Doxyfile— new at repo root (ordocs/Doxyfile).github/workflows/ci.yml— optional docs publish jobREADME.md— link to docs