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

)

Extension/package.json

@@ -250,6 +250,12 @@
           "description": "%c_cpp.configuration.preferredPathSeparator.description%",
           "scope": "machine-overridable"
         },
+        "C_Cpp.simplifyStructuredComments": {
+          "type": "boolean",
+          "default": true,
+          "description": "%c_cpp.configuration.simplifyStructuredComments.description%",
+          "scope": "application"
+        },
         "C_Cpp.commentContinuationPatterns": {
           "type": "array",
           "default": [

Extension/package.nls.json

@@ -36,6 +36,7 @@
     "c_cpp.configuration.workspaceSymbols.description": "The symbols to include in the query results when 'Go to Symbol in Workspace' is invoked",
     "c_cpp.configuration.exclusionPolicy.description": "Instructs the extension when to use the \"files.exclude\" setting when determining which files should be added to the code navigation database while traversing through the paths in the \"browse.path\" array. \"checkFolders\" means that the exclusion filters will only be evaluated once per folder (individual files are not checked). \"checkFilesAndFolders\" means that the exclusion filters will be evaluated against every file and folder encountered. If your \"files.exclude\" setting only contains folders, then \"checkFolders\" is the best choice and will increase the speed at which the extension can initialize the code navigation database.",
     "c_cpp.configuration.preferredPathSeparator.description": "The character used as a path separator for #include auto-completion results.",
+    "c_cpp.configuration.simplifyStructuredComments.description": "If true, tooltips of hover and auto-complete will only display certain labels of structured comments. Otherwise, all comments are displayed.",
     "c_cpp.configuration.commentContinuationPatterns.items.anyof.string.description": "The pattern that begins a multiline or single line comment block. The continuation pattern defaults to ' * ' for multiline comment blocks or this string for single line comment blocks.",
     "c_cpp.configuration.commentContinuationPatterns.items.anyof.object.begin.description": "The pattern that begins a multiline or single line comment block.",
     "c_cpp.configuration.commentContinuationPatterns.items.anyof.object.continue.description": "The text that will be inserted on the next line when Enter is pressed inside a multiline or single line comment block.",

Extension/src/LanguageServer/client.ts

@@ -1300,6 +1300,7 @@ export class DefaultClient implements Client {
                 dimInactiveRegions: settings_dimInactiveRegions,
                 enhancedColorization: settings_enhancedColorization,
                 suggestSnippets: settings_suggestSnippets,
+                simplifyStructuredComments: workspaceSettings.simplifyStructuredComments,
                 loggingLevel: workspaceSettings.loggingLevel,
                 workspaceParsingPriority: workspaceSettings.workspaceParsingPriority,
                 workspaceSymbols: workspaceSettings.workspaceSymbols,

Extension/src/LanguageServer/settings.ts

@@ -126,6 +126,7 @@ export class CppSettings extends Settings {
     public get workspaceParsingPriority(): string | undefined { return super.Section.get<string>("workspaceParsingPriority"); }
     public get workspaceSymbols(): string | undefined { return super.Section.get<string>("workspaceSymbols"); }
     public get exclusionPolicy(): string | undefined { return super.Section.get<string>("exclusionPolicy"); }
+    public get simplifyStructuredComments(): boolean | undefined { return super.Section.get<boolean>("simplifyStructuredComments"); }
     public get commentContinuationPatterns(): (string | CommentPattern)[] | undefined { return super.Section.get<(string | CommentPattern)[]>("commentContinuationPatterns"); }
     public get configurationWarnings(): string | undefined { return super.Section.get<string>("configurationWarnings"); }
     public get preferredPathSeparator(): string | undefined { return super.Section.get<string>("preferredPathSeparator"); }

Extension/src/nativeStrings.json

@@ -189,5 +189,6 @@
         "hint": "This label is for the return value description for a function. Usage example: 'Returns: Area of a shape.'"
     },
     "deprecated_label": "Deprecated:",
-    "exceptions_label": "Exceptions:"
+    "exceptions_label": "Exceptions:",
+    "template_parameters_label": "Template Parameters:"
 }