Skip to content

Commit 9b0f16c

Browse files
Dominator008Dominator008
committed
Fix a few more lint warnings.
Fix goog.provide()'s that were not sorted alphabetically in closure/goog/proto2/test.pb.js. Add missing JSDoc to functions in closure/goog/soy/soy_testhelper.js.
1 parent 90f30a9 commit 9b0f16c

File tree

3 files changed

+114
-34
lines changed

3 files changed

+114
-34
lines changed

‎AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ John Huân Vũ <[email protected]>
2323
Peter Lu <[email protected]>
2424
Filipe Catraia <[email protected]>
2525
Dan Rubalsky <[email protected]>
26+
Michael Zhou <[email protected]>

‎closure/goog/proto2/test.pb.js

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
*/
2020

2121
goog.provide('proto2.TestAllTypes');
22+
goog.provide('proto2.TestAllTypes.NestedEnum');
2223
goog.provide('proto2.TestAllTypes.NestedMessage');
2324
goog.provide('proto2.TestAllTypes.OptionalGroup');
2425
goog.provide('proto2.TestAllTypes.RepeatedGroup');
25-
goog.provide('proto2.TestAllTypes.NestedEnum');
26-
goog.provide('proto2.TestDefaultParent');
2726
goog.provide('proto2.TestDefaultChild');
27+
goog.provide('proto2.TestDefaultParent');
2828
goog.setTestOnly('proto2.TestAllTypes');
2929

3030
goog.require('goog.proto2.Message');
@@ -3130,7 +3130,7 @@ proto2.TestAllTypes.prototype.clearPackedBool = function() {
31303130
*/
31313131
proto2.TestAllTypes.NestedEnum = {
31323132
FOO: 0,
3133-
OOF: 0,
3133+
OOF: 1,
31343134
BAR: 2,
31353135
BAZ: 3
31363136
};

‎closure/goog/soy/soy_testhelper.js

+110-31
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,16 @@ function SanitizedContentSubclass(content, kind) {
5151
goog.inherits(SanitizedContentSubclass, goog.soy.data.SanitizedContent);
5252

5353

54+
/**
55+
* @param {string} content The text.
56+
* @param {goog.soy.data.SanitizedContentKind|string} kind The kind of safe
57+
* content.
58+
* @return {!SanitizedContentSubclass}
59+
*/
5460
function makeSanitizedContent(content, kind) {
55-
return new SanitizedContentSubclass(content, kind);
61+
return new SanitizedContentSubclass(
62+
content,
63+
/** @type {goog.soy.data.SanitizedContentKind} */ (kind));
5664
}
5765

5866

@@ -64,44 +72,79 @@ function makeSanitizedContent(content, kind) {
6472
var example = {};
6573

6674

67-
example.textNodeTemplate = function(opt_data, opt_sb, opt_injectedData) {
68-
assertNotNull(opt_data);
69-
assertNotUndefined(opt_data);
70-
return goog.string.htmlEscape(opt_data.name);
75+
/**
76+
* @param {{name: string}} data
77+
* @param {null=} opt_sb
78+
* @param {Object<string, *>=} opt_injectedData
79+
* @return {string}
80+
*/
81+
example.textNodeTemplate = function(data, opt_sb, opt_injectedData) {
82+
assertNotNull(data);
83+
assertNotUndefined(data);
84+
return goog.string.htmlEscape(data.name);
7185
};
7286

7387

74-
example.singleRootTemplate = function(opt_data, opt_sb, opt_injectedData) {
75-
assertNotNull(opt_data);
76-
assertNotUndefined(opt_data);
77-
return '<span>' + goog.string.htmlEscape(opt_data.name) + '</span>';
88+
/**
89+
* @param {{name: string}} data
90+
* @param {null=} opt_sb
91+
* @param {Object<string, *>=} opt_injectedData
92+
* @return {string}
93+
*/
94+
example.singleRootTemplate = function(data, opt_sb, opt_injectedData) {
95+
assertNotNull(data);
96+
assertNotUndefined(data);
97+
return '<span>' + goog.string.htmlEscape(data.name) + '</span>';
7898
};
7999

80100

81-
example.multiRootTemplate = function(opt_data, opt_sb, opt_injectedData) {
82-
assertNotNull(opt_data);
83-
assertNotUndefined(opt_data);
84-
return '<div>Hello</div><div>' + goog.string.htmlEscape(opt_data.name) +
85-
'</div>';
101+
/**
102+
* @param {{name: string}} data
103+
* @param {null=} opt_sb
104+
* @param {Object<string, *>=} opt_injectedData
105+
* @return {string}
106+
*/
107+
example.multiRootTemplate = function(data, opt_sb, opt_injectedData) {
108+
assertNotNull(data);
109+
assertNotUndefined(data);
110+
return '<div>Hello</div><div>' + goog.string.htmlEscape(data.name) + '</div>';
86111
};
87112

88113

89-
example.injectedDataTemplate = function(opt_data, opt_sb, opt_injectedData) {
90-
assertNotNull(opt_data);
91-
assertNotUndefined(opt_data);
92-
return goog.string.htmlEscape(opt_data.name) +
93-
goog.string.htmlEscape(opt_injectedData.name);
114+
/**
115+
* @param {{name: string}} data
116+
* @param {null=} opt_sb
117+
* @param {Object<string, *>=} opt_injectedData
118+
* @return {string}
119+
*/
120+
example.injectedDataTemplate = function(data, opt_sb, opt_injectedData) {
121+
assertNotNull(data);
122+
assertNotUndefined(data);
123+
return goog.string.htmlEscape(data.name) +
124+
goog.string.htmlEscape(opt_injectedData.name);
94125
};
95126

96127

97-
example.noDataTemplate = function(opt_data, opt_sb, opt_injectedData) {
98-
assertNotNull(opt_data);
99-
assertNotUndefined(opt_data);
128+
/**
129+
* @param {{name: string}} data
130+
* @param {null=} opt_sb
131+
* @param {Object<string, *>=} opt_injectedData
132+
* @return {string}
133+
*/
134+
example.noDataTemplate = function(data, opt_sb, opt_injectedData) {
135+
assertNotNull(data);
136+
assertNotUndefined(data);
100137
return '<div>Hello</div>';
101138
};
102139

103140

104-
example.sanitizedHtmlTemplate = function(opt_data, opt_sb, opt_injectedData) {
141+
/**
142+
* @param {{name: string}} data
143+
* @param {null=} opt_sb
144+
* @param {Object<string, *>=} opt_injectedData
145+
* @return {!SanitizedContentSubclass}
146+
*/
147+
example.sanitizedHtmlTemplate = function(data, opt_sb, opt_injectedData) {
105148
// Test the SanitizedContent constructor.
106149
var sanitized = makeSanitizedContent(
107150
'Hello <b>World</b>', goog.soy.data.SanitizedContentKind.HTML);
@@ -110,27 +153,51 @@ example.sanitizedHtmlTemplate = function(opt_data, opt_sb, opt_injectedData) {
110153
};
111154

112155

113-
example.sanitizedHtmlAttributesTemplate = function(
114-
opt_data, opt_sb, opt_injectedData) {
156+
/**
157+
* @param {{name: string}} data
158+
* @param {null=} opt_sb
159+
* @param {Object<string, *>=} opt_injectedData
160+
* @return {!SanitizedContentSubclass}
161+
*/
162+
example.sanitizedHtmlAttributesTemplate = function(data, opt_sb,
163+
opt_injectedData) {
115164
return makeSanitizedContent(
116165
'foo="bar"', goog.soy.data.SanitizedContentKind.ATTRIBUTES);
117166
};
118167

119168

120-
example.sanitizedCssTemplate = function(opt_data, opt_sb, opt_injectedData) {
169+
/**
170+
* @param {{name: string}} data
171+
* @param {null=} opt_sb
172+
* @param {Object<string, *>=} opt_injectedData
173+
* @return {!SanitizedContentSubclass}
174+
*/
175+
example.sanitizedCssTemplate = function(data, opt_sb, opt_injectedData) {
121176
return makeSanitizedContent(
122177
'display:none', goog.soy.data.SanitizedContentKind.CSS);
123178
};
124179

125180

126-
example.unsanitizedTextTemplate = function(opt_data, opt_sb, opt_injectedData) {
181+
/**
182+
* @param {{name: string}} data
183+
* @param {null=} opt_sb
184+
* @param {Object<string, *>=} opt_injectedData
185+
* @return {!SanitizedContentSubclass}
186+
*/
187+
example.unsanitizedTextTemplate = function(data, opt_sb, opt_injectedData) {
127188
return makeSanitizedContent(
128189
'I <3 Puppies & Kittens', goog.soy.data.SanitizedContentKind.TEXT);
129190
};
130191

131192

132-
example.templateSpoofingSanitizedContentString = function(
133-
opt_data, opt_sb, opt_injectedData) {
193+
/**
194+
* @param {{name: string}} data
195+
* @param {null=} opt_sb
196+
* @param {Object<string, *>=} opt_injectedData
197+
* @return {!SanitizedContentSubclass}
198+
*/
199+
example.templateSpoofingSanitizedContentString = function(data, opt_sb,
200+
opt_injectedData) {
134201
return makeSanitizedContent(
135202
'Hello World',
136203
// This is to ensure we're using triple-equals against a unique Javascript
@@ -140,12 +207,24 @@ example.templateSpoofingSanitizedContentString = function(
140207
};
141208

142209

143-
example.tableRowTemplate = function(opt_data, opt_sb, opt_injectedData) {
210+
/**
211+
* @param {{name: string}} data
212+
* @param {null=} opt_sb
213+
* @param {Object<string, *>=} opt_injectedData
214+
* @return {string}
215+
*/
216+
example.tableRowTemplate = function(data, opt_sb, opt_injectedData) {
144217
return '<tr><td></td></tr>';
145218
};
146219

147220

148-
example.colGroupTemplateCaps = function(opt_data, opt_sb, opt_injectedData) {
221+
/**
222+
* @param {{name: string}} data
223+
* @param {null=} opt_sb
224+
* @param {Object<string, *>=} opt_injectedData
225+
* @return {string}
226+
*/
227+
example.colGroupTemplateCaps = function(data, opt_sb, opt_injectedData) {
149228
return '<COLGROUP></COLGROUP>';
150229
};
151230

0 commit comments

Comments
 (0)