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.

Sign up for GitHub

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

Jump to bottom

Generate code documentation using Doxygen #483

Open
4 of 12 tasks
mkannwischer opened this issue Dec 4, 2024 · 0 comments
Open
4 of 12 tasks

Generate code documentation using Doxygen #483

mkannwischer opened this issue Dec 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
next

Comments

@mkannwischer
Copy link
Contributor

Platform:
Which platform does this concern?

  • platform independent
  • aarch64
  • x86_64
  • rv64
  • other

Issue category:

Which part(s) of mlkem-native does this issue concern:

  • core crypto: ML-KEM
  • core crypto: FIPS202
  • documentation
  • integration
  • CBMC
  • CI
  • Testing

Describe the solution you'd like
Currently almost all functions have documentation in the header files. We should make sure that those can be turned into documentation, e.g., using Doxygen. Probably for subsequent releases we want to publish that documentation on the Github pages.

Additional context
First #434 and #211 need to be resolved.
@mkannwischer mkannwischer added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 4, 2024
@mkannwischer mkannwischer added this to the next milestone Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
next
Development

No branches or pull requests
1 participant
@mkannwischer