Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doxygen documentation #44

Merged
merged 16 commits into from
Aug 11, 2023
Merged

Doxygen documentation #44

merged 16 commits into from
Aug 11, 2023

Conversation

mlund
Copy link
Collaborator

@mlund mlund commented Jul 31, 2023

Doxygen is a de facto standard for documenting C/C++ projects and has several benefits:

  1. it's picked up by most IDE's to give help in functions, defines, etc.
  2. it can be used to output HTML, LaTeX, and XML
  3. XML output can be further parsed to e.g. the MEGA65 User Guide

This PR adds the following to mega65-libc:

  • make doc build target that creates HTML, LaTeX, and XML documentation of the API
  • make guide runs a python script to extract Doxygen tags to MEGA65 User Guide LaTeX source. This could replace the ad-hoc \m65lib tags currently used and if so, is now available for all functions in libc (not just conio.h as of now).
  • Pre-commit configuration for clang-format and ruff
  • README.md updated with instructions for building documentation
  • Add a contributer check-list that will show up on new PR's on github
  • This PR contains no code changes

Note

This is a second version of this PR do force an update of the diff after #39 was merged.

@mlund mlund added the enhancement New feature or request label Jul 31, 2023
@mlund mlund requested a review from lydon42 July 31, 2023 06:44
@mlund mlund merged commit eaa2656 into master Aug 11, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants