@@ -35,24 +35,22 @@ for `initializationOptions`. On the protocol level messages look like:
3535
3636Ada Language Server understands these settings:
3737
38- * [ projectFile] ( #projectFile )
39- * [ scenarioVariables] ( #scenarioVariables )
40- * [ defaultCharset] ( #defaultCharset )
41- * [ relocateBuildTree] ( #relocateBuildTree )
42- * [ rootDir] ( #rootDir )
43- * [ enableDiagnostics] ( #enableDiagnostics )
44- * [ enableIndexing] ( #enableIndexing )
45- * [ renameInComments] ( #renameInComments )
46- * [ namedNotationThreshold] ( #namedNotationThreshold )
47- * [ foldComments] ( #foldComments )
48- * [ followSymlinks] ( #followSymlinks )
49- * [ documentationStyle] ( #documentationStyle )
50- * [ onTypeFormatting.indentOnly] ( #onTypeFormatting.indentOnly )
38+ * [ projectFile] ( #projectfile )
39+ * [ scenarioVariables] ( #scenariovariables )
40+ * [ defaultCharset] ( #defaultcharset )
41+ * [ relocateBuildTree] ( #relocatebuildtree )
42+ * [ rootDir] ( #rootdir )
43+ * [ enableDiagnostics] ( #enablediagnostics )
44+ * [ enableIndexing] ( #enableindexing )
45+ * [ renameInComments] ( #renameincomments )
46+ * [ namedNotationThreshold] ( #namednotationthreshold )
47+ * [ foldComments] ( #foldcomments )
48+ * [ followSymlinks] ( #followsymlinks )
49+ * [ documentationStyle] ( #documentationstyle )
50+ * [ onTypeFormatting.indentOnly] ( #ontypeformattingindentonly )
5151
5252----
5353
54-
55-
5654## projectFile
5755
5856You can configure the GNAT Project File via the ` projectFile ` key.
@@ -67,6 +65,7 @@ root folder, then ALS will use it.
6765```
6866
6967## scenarioVariables
68+
7069You can configure scenario variables via the ` scenarioVariables ` key.
7170The setting has an object value. Keys in this object correspond to
7271scenario variables names and string values to variables values.
@@ -76,7 +75,9 @@ scenario variables names and string values to variables values.
7675 ' BUILD_MODE' : ' DEBUG'
7776 }
7877```
78+
7979## defaultCharset
80+
8081You can set the character set to use when the server has to use when reading
8182files from disk by specifying an ` defaultCharset ` key. The default is
8283` iso-8859-1 ` . This should have a string value.
@@ -86,28 +87,33 @@ files from disk by specifying an `defaultCharset` key. The default is
8687```
8788
8889## relocateBuildTree
90+
8991With this option it is possible to achieve out-of-tree build. That is,
9092real object, library or exec directories are relocated to the current
9193working directory or dir if specified. Ensure that it is full normalized
9294path ended with the directory separator. Visit
93- https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches
95+ the [ gprbuild documentation ] ( https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches )
9496for more details about the corresponding gprbuild switch.
97+
9598``` javascript
9699 ' relocateBuildTree' : ' /home/user/project/build/'
97100```
98101
99102## rootDir
103+
100104This option is to be used with relocateBuildTree above and cannot be
101105specified alone. This option specifies the root directory for artifacts
102106for proper relocation. Ensure that it is full normalized path ended
103107with the directory separator. Visit
104- https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches
108+ the [ gprbuild documentation ] ( https://docs.adacore.com/gprbuild-docs/html/gprbuild_ug/building_with_gprbuild.html#switches )
105109for more details about the corresponding gprbuild switch.
110+
106111``` javascript
107112 ' relocateBuildTree' : ' /home/user/project/'
108113```
109114
110115## enableDiagnostics
116+
111117You can explicitly deactivate the emission of diagnostics, via the
112118` enableDiagnostics ` key. By default, diagnostics are enabled.
113119The value is a boolean.
@@ -117,6 +123,7 @@ The value is a boolean.
117123```
118124
119125## enableIndexing
126+
120127By default, the server indexes the source files after loading a project,
121128to speed up subsequent requests. This behavior can be controlled
122129via the ` enableIndexing ` flag in this request.
@@ -127,6 +134,7 @@ The value is a boolean.
127134```
128135
129136## renameInComments
137+
130138The language server is able to edit Ada comments while executing
131139` textDocument/rename ` request. To enable this just set
132140` renameInComments ` setting to ` true ` .
@@ -137,6 +145,7 @@ The value is a boolean.
137145```
138146
139147## useCompletionSnippets
148+
140149Whether we should use snippets in completion results. Snippets can be
141150returned in case of subprogram calls for instance, with placeholders
142151for each parameter needed by the subprogram.
@@ -147,25 +156,27 @@ The value is a boolean.
147156```
148157
149158## displayMethodAncestryOnNavigation
159+
150160This setting controls the policy for displaying overriding and overridden
151161subprograms on navigation requests such as ` textDocument/definition ` ,
152162` textDocument/declaration ` or ` textDocument/implementation ` .
153163
154164The different policies are:
155165
156- * ` never ` : Never list overridding and/or overridden suprograms.
157- * ` usage_and_abstract_only ` : List overridding and/or overridden suprograms
158- on dispatching calls and on abstract subprogram declarations.
159- * ` definition_only ` : List overridding and/or overridden suprograms on
160- declarations only.
161- * ` always ` : Always list overridding and/or overridden suprograms when
162- possible.
166+ * ` never ` : Never list overridding and/or overridden suprograms.
167+ * ` usage_and_abstract_only ` : List overridding and/or overridden suprograms
168+ on dispatching calls and on abstract subprogram declarations.
169+ * ` definition_only ` : List overridding and/or overridden suprograms on
170+ declarations only.
171+ * ` always ` : Always list overridding and/or overridden suprograms when
172+ possible.
163173
164174``` javascript
165175 ' displayMethodAncestryOnNavigation' : ' always'
166176```
167177
168178## namedNotationThreshold
179+
169180This setting defines the number of parameters/components at which point named
170181notation is used for subprogram/aggregate completion snippets.
171182The value is a number. The default value is ` 3 ` .
@@ -175,12 +186,14 @@ The value is a number. The default value is `3`.
175186```
176187
177188## foldComments
189+
178190When this setting is ` true ` the server sends blocks information for comments which can be used for folding comment blocks.
179191The value is a boolean. The default is ` true ` .
180192
181193``` javascript
182194 ' foldComments' : false
183195```
196+
184197## followSymlinks
185198
186199When this setting is ` false ` the server doesn't do any attempts to normalize file names sent by a client.
@@ -193,6 +206,7 @@ The value is a boolean. The default is `true`.
193206```
194207
195208## documentationStyle
209+
196210The language server supports different styles to document entities in the source
197211code. This setting controls primary documentation style of entities. When
198212documentation for the entity is not found, the language server uses a few
@@ -201,10 +215,10 @@ declaration, extract documentation from subprogram's body, etc.)
201215
202216Supported styles are:
203217
204- * ` gnat ` : Default style, based on GNAT coding standard with some
205- enhancements.
206- * ` leading ` : Documentation for the entities extracted from the comments
207- before the entity declaration.
218+ * ` gnat ` : Default style, based on GNAT coding standard with some
219+ enhancements.
220+ * ` leading ` : Documentation for the entities extracted from the comments
221+ before the entity declaration.
208222
209223For more information about documentation styles see GNATdoc User's Manual.
210224
0 commit comments