Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions config.md
Original file line number Diff line number Diff line change
Expand Up @@ -535,3 +535,23 @@ Available kinds could be found [here](features#kinds) in the Kind column.
Specify semantic token modifiers that clangd should not send to client.

Available modifiers could be found [here](features#modifiers) in the Modifier column.

## Documentation
{:.v21}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be v22 (llvm/llvm-project@5199489 is not present on the 21 branch), and as it's the first option to be added in v22, the styles need to be adjusted for it.


Specify server side documentation code comment interpretation.
Affects the format of the documentation string sent to the client for hover and code completions.
Sample block (default):

```yaml
Documentation:
CommentFormat: PlainText
```

### CommentFormat

Determines the comment format of code documentation.

- `PlainText`: interpret code documentation as plain text. Markdown specific syntax will be escaped. On clients supporting markdown, this will result in showing markdown syntax without rendering. E.g. using \*\*bold text\*\* in the documentation comment will be shown as \*\*bold text\*\* and not as **bold text** in the hover/code completion.
- `Markdown`: interpret documentation comments as markdown. Markdown syntax will not be escaped, except for HTML tags. On clients supporting markdown, this will result in rendering all markdown syntax.
- `Doxygen`: interpret code documentation as [doxygen](https://www.doxygen.nl/) comments. In addition to treating the documentation as markdown, this will parse the documentation with Clangs doxygen parser. It will highlight used doxygen commands, convert doxygen commands to markdown syntax and extend hover content with e.g. function parameter or return documentation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clangs doxygen parser --> Clang's doxygen parser