Background
We develop hdoc, which is a documentation tool for C++. We use Clang and LLVM as the parsing backend for our tool, which allows us to get a semantic understanding of the code and parse comments out of it.
Many existing codebases use Doxygen-style comments, and Clang’s handling of these comments does not match Doxygen’s spec in a few areas. To better be able to parse existing codebases in the wild, we are contributing PRs to Clang which address these needs. These improvements will also make it possible for other documentation tools (which use LLVM/Clang as a backend) to better parse codebases.
Current status
We have three PRs pending right now, waiting for review:
- [Clang][Comments] Add argument parsing for @throw @throws @exception by hdoc · Pull Request #84726 · llvm/llvm-project · GitHub
- [Clang][Comments] Attach comments to decl even if preproc directives are in between by hdoc · Pull Request #88367 · llvm/llvm-project · GitHub
- [Clang][Comments] Support for parsing headers in Doxygen \par commands by hdoc · Pull Request #91100 · llvm/llvm-project · GitHub
How you can help
We would appreciate if we could get feedback for these PRs so that we can merge them in. Please take a look at the PRs and share feedback where needed.