diff options
| author | Christoph Schlosser <christophschlosser@users.noreply.github.com> | 2017-10-15 20:12:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-15 20:12:01 +0200 |
| commit | c7ebe707bbfbe52c75646a111600986d6c584d03 (patch) | |
| tree | f5435eda43b5d9bd22348f4400028c07b4a446c8 /package.json | |
| parent | 140229888a0e4a120c11ecaae81132d07cc69e5b (diff) | |
| parent | 32baa67d95609fc2b0f20c582fe152eeee98ff35 (diff) | |
| download | doxdocgen-c7ebe707bbfbe52c75646a111600986d6c584d03.tar.gz | |
Merge pull request #16 from rowanG077/master
-- Added extensive templating the be able to generated different type…
Diffstat (limited to 'package.json')
| -rw-r--r-- | package.json | 64 |
1 files changed, 55 insertions, 9 deletions
diff --git a/package.json b/package.json index 4ea2631..c288cd6 100644 --- a/package.json +++ b/package.json @@ -18,19 +18,65 @@ "type": "object", "title": "Doxygen Documentation Generator Settings", "properties": { - "doxdocgen.generic.commentStart": { - "description": "Doxygen comment start indicator. Default ist /** but Qt style with /*! is also valid.", + "doxdocgen.generic.triggerSequence": { + "description": "Doxygen comment trigger. This character sequence triggers generation of DoxyGen comments.", "type": "string", - "default": "/**", - "enum": [ - "/**", - "/*!" - ] + "default": "/**" }, - "doxdocgen.generic.generateReturnType": { - "description": "Insert return type into generated documentation", + "doxdocgen.generic.firstLine": { + "description": "The first line of the comment that gets generated. If empty it won't get generated at all.", + "type": "string", + "default": "/**" + }, + "doxdocgen.generic.commentPrefix": { + "description": "The prefix that is used for each comment line.", + "type": "string", + "default": " * " + }, + "doxdocgen.generic.lastLine": { + "description": "The last line of the comment that gets generated. If empty it won't get generated at all.", + "type": "string", + "default": " */" + }, + "doxdocgen.generic.newLineAfterBrief": { + "description": "Whether to insert a newline after a brief.", "type": "boolean", "default": true + }, + "doxdocgen.generic.newLineAfterParams": { + "description": "Whether to insert a newline after the params.", + "type": "boolean", + "default": false + }, + "doxdocgen.generic.newLineAfterTParams": { + "description": "Whether to insert a newline after the template params.", + "type": "boolean", + "default": false + }, + "doxdocgen.generic.includeTypeAtReturn": { + "description": "Whether include type information at return.", + "type": "boolean", + "default": true + }, + "doxdocgen.generic.briefTemplate": { + "description": "The template of the brief DoxyGen line that is generated. If empty it won't get generated at all.", + "type": "string", + "default": "@brief " + }, + "doxdocgen.generic.paramTemplate": { + "description": "The template of the param DoxyGen line(s) that are generated. If empty it won't get generated at all.", + "type": "string", + "default": "@param {param} " + }, + "doxdocgen.generic.tparamTemplate": { + "description": "The template of the template parameter DoxyGen line(s) that are generated. If empty it won't get generated at all.", + "type": "string", + "default": "@tparam {param} " + }, + "doxdocgen.generic.returnTemplate": { + "description": "The template of the return DoxyGen line that is generated. If empty it won't get generated at all.", + "type": "string", + "default": "@return {type} " } } } |