Skip to content

Commit fa3a9ee

Browse files
elierichaeliericha
committed
Improve descriptions of vscode settings
1 parent 70b56b2 commit fa3a9ee

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

‎integration/vscode/ada/package.json‎

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,13 @@
286286
"messages",
287287
"verbose"
288288
],
289+
"enumDescriptions": [
290+
"No traces are emitted.",
291+
"Brief traces are emitted for each request sent and each response received.",
292+
"Verbose traces are emitted for each request sent and each response received, including the message content."
293+
],
289294
"default": "off",
290-
"description": "Traces the communication between VSCode and the Ada language server."
295+
"description": "Instructs the VS Code language client to log the communication with the Ada language server in the VS Code output window 'Ada Language Server'."
291296
},
292297
"gpr.trace.server": {
293298
"scope": "window",
@@ -297,26 +302,36 @@
297302
"messages",
298303
"verbose"
299304
],
305+
"enumDescriptions": [
306+
"No traces are emitted.",
307+
"Brief traces are emitted for each request sent and each response received.",
308+
"Verbose traces are emitted for each request sent and each response received, including the message content."
309+
],
300310
"default": "off",
301-
"description": "Traces the communication between VSCode and the GPR language server."
311+
"description": "Instructs the VS Code language client to log the communication with the GPR language server in the VS Code output window 'GPR Language Server'."
302312
},
303313
"ada.projectFile": {
304314
"scope": "window",
305315
"type": "string",
306316
"default": "",
307-
"description": "Project file (*.gpr) for given workspace."
317+
"description": "GPR project file (*.gpr) for this workspace.\n\nIt is recommended to set this to a relative path starting at the root of the workspace."
308318
},
309319
"ada.scenarioVariables": {
310320
"scope": "window",
311321
"type": "object",
312322
"default": {},
313-
"description": "Scenario variables."
323+
"description": "Scenario variables to apply to the GPR project file.\n\nThis value should be provided as an object where the property names are GPR scenario variables and the values are strings.",
324+
"patternProperties": {
325+
".*": {
326+
"type": "string"
327+
}
328+
}
314329
},
315330
"ada.defaultCharset": {
316331
"scope": "window",
317332
"type": "string",
318333
"default": "iso-8859-1",
319-
"description": "The character set to use while reading files from disk."
334+
"description": "The character set that the Ada Language Server should use when reading files from disk."
320335
},
321336
"ada.documentationStyle": {
322337
"scope": "window",
@@ -330,7 +345,7 @@
330345
"Documentation for the entities extracted from the comments before the entity declaration."
331346
],
332347
"default": "gnat",
333-
"description": "Controls primary documentation style of entities."
348+
"description": "Controls the primary documentation style of entities."
334349
},
335350
"ada.displayMethodAncestryOnNavigation": {
336351
"scope": "window",
@@ -354,61 +369,62 @@
354369
"scope": "window",
355370
"type": "boolean",
356371
"default": true,
357-
"description": "The emission of diagnostics."
372+
"description": "Controls whether or not the Ada Language Server should emit diagnostics into the VS Code Problems view."
358373
},
359374
"ada.enableIndexing": {
360375
"scope": "window",
361376
"type": "boolean",
362377
"default": true,
363-
"description": "Controls indexing the source files after loading a project."
378+
"description": "Controls whether the Ada Language Server should index the source files immediately after loading a project.\n\nIf set to false, indexing will be deferred to the time when an action requiring the index is first performed, e.g. hovering over a referenced entity to get its documentation."
364379
},
365380
"ada.foldComments": {
366381
"scope": "window",
367382
"type": "boolean",
368383
"default": true,
369-
"description": "Controls the inclusion of comments in folding blocks."
384+
"description": "Controls whether comments should be folded like code blocks."
370385
},
371386
"ada.followSymlinks": {
372387
"scope": "window",
373388
"type": "boolean",
374389
"default": true,
375-
"description": "Controls the file names normalization sent by a client."
390+
"description": "Controls the Ada Language Server normalizes the file paths received from the client."
376391
},
377392
"ada.namedNotationThreshold": {
378393
"scope": "window",
379394
"type": "integer",
380395
"default": 3,
381-
"description": "Defines the number of parameters/components at which point named notation is used for completion snippets."
396+
"description": "Defines the number of parameters/components beyond which named notation is used for completion snippets."
382397
},
383398
"ada.relocateBuildTree": {
384399
"scope": "window",
385400
"type": "string",
386401
"default": "",
387-
"description": "The folder for out-of-tree build."
402+
"description": "The folder for out-of-tree build.",
403+
"markdownDescription": "The path to a directory used for out-of-tree builds. This feature is related to the [--relocate-build-tree GPRbuild command line switch](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches)."
388404
},
389405
"ada.rootDir": {
390406
"scope": "window",
391407
"type": "string",
392408
"default": "",
393-
"description": "The root directory for artifacts for proper relocation. Used with relocateBuildTree."
409+
"markdownDescription": "This setting must be used in conjunction with the `relocateBuildTree` setting.\n\nIt specifies the root directory for artifact relocation. It corresponds to the [--root-dir GPRbuild command line switch](https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches)."
394410
},
395411
"ada.useCompletionSnippets": {
396412
"scope": "window",
397413
"type": "boolean",
398414
"default": false,
399-
"description": "Enable snippets in completion results (e.g: subprogram calls)."
415+
"description": "Enable snippets in completion results (e.g. subprogram calls)."
400416
},
401417
"ada.renameInComments": {
402418
"scope": "window",
403419
"type": "boolean",
404420
"default": false,
405-
"description": "Enable editing Ada comments while executing `textDocument/rename` request."
421+
"description": "Enable editing Ada comments to update references to an entity when it is being renamed."
406422
},
407423
"ada.onTypeFormatting.indentOnly": {
408424
"scope": "window",
409425
"type": "boolean",
410426
"default": true,
411-
"description": "Controls if the `textDocument/onTypeFormatting` request only indents a new line, or if it additionally tries to format the previous node."
427+
"markdownDescription": "If the VS Code `editor.formatOnType` setting is enabled, the Ada Language Server will format Ada code while it is being typed in the editor, in particular when a new line is typed.\n\nThis setting controls whether formatting should only perform the indentation of the new line (true) or also format the previous line (false)."
412428
}
413429
}
414430
}

0 commit comments

Comments
 (0)