-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Not All Doxygen Comment Blocks Supported #12316
Labels
bug
Feature: Doc comments
An issue related to code comments shown in hover, completion, and signature help.
fixed
Check the Milestone for the release in which the fix is or will be available.
Language Service
Projects
Milestone
Comments
praise |
Amazing, thank you @browntarik @bobbrow @sean-mcmanus !! Really appreciate the work. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
bug
Feature: Doc comments
An issue related to code comments shown in hover, completion, and signature help.
fixed
Check the Milestone for the release in which the fix is or will be available.
Language Service
Environment
Bug Summary and Steps to Reproduce
Bug Summary:
My work's coding style guide specifies this format of Doxygen comment (No.4 on this page: Doxygen Documentation):
Note the two forward slashes in the first line.
The VSCode C/C++ Extension doesn't seem to pick this up as a Doxygen comment:
Example with slashes:
![image](https://private-user-images.githubusercontent.com/31901577/331681050-340dca8d-a349-4314-b398-6491fffa85de.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjIxNDI1MjYsIm5iZiI6MTcyMjE0MjIyNiwicGF0aCI6Ii8zMTkwMTU3Ny8zMzE2ODEwNTAtMzQwZGNhOGQtYTM0OS00MzE0LWIzOTgtNjQ5MWZmZmE4NWRlLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzI4VDA0NTAyNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWRmNTNhOGM2NDRhODM1NzI2ZDI4NWFiZTAwM2RjMzA1MjdkZTM1NTgyMjMxYjgzNmJjMTM4YmY0OWI4OGFjNzMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.B9dOPID71ITPd78sZnoKDJo2y2GKvZnLe00JlydgCqc)
Example without slashes:
![image](https://private-user-images.githubusercontent.com/31901577/331680961-71068ab5-7ffb-4fad-a98a-4854b0ddc772.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjIxNDI1MjYsIm5iZiI6MTcyMjE0MjIyNiwicGF0aCI6Ii8zMTkwMTU3Ny8zMzE2ODA5NjEtNzEwNjhhYjUtN2ZmYi00ZmFkLWE5OGEtNDg1NGIwZGRjNzcyLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA3MjglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNzI4VDA0NTAyNlomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWY4MzBhMWY5MDUzNGZlNjk5NmYxNDAwZWE3NTRmODFiZTQwNjU1OTEwZmI4N2VhODZiZDU3NjM4OWZkODEzNTcmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.YSbiSR6dnt2gcuCLwxTfOALGtBxpUVTOyDbedGb0d_A)
Steps to reproduce:
test.txt
Expected behavior:
I would expect any code block format specified on the Doxygen documentation to render properly like the second screenshot above.
Let me know if I can provide any other info! Thanks for your time and help with this.
Configuration and Logs
Other Extensions
I also have CMake and NRF extensions installed.
Additional context
No response
The text was updated successfully, but these errors were encountered: