From 0ebfa5bd12e529d8febe73c85d3bf48c4d4997e8 Mon Sep 17 00:00:00 2001 From: Rowan Goemans Date: Sat, 14 Oct 2017 22:29:02 +0200 Subject: -- Added extensive templating the be able to generated different types of doxygen comment. --- package.json | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 50 insertions(+), 9 deletions(-) (limited to 'package.json') diff --git a/package.json b/package.json index 4ea2631..f38fef7 100644 --- a/package.json +++ b/package.json @@ -18,19 +18,60 @@ "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 pre fix 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.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 {param} " } } } -- cgit v1.2.3 From cc0d69edcd362c1abde9d0005c70d8e3692395bc Mon Sep 17 00:00:00 2001 From: Rowan Goemans Date: Sun, 15 Oct 2017 02:26:22 +0200 Subject: -- Fixed tslint issues. -- Added config parameter to add type information to return DoxyGen parameter. --- package.json | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'package.json') diff --git a/package.json b/package.json index f38fef7..5d97618 100644 --- a/package.json +++ b/package.json @@ -53,6 +53,11 @@ "type": "boolean", "default": false }, + "doxdocgen.generic.includeTypeAtReturn": { + "description": "Whether include type information at return.", + "type": "boolean", + "default": false + }, "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", -- cgit v1.2.3 From d78b9876918ce8d65876968ee120b2144178af32 Mon Sep 17 00:00:00 2001 From: Rowan Goemans Date: Sun, 15 Oct 2017 13:23:50 +0200 Subject: -- Fixed various issues that came out of the pull request review. --- package.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'package.json') diff --git a/package.json b/package.json index 5d97618..01e9ad7 100644 --- a/package.json +++ b/package.json @@ -28,7 +28,7 @@ "type": "string", "default": "/**" }, - "doxdocgen.generic.commentPrefix": { + "doxdocgen.generic.prefix": { "description": "The pre fix that is used for each comment line.", "type": "string", "default": " * " @@ -36,7 +36,7 @@ "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": "**/" + "default": " */" }, "doxdocgen.generic.newLineAfterBrief": { "description": "Whether to insert a newline after a brief.", @@ -56,7 +56,7 @@ "doxdocgen.generic.includeTypeAtReturn": { "description": "Whether include type information at return.", "type": "boolean", - "default": false + "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.", @@ -76,7 +76,7 @@ "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 {param} " + "default": "@return {type} " } } } -- cgit v1.2.3 From 32baa67d95609fc2b0f20c582fe152eeee98ff35 Mon Sep 17 00:00:00 2001 From: Rowan Goemans Date: Sun, 15 Oct 2017 13:29:28 +0200 Subject: -- Fixed issues from review. --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'package.json') diff --git a/package.json b/package.json index 01e9ad7..c288cd6 100644 --- a/package.json +++ b/package.json @@ -28,8 +28,8 @@ "type": "string", "default": "/**" }, - "doxdocgen.generic.prefix": { - "description": "The pre fix that is used for each comment line.", + "doxdocgen.generic.commentPrefix": { + "description": "The prefix that is used for each comment line.", "type": "string", "default": " * " }, -- cgit v1.2.3