microsoft / microsoft/vscode-cpptools
Doxygen monospaced comments that preserve whitespace
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 1.7k
- Avg merge
- 14h 46m
- Merged PRs (30d)
- 61
Description
Feature Request
I don't know if this is something that Doxygen supports but I find it occasionally useful to have ASCII ART in my comments to act as a visual aid. This can be done with fenced markdown support as well, is there something you can do to just render something from a comment in a preformatted monospaced font? I've tried markdown (which I understand has been disabled) and HTML but it is also being ignored. I'm no expert on Doxygen maybe there's a simple workaround?
The above is rendered as below.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names no file, test, or entry point; begin by reproducing the shown Doxygen comment in the extension. Compare the rendered output with the attached examples and determine whether preformatted, whitespace-preserving monospaced output is supported. Done means the expected rendering or a documented workaround is established.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100