summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorto-s <tobias.weber@enisyst.de>2020-10-19 12:38:51 -0400
committerGitHub <noreply@github.com>2020-10-19 18:38:51 +0200
commit771d246a96cd476fa9fddf600c532a28b2efd93a (patch)
treebd03b4bdec9a6a5bb85baca7ca7d988cde64fe95 /README.md
parentd629202dd9419569c109475ad9f10405d8ab0d22 (diff)
downloaddoxdocgen-771d246a96cd476fa9fddf600c532a28b2efd93a.tar.gz
Substitute author and email by git config (#186)
* Substitute author and email by git config * Upgraded version of typescript Due to https://github.com/cschlosser/doxdocgen/pull/186#discussion_r505813068 * Moved to CppDocGen.generateAuthorTag() Due to https://github.com/cschlosser/doxdocgen/pull/186#discussion_r505819542 * Update README.md Due to https://github.com/cschlosser/doxdocgen/pull/186#discussion_r505822908 * Update TestSetup.ts * Added tests * Changed return type to string Due to https://ci.appveyor.com/project/cschlosser/doxdocgen/builds/35818180#L566 Co-authored-by: Christoph Schlosser <2466365+cschlosser@users.noreply.github.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 95f7e80..b1e3248 100644
--- a/README.md
+++ b/README.md
@@ -215,7 +215,13 @@ Each of them can be configured with its own custom text and you can decide if th
"doxdocgen.generic.splitCasingSmartText": true,
// Array of keywords that should be removed from the input prior to parsing.
- "doxdocgen.generic.filteredKeywords": []
+ "doxdocgen.generic.filteredKeywords": [],
+
+ // Substitute {author} with git config --get user.name.
+ "doxdocgen.generic.useGitUserName": false,
+
+ // Substitute {email} with git config --get user.email.
+ "doxdocgen.generic.useGitUserEmail": false
```
## Contributors