summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhilipp Wagner <mail@philipp-wagner.com>2022-03-24 16:57:14 +0100
committerGitHub <noreply@github.com>2022-03-24 16:57:14 +0100
commit1ca2f32af15d3ee013baf0375b05bc095c5ae6f6 (patch)
treef31750ca799f8a87f0d5504f965e49dcd616bf46
parent66816501cae9f60d0f363b4476cffd8b7c896505 (diff)
downloaddoxdocgen-1ca2f32af15d3ee013baf0375b05bc095c5ae6f6.tar.gz
README: Use syntax highlighter that allows comments (#279)
Use the `jsonc` instead of the `json` syntax highlighter in the README to avoid the comments being marked as error
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index db3ddaa..7fc0664 100644
--- a/README.md
+++ b/README.md
@@ -112,7 +112,8 @@ Each of them can be configured with its own custom text and you can decide if th
## Config options
-```json
+```jsonc
+{
// The prefix that is used for each comment line except for first and last.
"doxdocgen.c.commentPrefix": " * ",
@@ -240,6 +241,7 @@ Each of them can be configured with its own custom text and you can decide if th
// Add `\\` in doxygen command suggestion for better readbility (need to enable commandSuggestion)
"doxdocgen.generic.commandSuggestionAddPrefix": false
+}
```
## Contributors