-
Notifications
You must be signed in to change notification settings - Fork 280
/
Base File.sublime-settings
139 lines (115 loc) · 5.53 KB
/
Base File.sublime-settings
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
{
// If true, when in a docblock, pressing tab after a @tag line (like @param, @return)
// will indent to the description. This is useful if you are writing a long description
// and want that block of text to stay aligned.
"jsdocs_deep_indent": true,
// If true, then pressing enter while in a double-slash comment (like this one)
// will automatically add two slashes to the next line as well
"jsdocs_extend_double_slash": true,
// the number of spaces to add after the leading *
"jsdocs_indentation_spaces": 1,
// The number of spaces to add after the leading * in lines under the first line of each
// paragraph. This is only used together with automatic line wrapping. For example, a value
// of 3 might look like this:
//
// /**
// * Duis sed arcu non tellus eleifend ullamcorper quis non erat. Curabitur
// * metus elit, ultrices et tristique a, blandit at justo.
// * @param {String} foo Lorem ipsum dolor sit amet.
// * @param {Number} bar Nullam fringilla feugiat pretium. Quisque
// * consectetur, risus eu pellentesque tincidunt, nulla ipsum imperdiet
// * massa, sit amet adipiscing dolor.
// * @return {[Type]}
// */
"jsdocs_indentation_spaces_same_para": 1,
// whether the words following the @tags should align.
// Possible values are 'no', 'shallow', 'deep'
// For backwards compatibility, false is equivalent to 'no', true is equivalent to 'shallow'
//
// 'shallow' will just align the first words after the tag. eg:
// @param {MyCustomClass} myVariable desc1
// @return {String} foo desc2
// @property {Number} blahblah desc3
//
// 'deep' will align each component of the tags, eg:
// @param {MyCustomClass} myVariable desc1
// @return {String} foo desc2
// @property {Number} blahblah desc3
"jsdocs_align_tags": "deep",
// Any additional boilerplate tags which should be added to each block. Should be an array of strings.
// Note that this only applies when a docblock is opened directly preceding a function.
// Tab points can be added by using snippet syntax, eg: ${1:default text}
"jsdocs_extra_tags": [],
// If extra tags are defined, by default they go between the description and the param/return tags. If this is set to
// true, the extra tags are placed at the very end.
"jsdocs_extra_tags_go_after": false,
// A map to determine the value of variables, should hungarian notation (or similar) be in use
"jsdocs_notation_map": [],
// Since there seems to be no agreed standard for "@return" or "@returns", use this setting to rename it as you wish.
"jsdocs_return_tag": "@return",
// Add a '[function_name description]' for the function block
"jsdocs_function_description": true,
// Add a '[description]' placeholder for the return tag?
"jsdocs_return_description": true,
// Add a '[description]' placeholder for the param tag?
"jsdocs_param_description": true,
// Add a name of parameter in param tag?
"jsdocs_param_name": true,
// Whether there should be blank lines added between the description line, and between tags of different types.
// Possible values are true, false, or "after_description".
// If true, the output might look like this:
//
// /**
// * [description]
// *
// * @param {String} foo
// * @param {Number} bar
// *
// * @return {[Type]}
// */
//
// If "after_description" is configured, a blank line is only added between the description and the first tag, but not
// between different tag sections, so the output, in that case, might look like this:
//
// /**
// * [description]
// *
// * @param {String} foo
// * @param {Number} bar
// * @return {[Type]}
// */
"jsdocs_spacer_between_sections": false,
// Whether each section should be indented to the same level, or indent each one individually.
// (When true, the @param section will lose the extra space immediately after each '@param').
"jsdocs_per_section_indent": false,
// Minimum spaces between cols (default is 1). For example, a value
// of 2 might look like this:
//
// /**
// * Duis sed arcu non tellus eleifend ullamcorper quis non erat. Curabitur
// *
// * @param {String} foo Lorem ipsum dolor sit amet.
// * @param {Number} bar Nullam fringilla feugiat pretium. Quisque
// *
// * @return {[Type]} description
// */
"jsdocs_min_spaces_between_columns": 1,
// indicates whether the @method tag should be added automatically
"jsdocs_autoadd_method_tag": false,
// If set to true, DocBlockr won't parse any code, providing no default templates. All other functions work as normal.
"jsdocs_simple_mode": false,
// If set to true, primitives such as "Number" and "String" will be documented as "number" and "string".
"jsdocs_lower_case_primitives": false,
// If set to true, primitives such as "boolean" and "integer" will be shortened to "bool" and "int".
"jsdocs_short_primitives": false,
// This property affects the default tag added to `var` declarations in Javascript/Coffeescript. If `false`, the
// default is used ("var"), otherwise it can be set to any String, eg: "property"
"jsdocs_override_js_var": false,
// If set to true, an extra line break is added after the end of a docblock to separate it from the code.
"jsdocs_newline_after_block": false,
// If set to true, Ctrl+Enter while in a single line comment will 'decorate' the comment.
"jsdocs_decorate": true,
// If set to true, typing /**<space> will open an inline docblock
"jsdocs_quick_open_inline": true,
"jsdocs_development_mode": false
}