summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHO-COOH <42881734+HO-COOH@users.noreply.github.com>2021-05-15 19:17:14 +0800
committerGitHub <noreply@github.com>2021-05-15 13:17:14 +0200
commit57b20882140ea56b2c67fa43f345af114041f027 (patch)
tree56878f69aa71629acc2e991a5efe8350c26011cb
parent32b3506ac11e878a8370c2b0864856e79da53f50 (diff)
downloaddoxdocgen-57b20882140ea56b2c67fa43f345af114041f027.tar.gz
Add valid tags in generic order in readme (#228)
-rw-r--r--README.md6
-rw-r--r--package.json4
2 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index decc8f2..f3c29e1 100644
--- a/README.md
+++ b/README.md
@@ -207,7 +207,11 @@ Each of them can be configured with its own custom text and you can decide if th
"tparam",
"param",
"return",
- "custom"
+ "custom",
+ "version",
+ "author",
+ "date",
+ "copyright"
],
// Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.
diff --git a/package.json b/package.json
index 480c6b3..e24e723 100644
--- a/package.json
+++ b/package.json
@@ -199,7 +199,7 @@
"default": true
},
"doxdocgen.generic.order": {
- "markdownDescription": "The order to use for the comment generation. Values can be used multiple times. Valid values are `brief`, `empty`, `tparam`, `param`, `return` and `custom`.",
+ "markdownDescription": "The order to use for the comment generation. Values can be used multiple times. Valid values are `brief`, `empty`, `tparam`, `param`, `return`, `custom`, `author`, `date`, `version` and `copyright`.",
"type": [
"array",
"string"
@@ -214,7 +214,7 @@
]
},
"doxdocgen.generic.customTags": {
- "description": "Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.",
+ "markdownDescription": "Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.",
"type": [
"array",
"string"