summaryrefslogtreecommitdiffstats
path: root/package.json
blob: 67b83b8cf5474f2969b3139bdc8a98329738c98e (plain)
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
{
    "name": "doxdocgen",
    "displayName": "Doxygen Documentation Generator",
    "description": "Generate doxygen documentation from source code",
    "version": "0.0.7",
    "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.boolPointerReturnsNull": {
                    "description": "If this is enabled a pointer to a bool return value will include a null 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} "
                }
            }
        }
    },
    "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": {
        "typescript": "^2.5.3",
        "vscode": "^1.1.5",
        "@types/node": "^7.0.43",
        "@types/mocha": "^2.2.42",
        "tslint": "^5.7.0"
    }
}