Skip to content

Documentation cleanup: initial pass#135

Merged
alan-george-lk merged 2 commits into
mainfrom
feature/modernize_doxygen
May 27, 2026
Merged

Documentation cleanup: initial pass#135
alan-george-lk merged 2 commits into
mainfrom
feature/modernize_doxygen

Conversation

@alan-george-lk
Copy link
Copy Markdown
Collaborator

@alan-george-lk alan-george-lk commented May 20, 2026

This PR does the following:

  • Without changing wording, replaces /* */ Java-style Doxygen syntax with more modern /// syntax
  • Also adds tags (such as @throws) so they actually show up in generated docs, and to be more consistent
  • Adds AGENTS.md section around Doxygen handling for new code
  • Found additional old Connect() references which are now fixed

@alan-george-lk alan-george-lk force-pushed the feature/modernize_doxygen branch from b5971f9 to 5142ea8 Compare May 26, 2026 23:06
@alan-george-lk alan-george-lk changed the title Modernize/unify code documentation Documentation cleanup: initial pass May 26, 2026
@alan-george-lk alan-george-lk marked this pull request as ready for review May 26, 2026 23:09
@alan-george-lk alan-george-lk force-pushed the feature/modernize_doxygen branch from 0620429 to 3499ca5 Compare May 27, 2026 01:53
Copy link
Copy Markdown
Collaborator

@stephen-derosa stephen-derosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, looked closely at the AGENTS.md file, looks good to me. All other diffs were skimmed.

@alan-george-lk alan-george-lk merged commit a00c070 into main May 27, 2026
23 checks passed
@alan-george-lk alan-george-lk deleted the feature/modernize_doxygen branch May 27, 2026 18:13
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.

2 participants