LLVM.jl
LLVM.jl copied to clipboard
maleadt
RFC: Test docstrings
Clang.jl PR: https://github.com/JuliaInterop/Clang.jl/pull/318
The result: https://github.com/maleadt/LLVM.jl/commit/29a49a7d5565b59b36509f883720fcf200b67849
@vchuravy @maleadt Any comments would be appreciated!
cc @melonedo
resolve the doxygen links to the C++ API
did you mean, for example, for LLVMWriteBitcodeToFile, the generator should print the link https://llvm.org/doxygen/group__LLVMCBitWriter.html#ga10b86ad44bcad46fcf80cc525949703d in the docstring?
On my phone so looking at the large diff is hard, but there are references to the C++ API (e.g. See llvm::...) That point to outside the C API and I think those are actual doxygen link iirc
On Sun, Aug 8, 2021, 11:30 Yupei Qi @.***> wrote:
resolve the doxygen links to the C++ API
did you mean, for example, for LLVMWriteBitcodeToFile, the generator should print the link https://llvm.org/doxygen/group__LLVMCBitWriter.html#ga10b86ad44bcad46fcf80cc525949703d in the docstring?
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/maleadt/LLVM.jl/pull/256#issuecomment-894769484, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABDO2TA2WGHW3WIGANPGULT3ZFBTANCNFSM5BYC6L6Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email .
This is nice!
there are references to the C++ API (e.g. See llvm::...) That point to outside the C API and I think those are actual doxygen link iirc
Yeah, like:
### See also
llvm::MemoryBuffer
There's a couple of other constructs that would be nice to render natively, like:
\\since [`LTO_API_VERSION`](@ref)=20
And also some missing code highlighting:
A reference to an orc::JITDylib instance.
But since this is non-exported developer documentation, I'm happy with any documentation here :slightly_smiling_face:
