Skip to content

Commit 168eba4

Browse files
authored
Rename doxygen settings (#9734)
1 parent 3936640 commit 168eba4

File tree

4 files changed

+25
-21
lines changed

4 files changed

+25
-21
lines changed

Extension/package.json

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2333,22 +2333,22 @@
23332333
"markdownDescription": "%c_cpp.configuration.simplifyStructuredComments.markdownDescription%",
23342334
"scope": "application"
23352335
},
2336-
"C_Cpp.autocompleteDoxygenComment":{
2337-
"type":"boolean",
2338-
"default":true,
2339-
"description": "%c_cpp.configuration.autocompleteDoxygenComment.description%",
2336+
"C_Cpp.doxygen.generateOnType":{
2337+
"type": "boolean",
2338+
"default": true,
2339+
"description": "%c_cpp.configuration.doxygen.generateOnType.description%",
23402340
"scope": "resource"
23412341
},
2342-
"C_Cpp.generatedDoxygenCommentStyle": {
2343-
"type":"string",
2342+
"C_Cpp.doxygen.generatedStyle": {
2343+
"type": "string",
23442344
"enum":[
23452345
"///",
23462346
"/**",
23472347
"/*!",
23482348
"//!"
23492349
],
2350-
"default":"/**",
2351-
"description": "%c_cpp.configuration.generatedDoxygenCommentStyle.description%",
2350+
"default": "/**",
2351+
"description": "%c_cpp.configuration.doxygen.generatedStyle.description%",
23522352
"scope": "resource"
23532353
},
23542354
"C_Cpp.commentContinuationPatterns": {
@@ -2898,9 +2898,8 @@
28982898
},
28992899
{
29002900
"command": "C_Cpp.GenerateDoxygenComment",
2901-
"title":"%c_cpp.command.GenerateDoxygenComment.title%",
2902-
"category":"C/C++"
2903-
2901+
"title": "%c_cpp.command.GenerateDoxygenComment.title%",
2902+
"category": "C/C++"
29042903
}
29052904
],
29062905
"keybindings": [

Extension/package.nls.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,9 +184,9 @@
184184
"c_cpp.configuration.exclusionPolicy.checkFilesAndFolders.description": "The exclusion filters will be evaluated against every file and folder encountered.",
185185
"c_cpp.configuration.preferredPathSeparator.markdownDescription": { "message": "The character used as a path separator for `#include` auto-completion results.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
186186
"c_cpp.configuration.simplifyStructuredComments.markdownDescription": { "message": "If `true`, tooltips of hover and auto-complete will only display certain labels of structured comments. Otherwise, all comments are displayed.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
187+
"c_cpp.configuration.doxygen.generateOnType.description": "Controls whether to automatically insert the Doxygen comment after typing the chosen comment style.",
188+
"c_cpp.configuration.doxygen.generatedStyle.description": "The string of characters used as the starting line of the Doxygen comment.",
187189
"c_cpp.configuration.commentContinuationPatterns.items.anyof.string.markdownDescription": { "message": "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.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
188-
"c_cpp.configuration.autocompleteDoxygenComment.description": "Controls whether to automatically insert the Doxygen comment after typing the chosen comment style.",
189-
"c_cpp.configuration.generatedDoxygenCommentStyle.description": "The string of characters used as the starting line of the Doxygen comment.",
190190
"c_cpp.configuration.commentContinuationPatterns.items.anyof.object.begin.description": "The pattern that begins a multiline or single line comment block.",
191191
"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.",
192192
"c_cpp.configuration.commentContinuationPatterns.description": "Defines the editor behavior for when the Enter key is pressed inside a multiline or single line comment block.",

Extension/src/LanguageServer/client.ts

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -997,8 +997,8 @@ export class DefaultClient implements Client {
997997
const settings_suggestSnippets: (boolean | undefined)[] = [];
998998
const settings_exclusionPolicy: (string | undefined)[] = [];
999999
const settings_preferredPathSeparator: (string | undefined)[] = [];
1000-
const settings_generatedDoxygenCommentStyle: (string | undefined)[] = [];
1001-
const settings_autocompleteDoxygenComment: (boolean | undefined)[] = [];
1000+
const settings_doxygenGeneratedCommentStyle: (string | undefined)[] = [];
1001+
const settings_doxygenGenerateOnType: (boolean | undefined)[] = [];
10021002
const settings_defaultSystemIncludePath: (string[] | undefined)[] = [];
10031003
const settings_intelliSenseCachePath: (string | undefined)[] = [];
10041004
const settings_intelliSenseCacheSize: (number | undefined)[] = [];
@@ -1166,8 +1166,8 @@ export class DefaultClient implements Client {
11661166
settings_suggestSnippets.push(setting.suggestSnippets);
11671167
settings_exclusionPolicy.push(setting.exclusionPolicy);
11681168
settings_preferredPathSeparator.push(setting.preferredPathSeparator);
1169-
settings_generatedDoxygenCommentStyle.push(setting.generatedDoxygenCommentStyle);
1170-
settings_autocompleteDoxygenComment.push(setting.autocompleteDoxygenComment);
1169+
settings_doxygenGeneratedCommentStyle.push(setting.doxygenGeneratedCommentStyle);
1170+
settings_doxygenGenerateOnType.push(setting.doxygenGenerateOnType);
11711171
settings_defaultSystemIncludePath.push(setting.defaultSystemIncludePath);
11721172
settings_intelliSenseCachePath.push(util.resolveCachePath(setting.intelliSenseCachePath, this.AdditionalEnvironment));
11731173
settings_intelliSenseCacheSize.push(setting.intelliSenseCacheSize);
@@ -1352,8 +1352,10 @@ export class DefaultClient implements Client {
13521352
enhancedColorization: settings_enhancedColorization,
13531353
suggestSnippets: settings_suggestSnippets,
13541354
simplifyStructuredComments: workspaceSettings.simplifyStructuredComments,
1355-
generatedDoxygenCommentStyle: settings_generatedDoxygenCommentStyle,
1356-
autocompleteDoxygenComment: settings_autocompleteDoxygenComment,
1355+
doxygen: {
1356+
generatedStyle: settings_doxygenGeneratedCommentStyle,
1357+
generateOnType: settings_doxygenGenerateOnType
1358+
},
13571359
loggingLevel: workspaceSettings.loggingLevel,
13581360
workspaceParsingPriority: workspaceSettings.workspaceParsingPriority,
13591361
workspaceSymbols: workspaceSettings.workspaceSymbols,
@@ -1461,6 +1463,9 @@ export class DefaultClient implements Client {
14611463
},
14621464
space: vscode.workspace.getConfiguration("C_Cpp.vcFormat.space", this.RootUri),
14631465
wrap: vscode.workspace.getConfiguration("C_Cpp.vcFormat.wrap", this.RootUri)
1466+
},
1467+
doxygen: {
1468+
...vscode.workspace.getConfiguration("C_Cpp.doxygen", this.RootUri)
14641469
}
14651470
},
14661471
editor: {

Extension/src/LanguageServer/settings.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,8 +221,8 @@ export class CppSettings extends Settings {
221221
public get workspaceSymbols(): string | undefined { return super.Section.get<string>("workspaceSymbols"); }
222222
public get exclusionPolicy(): string | undefined { return super.Section.get<string>("exclusionPolicy"); }
223223
public get simplifyStructuredComments(): boolean | undefined { return super.Section.get<boolean>("simplifyStructuredComments"); }
224-
public get generatedDoxygenCommentStyle(): string | undefined { return super.Section.get<string>("generatedDoxygenCommentStyle"); }
225-
public get autocompleteDoxygenComment(): boolean | undefined { return super.Section.get<boolean>("autocompleteDoxygenComment"); }
224+
public get doxygenGeneratedCommentStyle(): string | undefined { return super.Section.get<string>("doxygen.generatedStyle"); }
225+
public get doxygenGenerateOnType(): boolean | undefined { return super.Section.get<boolean>("doxygen.generateOnType"); }
226226
public get commentContinuationPatterns(): (string | CommentPattern)[] | undefined { return super.Section.get<(string | CommentPattern)[]>("commentContinuationPatterns"); }
227227
public get configurationWarnings(): string | undefined { return super.Section.get<string>("configurationWarnings"); }
228228
public get preferredPathSeparator(): string | undefined { return super.Section.get<string>("preferredPathSeparator"); }

0 commit comments

Comments
 (0)