|
|
|
|
|
by pornel
525 days ago
|
|
Yes, it works with GitHub, GitLab, Bitbucket, and everything else. It's built into the compiler toolchain. It works with every syntax that you can compile, because it uses the compiler itself to extract the documentation. Yes, it works on Windows too. Rust supports Windows as a first-class platform. It works with dependencies too (the docs even link across packages). The fragmentation of C tooling and unreliability/complexity of integrating with C builds is not a universal problem. Rust's built-in documentation generator creates HTML, so anything with a browser can show it. It also has JSON format for 3rd party tooling. The same language syntax for the documentation is understood by Rust's LSP server, so vim, emacs, and other editors with LSP plugins can show the documentation inline too. I've been using this for years, and it works great. I don't miss maintaining C headers at all. I write function definitions once, document them in the same place where the code is, and get high fidelity always up-to-date API docs automatically. |
|