Proper AST translation for hover docs
varungandhi-src opened this issue · comments
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.
Here's one example where that falls down. Newlines just continue the paragraph in Markdown. But Doxygen uses \param
to mark parameter lists.
![image](https://private-user-images.githubusercontent.com/93103176/270441698-3e1e3b17-c137-49ec-bc10-d5f674e0fd06.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjE0MjY3MDcsIm5iZiI6MTcyMTQyNjQwNywicGF0aCI6Ii85MzEwMzE3Ni8yNzA0NDE2OTgtM2UxZTNiMTctYzEzNy00OWVjLWJjMTAtZDVmNjc0ZTBmZDA2LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MTklMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzE5VDIyMDAwN1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTdlNzkwYzc0NTRiMDU2OTUzMjIzZTJjNzQwMjMwMGI0NTQxYzY4NmM4MjE5YjJkYTkwODJiODI4YzkzYzZhMGEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.otiLvV5eJ9k14oAqeKgzAUt9gA-2WUQ7X_m9wbDS02w)
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>
.