forked from cschlosser/doxdocgen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
200 lines (200 loc) · 7.47 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
{
"name": "doxdocgen",
"displayName": "Doxygen Documentation Generator",
"description": "Let me generate Doxygen documentation from your source code for you.",
"version": "0.3.3",
"publisher": "cschlosser",
"engines": {
"vscode": "^1.16.0"
},
"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"
],
"contributes": {
"configuration": {
"type": "object",
"title": "Doxygen Documentation Generator Settings",
"properties": {
"doxdocgen.c.triggerSequence": {
"description": "Doxygen comment trigger. This character sequence triggers generation of Doxygen comments.",
"type": "string",
"default": "/**"
},
"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.c.commentPrefix": {
"description": "The prefix that is used for each comment line except for first and last.",
"type": "string",
"default": " * "
},
"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.c.setterText": {
"description": "Smart text snippet for setters.",
"type": "string",
"default": "Set the {name} object"
},
"doxdocgen.c.getterText": {
"description": "Smart text snippet for getters.",
"type": "string",
"default": "Get the {name} object"
},
"doxdocgen.c.factoryMethodText": {
"description": "Smart text snippet for factory methods/functions.",
"type": "string",
"default": "Create a {name} object"
},
"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 file comment. Values can be used multiple times. Valid values are shown in default setting.",
"type": ["array", "string"],
"default": ["brief", "empty", "file", "author", "date"]
},
"doxdocgen.generic.includeTypeAtReturn": {
"description": "Whether include type information at return.",
"type": "boolean",
"default": true
},
"doxdocgen.generic.boolReturnsTrueFalse": {
"description": "If this is enabled a bool return value will be split into true and false return param.",
"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 {text}"
},
"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.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} "
},
"doxdocgen.generic.linesToGet": {
"description": "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.",
"type": "number",
"default": 20
},
"doxdocgen.generic.authorTag": {
"description": "Set the style of the author tag and your name.",
"type": "string",
"default": "@author your name"
},
"doxdocgen.generic.dateTemplate": {
"description": "The template for the date parameter in Doxygen.",
"type": "string",
"default": "@date {date}"
},
"doxdocgen.generic.dateFormat": {
"description": "The format to use for the date.",
"type": "string",
"default": "YYYY-MM-DD"
},
"doxdocgen.generic.generateSmartText": {
"description": "Decide if you want to get smart text for certain commands.",
"type": "boolean",
"default": true
},
"doxdocgen.generic.splitCasingSmartText": {
"description": "Decide if the values put into {name} should be split according to their casing.",
"type": "boolean",
"default": true
},
"doxdocgen.generic.order": {
"description": "The order to use for the comment generation. Values can be used multiple times. Valid values are shown in default setting.",
"type": ["array", "string"],
"default": ["brief", "empty", "tparam", "param", "return"]
}
}
}
},
"icon": "images/icon.png",
"keywords": [
"cpp",
"c++",
"c",
"Doxygen"
],
"license": "SEE LICENSE IN LICENSE",
"main": "./out/extension",
"repository": {
"type": "git",
"url": "https://github.com/christophschlosser/doxdocgen.git"
},
"bugs": {
"url": "https://github.com/christophschlosser/doxdocgen/labels/bug"
},
"scripts": {
"vscode:prepublish": "npm run compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./",
"postinstall": "node ./node_modules/vscode/bin/install",
"test": "npm run compile && node ./node_modules/vscode/bin/test"
},
"dependencies": {
"moment": "^2.20.1",
"opn": "^5.2.0"
},
"devDependencies": {
"@types/mocha": "^2.2.48",
"@types/node": "^7.0.43",
"decache": "^4.4.0",
"istanbul": "^0.4.5",
"mocha": "^5.0.1",
"remap-istanbul": "^0.10.1",
"tslint": "^5.9.1",
"typescript": "^2.7.2",
"vscode": "^1.1.10"
}
}