summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorHO-COOH <42881734+HO-COOH@users.noreply.github.com>2021-05-15 00:14:36 +0800
committerGitHub <noreply@github.com>2021-05-14 18:14:36 +0200
commitaf70cf95d9d010f27da1c1c8987c807ee3255a10 (patch)
tree9d6de559ea072c684f690d32816f7fe3ae1a88d3 /README.md
parentbe07386c572fe8258a3b4c101b85dd900867bb13 (diff)
downloaddoxdocgen-af70cf95d9d010f27da1c1c8987c807ee3255a10.tar.gz
Refactor, add {file} template (#221)
* Refactor, add {file} template * Add test for {file} expansion
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 4a023dc..decc8f2 100644
--- a/README.md
+++ b/README.md
@@ -148,7 +148,7 @@ Each of them can be configured with its own custom text and you can decide if th
"@copyright Copyright (c) {year}"
],
- // Additional file documentation. Array of strings will be converted to one line per element. Can template {year}, {date}, {author}, and {email}.
+ // Additional file documentation. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.
"doxdocgen.file.customTag": [],
// The order to use for the file comment. Values can be used multiple times. Valid values are shown in default setting.
@@ -210,7 +210,7 @@ Each of them can be configured with its own custom text and you can decide if th
"custom"
],
- // Custom tags to be added to the generic order. One tag per line will be added. You have to specify the prefix yourself.
+ // 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.
"doxdocgen.generic.customTags": [],
// The template of the param Doxygen line(s) that are generated. If empty it won't get generated at all.