llvm / clangir

A new (MLIR based) high-level IR for clang.
https://clangir.org
Other
383 stars 100 forks source link

Doxygen Documentation #524

Closed eZWALT closed 7 months ago

eZWALT commented 7 months ago

For the last weeks I've been developing some features, and I've found MLIR/Clang basic doxygen documentation quite helpful to understand some classes and its methods. But I'm quite surprised to see that ClangIR does not generate its own Doxygen file, so I'm curious, will this be automatically uploaded in any upcoming upstream or should we modify any CMakeLists / script / Doxyfile to make this happen?

I've used Doxygen on smaller projects quite a long ago, but I would be delighted to submit a patch to address this issue that, in my opinion, we would all benefit. I would be immensely grateful if someone could give me some hints for this to happen. Thanks!

image

bcardosolopes commented 7 months ago

I'd expect that if you build clangir repo with the right invocations to generate documentations for the LLVM project, it should automatically generate the same for ClangIR, you can then access the HTML on your local machine. You can enable that in cmake with -DLLVM_ENABLE_DOXYGEN=On and ninja will populate a target for it (maybe doxygen-llvm, I haven't tried). Did you try that?