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
|
{
"name": "doxdocgen",
"displayName": "Doxygen Documentation Generator",
"description": "Generate doxygen documentation from source code",
"version": "0.2.0",
"publisher": "cschlosser",
"engines": {
"vscode": "^1.16.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onLanguage:cpp",
"onLanguage:c"
],
"contributes": {
"configuration": {
"type": "object",
"title": "Doxygen Documentation Generator Settings",
"properties": {
"doxdocgen.generic.triggerSequence": {
"description": "Doxygen comment trigger. This character sequence triggers generation of DoxyGen comments.",
"type": "string",
"default": "/**"
},
"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.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 "
},
"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} "
},
"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 may improve the speed of comment generation 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.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",
"default": "@date {date}"
},
"doxdocgen.generic.dateFormat": {
"description": "The format to use for the date.",
"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"]
}
}
}
},
"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/issues"
},
"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"
},
"devDependencies": {
"@types/mocha": "^2.2.48",
"@types/node": "^7.0.43",
"decache": "^4.4.0",
"istanbul": "^0.4.5",
"mocha": "^5.0.1",
"moment": "^2.20.1",
"remap-istanbul": "^0.10.1",
"tslint": "^5.9.1",
"typescript": "^2.7.2",
"vscode": "^1.1.10"
}
}
|