-
Notifications
You must be signed in to change notification settings - Fork 58
/
package.json
303 lines (303 loc) · 11.2 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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
{
"name": "doxdocgen",
"displayName": "Doxygen Documentation Generator",
"description": "Let me generate Doxygen documentation from your source code for you.",
"version": "1.4.0",
"publisher": "cschlosser",
"engines": {
"vscode": "^1.55.0"
},
"categories": [
"Other"
],
"badges": [
{
"url": "https://img.shields.io/github/workflow/status/cschlosser/doxdocgen/CI/master",
"href": "https://github.com/cschlosser/doxdocgen/actions/workflows/ci.yml?query=branch%3Amaster+",
"description": "Continous integration"
},
{
"url": "https://img.shields.io/github/workflow/status/cschlosser/doxdocgen/CD?label=Release",
"href": "https://github.com/cschlosser/doxdocgen/actions/workflows/cd.yml?query=event%3Arelease++",
"description": "Release pipeline"
},
{
"url": "https://codecov.io/gh/cschlosser/doxdocgen/branch/master/graph/badge.svg",
"href": "https://codecov.io/gh/cschlosser/doxdocgen",
"description": "Code coverage"
}
],
"activationEvents": [
"onLanguage:cuda",
"onLanguage:cuda-cpp",
"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.copyrightTag": {
"markdownDescription": "File copyright documentation tag. Array of strings will be converted to one line per element. Can template `{year}`.",
"type": [
"array",
"string"
],
"default": [
"@copyright Copyright (c) {year}"
]
},
"doxdocgen.file.versionTag": {
"description": "Version number for the file.",
"type": "string",
"default": "@version 0.1"
},
"doxdocgen.file.customTag": {
"markdownDescription": "Additional file documentation. Array of strings will be converted to one line per element. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.",
"type": [
"array",
"string"
],
"default": []
},
"doxdocgen.file.fileOrder": {
"markdownDescription": "The order to use for the file comment. Values can be used multiple times. Valid values are `file`, `author`, `brief`, `version`, `date`, `empty`, `copyright` and `custom`.",
"type": [
"array",
"string"
],
"default": [
"file",
"author",
"brief",
"version",
"date",
"empty",
"copyright",
"empty",
"custom"
]
},
"doxdocgen.generic.includeTypeAtReturn": {
"description": "Whether include type information at return.",
"type": "boolean",
"default": true
},
"doxdocgen.generic.boolReturnsTrueFalse": {
"markdownDescription": "If this is enabled, the documentation for a `bool` return value will be split into `true` and `false` entries.",
"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.authorName": {
"markdownDescription": "Set the name of the author. Replaces `{author}`.",
"type": "string",
"default": "your name"
},
"doxdocgen.generic.authorEmail": {
"markdownDescription": "Set the e-mail address of the author. Replaces `{email}`.",
"type": "string",
"default": "[email protected]"
},
"doxdocgen.generic.authorTag": {
"markdownDescription": "Set the style of the author tag and your name. Can template `{author}` and `{email}`.",
"type": "string",
"default": "@author {author} ({email})"
},
"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": {
"markdownDescription": "Decide if the values put into `{name}` should be split according to their casing.",
"type": "boolean",
"default": true
},
"doxdocgen.generic.order": {
"markdownDescription": "The order to use for the comment generation. Values can be used multiple times. Valid values are `brief`, `empty`, `tparam`, `param`, `return`, `custom`, `author`, `date`, `version` and `copyright`.",
"type": [
"array",
"string"
],
"default": [
"brief",
"empty",
"tparam",
"param",
"return",
"custom"
]
},
"doxdocgen.generic.customTags": {
"markdownDescription": "Custom tags to be added to the generic order. One tag per line will be added. Can template `{year}`, `{date}`, `{author}`, `{email}` and `{file}`. You have to specify the prefix.",
"type": [
"array",
"string"
],
"default": []
},
"doxdocgen.generic.filteredKeywords": {
"description": "Array of keywords that should be removed from the input prior to parsing.",
"type": "array",
"default": []
},
"doxdocgen.generic.useGitUserName": {
"markdownDescription": "Substitute `{author}` with `git config --get user.name`.",
"type": "boolean",
"default": false
},
"doxdocgen.generic.useGitUserEmail": {
"markdownDescription": "Substitute `{email}` with `git config --get user.email`.",
"type": "boolean",
"default": false
},
"doxdocgen.generic.commandSuggestion": {
"description": "Provide intellisense and snippet for doxygen commands",
"type": "boolean",
"default": true
},
"doxdocgen.generic.commandSuggestionAddPrefix": {
"markdownDescription": "Add `\\` in doxygen command suggestion for better readability (need to enable commandSuggestion)",
"type": "boolean",
"default": false
}
}
}
},
"icon": "images/icon.png",
"keywords": [
"cpp",
"c++",
"c",
"Doxygen"
],
"license": "SEE LICENSE IN LICENSE",
"main": "./out/extension",
"repository": {
"type": "git",
"url": "https://github.com/cschlosser/doxdocgen.git"
},
"bugs": {
"url": "https://github.com/cschlosser/doxdocgen/labels/bug"
},
"scripts": {
"vscode:prepublish": "yarn compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./",
"test": "yarn compile && node ./out/test/runTests.js",
"cov": "yarn clean && nyc yarn test",
"lint": "tslint -c tslint.json 'src/**/*.ts'",
"clean": "rm -rf coverage .nyc_output out"
},
"dependencies": {
"env-var": "^4.1.0",
"moment": "^2.29.4",
"opn": "^5.2.0",
"simple-git": "^3.5.0"
},
"devDependencies": {
"@istanbuljs/nyc-config-typescript": "0.1.3",
"@types/mocha": "^5.2.7",
"@types/node": "12.7.1",
"@types/vscode": "^1.55.0",
"decache": "^4.5.1",
"glob": "^7.1.6",
"handlebars": "^4.7.3",
"minimist": ">=1.2.6",
"mocha": "^9.1.3",
"nyc": "12.0.1",
"remap-istanbul": "^0.13.0",
"source-map-support": "^0.5.19",
"ts-node": "^9.1.1",
"tslint": "^5.20.0",
"typescript": "^4.2.4",
"vscode-test": "^1.5.2",
"yargs-parser": ">=13.1.2"
}
}