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

Add documentation generator #3362

Open
Savio-Sou opened this issue Oct 30, 2023 Discussed in #2710 · 0 comments
Open

Add documentation generator #3362

Savio-Sou opened this issue Oct 30, 2023 Discussed in #2710 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
1.0+

Comments

@Savio-Sou
Copy link
Collaborator

Discussed in https://github.com/orgs/noir-lang/discussions/2710

Originally posted by kevaundray September 15, 2023

Problem

Similar to rust-doc it would be helpful if Noir could have doc comments and a way for those to be exported such that they can be ingested by other tools.

To-do

  • Investigate the different ways to have something akin to rust-docs/doxygen
@Savio-Sou Savio-Sou added enhancement New feature or request documentation Improvements or additions to documentation labels Oct 30, 2023
@Savio-Sou Savio-Sou mentioned this issue Oct 30, 2023
Closed
5 tasks
@kevaundray kevaundray added this to the 1.1 milestone Jan 15, 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
Noir
Status: 📋 Backlog
Milestone
1.0+
Development

Successfully merging a pull request may close this issue.

feat: added doc-generator Sakapoi/noir_fork
2 participants
@kevaundray @Savio-Sou