Skip to content

Remove generated Doxygen docs and doc-generation tooling - #202

Merged
BenjaFriend merged 1 commit into
mainfrom
chore/remove-doxygen
Aug 29, 2026
Merged

Remove generated Doxygen docs and doc-generation tooling#202
BenjaFriend merged 1 commit into
mainfrom
chore/remove-doxygen

Conversation

@BenjaFriend

Copy link
Copy Markdown
Member

Summary

  • Removes the committed Doxygen HTML output from docs/ (~525 generated files) — it wasn't hand-maintained and nothing regenerates it in CI.
  • Removes the root doxyfile and scripts/GenerateDocs.sh.
  • Drops the sudo apt-get install doxygen step from the README's Linux setup instructions since Doxygen is no longer used anywhere in the repo.
  • Keeps docs/CodingStyle.md, docs/BuildModules.md, and docs/Fling-Engine-logo/ (the README banner image) — those are hand-maintained/used.
  • Updates Skills/architecture.md's description of docs/ to match.
  • Left scripts/migrate_doxygen_comments.py and the "Doxygen-style" comment-convention references in docs/CodingStyle.md/Skills/coding-style.md alone — those describe the project's doc-comment formatting convention, unrelated to generating/publishing docs.
  • Left external/ submodules' own Doxygen configs untouched, as instructed.

Test plan

  • grep -rIn "oxygen" across the repo (excluding external/, .git/, build/) shows only the remaining comment-style mentions, no dangling references to the removed script/Doxyfile
  • git status clean after commit; only deletions plus the two doc edits

🤖 Generated with Claude Code

https://claude.ai/code/session_012EzaEQw9gd6k41NhTbNjko

The docs/ folder was mostly committed Doxygen HTML output rather than
hand-maintained content, and nothing in CI regenerates or uses it. Drop
the generated files, the Doxyfile, scripts/GenerateDocs.sh, and the
Doxygen apt-get install step from the README (it's no longer a dep),
keeping only the hand-maintained docs/CodingStyle.md, docs/BuildModules.md,
and the logo image the README embeds.
@BenjaFriend
BenjaFriend merged commit 3aa203a into main Aug 29, 2026
6 checks passed
@BenjaFriend
BenjaFriend deleted the chore/remove-doxygen branch August 29, 2026 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant