Skip to content
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

Proper AST translation for hover docs #426

Open
varungandhi-src opened this issue Sep 25, 2023 · 0 comments
Open

Proper AST translation for hover docs #426

varungandhi-src opened this issue Sep 25, 2023 · 0 comments

Comments

@varungandhi-src
Copy link
Contributor

We literally just take the hover doc and jam it into Markdown.

However, it's usually written using Doxygen markup, not Markdown. So we need to synthesize a Doxygen AST -> convert that to Markdown.

https://sourcegraph.com/github.com/NVIDIA/MDL-SDK@190249748ddfe75b133b9da9028cc6272928c1b5/-/blob/include/mi/neuraylib/target_code_types.h?L1079

Here's one example where that falls down. Newlines just continue the paragraph in Markdown. But Doxygen uses \param to mark parameter lists.

image

For the param-specific issue, we could potentially just hack it by adding some ad-hoc translation. E.g. if the start of the line has \param <blah>, then emit * <blah>.

@varungandhi-src varungandhi-src added the enhancement New feature or request label Sep 25, 2023
@linear linear bot closed this as not planned Won't fix, can't repro, duplicate, stale Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant