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

Generate man-files for the config file via a proc macro #144

Open
sornas opened this issue Sep 29, 2022 · 0 comments
Open

Generate man-files for the config file via a proc macro #144

sornas opened this issue Sep 29, 2022 · 0 comments

Comments

@sornas
Copy link
Collaborator

sornas commented Sep 29, 2022

It's very easy to forget updating the documentation for the configuration file. A procedural macro that reads the doc comments and formats them into a man-page would ensure they stay more up-to-date. The macro would need to be recursive to handle the fact that we have an AudioConfig inside our Config and would like to document both.

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

No branches or pull requests

1 participant