summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2020-06-26 15:02:38 +0200
committerChristoph Schlosser <christophschlosser@users.noreply.github.com>2020-06-26 15:09:49 +0200
commit3e68f18e2e10d90bd094707141c943146482f68b (patch)
tree28e78a5ca625812e3241cb1917c3f34473fc3061 /README.md
parent42a085fbda8e742595cf5b543ac4f8202c03fb7d (diff)
downloaddoxdocgen-3e68f18e2e10d90bd094707141c943146482f68b.tar.gz
Add option to filter keywords
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 0eaea78..24de003 100644
--- a/README.md
+++ b/README.md
@@ -106,7 +106,7 @@ Each of them can be configured with its own custom text and you can decide if th
## Config options
```json
-// The prefix that is used for each comment line except for first and last.
+ // The prefix that is used for each comment line except for first and last.
"doxdocgen.c.commentPrefix": " * ",
// Smart text snippet for factory methods/functions.
@@ -209,7 +209,10 @@ Each of them can be configured with its own custom text and you can decide if th
"doxdocgen.generic.returnTemplate": "@return {type} ",
// Decide if the values put into {name} should be split according to their casing.
- "doxdocgen.generic.splitCasingSmartText": true
+ "doxdocgen.generic.splitCasingSmartText": true,
+
+ // Array of keywords that should be removed from the input prior to parsing.
+ "doxdocgen.generic.filteredKeywords": []
```
## Contributors