-
Notifications
You must be signed in to change notification settings - Fork 13.5k
[clang] Automatically generate builtin documentation from a .td File. #139039
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
I'm not certain what this issue is asking for. Which documentation should come from a .def file? (We already table generate much of our documentation, such as attributes, command line options, and diagnostic flags.) |
They also opened #139036 and #139037 which makes me think this is just LLM generated spam. |
It would be very useful to automatically generate documentation for the builtin interface based on the .def description. |
We already do that in Tablegen. The real suggestion would be to port over all of our remaining |
It would also be useful if the .def files could all be ported to Tablegen. |
@AaronBallman The readability of the current builtin interface described in a .def file is terrible. |
Feel free to make a PR that ports your favorite |
@jhuber6 I'd like to throw this out here for discussion first. |
But there are no comments here to fully describe the function and parameters, either. |
Thanks for the clarification! I've made some edits to the issue so it's easier for others to understand without having to read all the comments. |
Currently, the builtin documentation is hand written into .rst. It would be better if that documentation could live on the builtin in the .td file, similar to how already works for things like attributes and warnings.
The text was updated successfully, but these errors were encountered: