mum icon indicating copy to clipboard operation
mum copied to clipboard

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

Open sornas opened this issue 2 years ago • 0 comments

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.

  • https://lib.rs/crates/man
  • https://lib.rs/crates/roff
  • https://lib.rs/crates/roffman

sornas avatar Sep 29 '22 09:09 sornas