Skip to content

Add settings to optionally simplify structured comments (Doxygen)#5730

Merged
michelleangela merged 7 commits intomasterfrom
mimatias/doxygen-settings
Jul 7, 2020
Merged

Add settings to optionally simplify structured comments (Doxygen)#5730
michelleangela merged 7 commits intomasterfrom
mimatias/doxygen-settings

Conversation

@michelleangela
Copy link
Copy Markdown
Contributor

@michelleangela michelleangela commented Jul 6, 2020

Add option to simplify structured comments. When the option is set to true, tooltips will display a simplified form of structured comments. For example, for Doxygen, it will only display certain tags. If this option is disabled, it will display complete structured comments.

Screenshot of setting:

image

Example displays for Doxygen comment:

image

Simplified display

image

Complete display

image

@michelleangela michelleangela linked an issue Jul 6, 2020 that may be closed by this pull request
Comment thread Extension/src/nativeStrings.json
Copy link
Copy Markdown
Contributor

@sean-mcmanus sean-mcmanus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like the scope should be "application"?

@michelleangela
Copy link
Copy Markdown
Contributor Author

michelleangela commented Jul 7, 2020

It seems like the scope should be "application"?

Since this is UI, then it should only be application? Similar to the experience of changing color theme of VS Code?

@sean-mcmanus
Copy link
Copy Markdown
Contributor

sean-mcmanus commented Jul 7, 2020

It seems like the scope should be "application"?

Since this is UI, then it should only be application? Similar to the experience of changing color theme of VS Code?

Yeah. If it doesn't make sense for the setting (UI) to change after the user switches workspace folders, switches workspaces, or switches to a remote machine, then the setting should be "application" scope (i.e. User scope).

@michelleangela michelleangela merged commit ed15700 into master Jul 7, 2020
@michelleangela michelleangela deleted the mimatias/doxygen-settings branch July 20, 2020 22:14
@github-actions github-actions Bot locked and limited conversation to collaborators Oct 9, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Leave the non-recognized doxygen commands in comments

2 participants