|
11 | 11 | ], |
12 | 12 | "properties": { |
13 | 13 | "name": { |
14 | | - "description": "Configuration identifier. Mac, Linux, and Win32 are special identifiers for configurations that will be auto-selected on those platforms, but the identifier can be anything.", |
| 14 | + "markdownDescription": "Configuration identifier. `Mac`, `Linux`, and `Win32` are special identifiers for configurations that will be auto-selected on those platforms, but the identifier can be anything.", |
| 15 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
15 | 16 | "type": "string" |
16 | 17 | }, |
17 | 18 | "compilerPath": { |
18 | | - "description": "Full path of the compiler being used, e.g. /usr/bin/gcc, to enable more accurate IntelliSense.", |
| 19 | + "markdownDescription": "Full path of the compiler being used, e.g. `/usr/bin/gcc`, to enable more accurate IntelliSense.", |
| 20 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
19 | 21 | "type": "string" |
20 | 22 | }, |
21 | 23 | "compilerArgs": { |
22 | | - "description": "Compiler arguments to modify the includes or defines used, e.g. -nostdinc++, -m32, etc.", |
| 24 | + "markdownDescription": "Compiler arguments to modify the includes or defines used, e.g. `-nostdinc++`, `-m32`, etc.", |
| 25 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
23 | 26 | "type": "array", |
24 | 27 | "items": { |
25 | 28 | "type": "string" |
|
60 | 63 | ] |
61 | 64 | }, |
62 | 65 | "compileCommands": { |
63 | | - "description": "Full path to compile_commands.json file for the workspace.", |
| 66 | + "markdownDescription": "Full path to `compile_commands.json` file for the workspace.", |
| 67 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
64 | 68 | "type": "string" |
65 | 69 | }, |
66 | 70 | "includePath": { |
67 | | - "description": "A list of paths for the IntelliSense engine to use while searching for included headers. Searching on these paths is not recursive. Specify '**' to indicate recursive search. For example, '${workspaceFolder}/**' will search through all subdirectories while '${workspaceFolder}' will not.", |
| 71 | + "markdownDescription": "A list of paths for the IntelliSense engine to use while searching for included headers. Searching on these paths is not recursive. Specify `**` to indicate recursive search. For example, `${workspaceFolder}/**` will search through all subdirectories while `${workspaceFolder}` will not. Usually, this should not include system includes; instead, set `#C_Cpp.default.compilerPath#`.", |
| 72 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
68 | 73 | "type": "array", |
69 | 74 | "items": { |
70 | 75 | "type": "string" |
|
78 | 83 | } |
79 | 84 | }, |
80 | 85 | "windowsSdkVersion": { |
81 | | - "description": "Version of the Windows SDK include path to use on Windows, e.g. '10.0.17134.0'.", |
| 86 | + "markdownDescription": "Version of the Windows SDK include path to use on Windows, e.g. `10.0.17134.0`.", |
| 87 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
82 | 88 | "type": "string", |
83 | 89 | "pattern": "^\\d{2}\\.\\d{1}\\.\\d{5}\\.\\d{1}$|^8\\.1$" |
84 | 90 | }, |
85 | 91 | "defines": { |
86 | | - "description": "A list of preprocessor definitions for the IntelliSense engine to use while parsing files. Optionally, use = to set a value, e.g. VERSION=1.", |
| 92 | + "markdownDescription": "A list of preprocessor definitions for the IntelliSense engine to use while parsing files. Optionally, use `=` to set a value, e.g. `VERSION=1`.", |
| 93 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
87 | 94 | "type": "array", |
88 | 95 | "items": { |
89 | 96 | "type": "string" |
90 | 97 | } |
91 | 98 | }, |
92 | 99 | "intelliSenseMode": { |
93 | | - "description": "The IntelliSense mode to use that maps to a platform and architecture variant of MSVC, gcc, or Clang. If not set or if set to ${default}, the extension will choose the default for that platform. Windows defaults to windows-msvc-x64, Linux defaults to linux-gcc-x64, and macOS defaults to macos-clang-x64. IntelliSense modes that only specify <compiler>-<architecture> variants (e.g. gcc-x64) are legacy modes and are converted automatically to the <platform>-<compiler>-<architecture> variants based on the host platform.", |
| 100 | + "markdownDescription": "The IntelliSense mode to use that maps to a platform and architecture variant of MSVC, gcc, or Clang. If not set or if set to `${default}`, the extension will choose the default for that platform. Windows defaults to `windows-msvc-x64`, Linux defaults to `linux-gcc-x64`, and macOS defaults to `macos-clang-x64`. IntelliSense modes that only specify `<compiler>-<architecture>` variants (e.g. `gcc-x64`) are legacy modes and are converted automatically to the `<platform>-<compiler>-<architecture>` variants based on the host platform.", |
| 101 | + "descriptionHint": "Uses of words 'platform', 'compiler', and 'architecture' are meant to be descriptive placeholders for literal values, so they should be translated, but without changing the surrounding `<>-<>` symbols. All other text inside `` should not be translated.", |
94 | 102 | "type": "string", |
95 | 103 | "enum": [ |
96 | 104 | "macos-clang-x86", |
|
151 | 159 | "type": "object", |
152 | 160 | "properties": { |
153 | 161 | "limitSymbolsToIncludedHeaders": { |
154 | | - "description": "true to process only those files directly or indirectly included as headers, false to process all files under the specified include paths.", |
| 162 | + "markdownDescription": "`true` to process only those files directly or indirectly included as headers, `false` to process all files under the specified include paths.", |
| 163 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
155 | 164 | "type": [ |
156 | 165 | "boolean", |
157 | 166 | "string" |
|
162 | 171 | "type": "string" |
163 | 172 | }, |
164 | 173 | "path": { |
165 | | - "description": "A list of paths to use for indexing and parsing of workspace symbols (for use by Go to Definition, Find All References, etc.). Searching on these paths is recursive by default. Specify '*' to indicate non-recursive search. For example, '${workspaceFolder}' will search through all subdirectories while '${workspaceFolder}/*' will not.", |
| 174 | + "markdownDescription": "A list of paths to use for indexing and parsing of workspace symbols (for use by 'Go to Definition', 'Find All References', etc.). Searching on these paths is recursive by default. Specify `*` to indicate non-recursive search. For example, `${workspaceFolder}` will search through all subdirectories while `${workspaceFolder}/*` will not.", |
| 175 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
166 | 176 | "type": "array", |
167 | 177 | "items": { |
168 | 178 | "type": "string" |
|
173 | 183 | }, |
174 | 184 | "customConfigurationVariables": { |
175 | 185 | "type": "object", |
176 | | - "description": "Custom variables that can be queried through the command ${cpptools:activeConfigCustomVariable} to use for the input variables in launch.json or tasks.json.", |
| 186 | + "markdownDescription": "Custom variables that can be queried through the command `${cpptools:activeConfigCustomVariable}` to use for the input variables in `launch.json` or `tasks.json`.", |
| 187 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered.", |
177 | 188 | "patternProperties": { |
178 | 189 | "(^.+$)": { |
179 | 190 | "type": "string" |
|
187 | 198 | }, |
188 | 199 | "env": { |
189 | 200 | "type": "object", |
190 | | - "description": "Custom variables that can be reused anywhere in this file using the ${variable} or ${env:variable} syntax.", |
191 | | - "descriptionHint": "The word 'variable' within curly braces should also be translated. The \"env\" should not be translated, and the punctuation (\"${:}\") should be preserved.", |
| 201 | + "markdownDescription": "Custom variables that can be reused anywhere in this file using the `${variable}` or `${env:variable}` syntax.", |
| 202 | + "descriptionHint": "The word 'variable' within curly braces should be translated. The \"env\" should not be translated, and the punctuation (\"${:}\") should be preserved.", |
192 | 203 | "patternProperties": { |
193 | | - "(?!^workspaceFolder$)(?!^workspaceRoot$)(?!^workspaceFolderBasename$)(?!^default$)(^.+$)": { |
| 204 | + "(?!^workspaceFolder$)(?!^workspaceRoot$)(?!^workspaceFolderBasename$)(?!^execPath$)(?!^pathSeparator$)(?!^default$)(^.+$)": { |
194 | 205 | "oneOf": [ |
195 | 206 | { |
196 | 207 | "type": "string" |
|
213 | 224 | "enableConfigurationSquiggles": { |
214 | 225 | "type": "boolean", |
215 | 226 | "default": true, |
216 | | - "description": "Controls whether the extension will report errors detected in c_cpp_properties.json." |
| 227 | + "markdownDescription": "Controls whether the extension will report errors detected in `c_cpp_properties.json`.", |
| 228 | + "descriptionHint": "Markdown text between `` should not be translated and the punctuation should not be altered." |
217 | 229 | } |
218 | 230 | }, |
219 | 231 | "properties": { |
|
0 commit comments