Skip to content

Commit ef23380

Browse files
authored
Document HeaderInsertion config option (#129)
1 parent d934529 commit ef23380

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

config.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,10 +371,19 @@ Possible values: `None` (default), `Strict`.
371371

372372
## Completion
373373

374+
Configures code completion features. Sample block (default):
375+
376+
```yaml
377+
Completion:
378+
AllScopes: Yes
379+
ArgumentLists: FullPlaceholders
380+
HeaderInsertion: IWYU
381+
```
382+
374383
### AllScopes
375384
{:.v13}
376385
Whether code completion should include suggestions from scopes that are
377-
not visible. The required scope prefix will be inserted.
386+
not visible. The required scope prefix will be inserted. Default is `Yes`.
378387

379388
### ArgumentLists
380389
{:.v20}
@@ -394,6 +403,16 @@ The default is `FullPlaceholders`.
394403
This option governs the completion of template names as well, where
395404
the delimiters are `<>`.
396405

406+
### HeaderInsertion
407+
{:.v21}
408+
409+
Add `#include` directives when accepting code completions. Config
410+
equivalent of the CLI option `--header-insertion`. Valid values are:
411+
- `IWYU`: Include what you use. Insert the owning header for top-level
412+
symbols, unless the header is already directly included or the
413+
symbol is forward-declared. This is the default.
414+
- `Never`: Never insert headers.
415+
397416
## InlayHints
398417
{:.v14}
399418

0 commit comments

Comments
 (0)