summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2018-03-03 00:02:24 +0100
committerChristoph Schlosser <christophschlosser@users.noreply.github.com>2018-03-07 22:14:50 +0100
commit8007bfeb16ee14adc39de76e995725c77643fd05 (patch)
treee6f7eed9e6a33b540279a83a8f006f28b35305ab /README.md
parentaeb67cd13dcf5e5b69898dff6c05c605a81827f4 (diff)
downloaddoxdocgen-8007bfeb16ee14adc39de76e995725c77643fd05.tar.gz
Update documentation of config parameters
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/README.md b/README.md
index 3ac060f..b3884cb 100644
--- a/README.md
+++ b/README.md
@@ -98,7 +98,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.
+// The prefix that is used for each comment line except for first and last.
"doxdocgen.c.commentPrefix": " * ",
// Smart text snippet for factory methods/functions.
@@ -116,7 +116,7 @@ Each of them can be configured with its own custom text and you can decide if th
// Smart text snippet for setters.
"doxdocgen.c.setterText": "Set the {name} object",
-// Doxygen comment trigger. This character sequence triggers generation of DoxyGen comments.
+// Doxygen comment trigger. This character sequence triggers generation of Doxygen comments.
"doxdocgen.c.triggerSequence": "/**",
// Smart text snippet for constructors.
@@ -125,7 +125,7 @@ Each of them can be configured with its own custom text and you can decide if th
// Smart text snippet for destructors.
"doxdocgen.cpp.dtorText": "Destroy the {name} object",
-// The template of the template parameter DoxyGen line(s) that are generated. If empty it won't get generated at all.
+// The template of the template parameter Doxygen line(s) that are generated. If empty it won't get generated at all.
"doxdocgen.cpp.tparamTemplate": "@tparam {param} ",
// The order to use for the file comment. Values can be used multiple times. Valid values are shown in default setting.
@@ -137,7 +137,7 @@ Each of them can be configured with its own custom text and you can decide if th
"date"
],
-// The template for the file parameter in DoxyGen.
+// The template for the file parameter in Doxygen.
"doxdocgen.file.fileTemplate": "@file {name}",
// Set the style of the author tag and your name.
@@ -146,13 +146,13 @@ Each of them can be configured with its own custom text and you can decide if th
// If this is enabled a bool return value will be split into true and false return param.
"doxdocgen.generic.boolReturnsTrueFalse": true,
-// The template of the brief DoxyGen line that is generated. If empty it won't get generated at all.
-"doxdocgen.generic.briefTemplate": "@brief ",
+// The template of the brief Doxygen line that is generated. If empty it won't get generated at all.
+"doxdocgen.generic.briefTemplate": "@brief {text}",
// The format to use for the date.
"doxdocgen.generic.dateFormat": "YYYY-MM-DD",
-// The template for the date parameter in DoxyGen.
+// The template for the date parameter in Doxygen.
"doxdocgen.generic.dateTemplate": "@date {date}",
// Decide if you want to get smart text for certain commands.
@@ -161,7 +161,7 @@ Each of them can be configured with its own custom text and you can decide if th
// Whether include type information at return.
"doxdocgen.generic.includeTypeAtReturn": true,
-// How many lines the plugin should look for to find the end of the declaration. Please be aware that setting this value too low may improve the speed of comment generation but the plugin also may not correctly detect all declarations or definitions anymore.
+// How many lines the plugin should look for to find the end of the declaration. Please be aware that setting this value too low could improve the speed of comment generation by a very slim margin but the plugin also may not correctly detect all declarations or definitions anymore.
"doxdocgen.generic.linesToGet": 20,
// The order to use for the comment generation. Values can be used multiple times. Valid values are shown in default setting.
@@ -173,10 +173,10 @@ Each of them can be configured with its own custom text and you can decide if th
"return"
],
-// The template of the param DoxyGen line(s) that are generated. If empty it won't get generated at all.
+// The template of the param Doxygen line(s) that are generated. If empty it won't get generated at all.
"doxdocgen.generic.paramTemplate": "@param {param} ",
-// The template of the return DoxyGen line that is generated. If empty it won't get generated at all.
+// The template of the return Doxygen line that is generated. If empty it won't get generated at all.
"doxdocgen.generic.returnTemplate": "@return {type} ",
// Decide if the values put into {name} should be split according to their casing.