summaryrefslogtreecommitdiffstats
path: root/package.json
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2018-03-01 23:17:23 +0100
committerChristoph Schlosser <christophschlosser@users.noreply.github.com>2018-03-02 20:24:28 +0100
commit5368c8151df632ba0ebd863cbc7ff105dc4027bf (patch)
treedd27cde65349833d14fde7a12880958592016dc3 /package.json
parenta936ada9f3609466f73d7c23450bfb3c0ce7e6ee (diff)
downloaddoxdocgen-5368c8151df632ba0ebd863cbc7ff105dc4027bf.tar.gz
Change config structure
Diffstat (limited to 'package.json')
-rw-r--r--package.json89
1 files changed, 53 insertions, 36 deletions
diff --git a/package.json b/package.json
index 14f61a4..a8eda70 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "doxdocgen",
"displayName": "Doxygen Documentation Generator",
- "description": "Generate doxygen documentation from source code",
+ "description": "Let it generate Doxygen documentation from your source code.",
"version": "0.2.1",
"publisher": "cschlosser",
"engines": {
@@ -10,6 +10,23 @@
"categories": [
"Other"
],
+ "badges": [
+ {
+ "url": "https://travis-ci.org/christophschlosser/doxdocgen.svg?branch=master",
+ "href": "https://travis-ci.org/christophschlosser/doxdocgen",
+ "description": "Continuous Integration (Travis)"
+ },
+ {
+ "url": "https://ci.appveyor.com/api/projects/status/4h84071p9tv0y9r6?svg=true",
+ "href": "https://ci.appveyor.com/project/christophschlosser/doxdocgen",
+ "description": "Continuous Integration (AppVeyor)"
+ },
+ {
+ "url": "https://codecov.io/gh/christophschlosser/doxdocgen/branch/master/graph/badge.svg",
+ "href": "https://codecov.io/gh/christophschlosser/doxdocgen",
+ "description": "Code coverage"
+ }
+],
"activationEvents": [
"onLanguage:cpp",
"onLanguage:c"
@@ -19,26 +36,56 @@
"type": "object",
"title": "Doxygen Documentation Generator Settings",
"properties": {
- "doxdocgen.generic.triggerSequence": {
+ "doxdocgen.c.triggerSequence": {
"description": "Doxygen comment trigger. This character sequence triggers generation of DoxyGen comments.",
"type": "string",
"default": "/**"
},
- "doxdocgen.generic.firstLine": {
+ "doxdocgen.c.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": {
+ "doxdocgen.c.commentPrefix": {
"description": "The prefix that is used for each comment line.",
"type": "string",
"default": " * "
},
- "doxdocgen.generic.lastLine": {
+ "doxdocgen.c.lastLine": {
"description": "The last line of the comment that gets generated. If empty it won't get generated at all.",
"type": "string",
"default": " */"
},
+ "doxdocgen.cpp.newLineAfterTParams": {
+ "description": "Whether to insert a newline after the template params.",
+ "type": "boolean",
+ "default": false
+ },
+ "doxdocgen.cpp.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.cpp.ctorText": {
+ "description": "Smart text snippet for constructors.",
+ "type": "string",
+ "default": "Construct a new {name} object"
+ },
+ "doxdocgen.cpp.dtorText": {
+ "description": "Smart text snippet for destructors.",
+ "type": "string",
+ "default": "Destroy the {name} object"
+ },
+ "doxdocgen.file.fileTemplate": {
+ "description": "The template for the file parameter in DoxyGen.",
+ "type": "string",
+ "default": "@file {name}"
+ },
+ "doxdocgen.file.fileOrder": {
+ "description": "The order to use for the date. Valid values are shown in default setting.",
+ "type": ["array", "string"],
+ "default": ["brief", "file", "author", "date"]
+ },
"doxdocgen.generic.newLineAfterBrief": {
"description": "Whether to insert a newline after a brief.",
"type": "boolean",
@@ -49,11 +96,6 @@
"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",
@@ -74,11 +116,6 @@
"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",
@@ -94,11 +131,6 @@
"type": "string",
"default": "@author your name"
},
- "doxdocgen.generic.fileTemplate": {
- "description": "The template for the file parameter in DoxyGen.",
- "type": "string",
- "default": "@file {name}"
- },
"doxdocgen.generic.dateTemplate": {
"description": "The template for the date parameter in DoxyGen.",
"type": "string",
@@ -109,21 +141,6 @@
"type": "string",
"default": "YYYY-MM-DD"
},
- "doxdocgen.generic.fileOrder": {
- "description": "The order to use for the date. Valid values are shown in default setting.",
- "type": ["array", "string"],
- "default": ["brief", "file", "author", "date"]
- },
- "doxdocgen.generic.ctorText": {
- "description": "Smart text snippet for constructors.",
- "type": "string",
- "default": "Construct a new {name} object"
- },
- "doxdocgen.generic.dtorText": {
- "description": "Smart text snippet for destructors.",
- "type": "string",
- "default": "Destroy the {name} object"
- },
"doxdocgen.generic.generateSmartText": {
"description": "Decide if you want to get smart text for certain commands.",
"type": "boolean",
@@ -146,7 +163,7 @@
"url": "https://github.com/christophschlosser/doxdocgen.git"
},
"bugs": {
- "url": "https://github.com/christophschlosser/doxdocgen/issues"
+ "url": "https://github.com/christophschlosser/doxdocgen/issues?q=is%3Aopen+is%3Aissue+label%3Abug+"
},
"scripts": {
"vscode:prepublish": "npm run compile",