File tree Expand file tree Collapse file tree 4 files changed +28
-2
lines changed Expand file tree Collapse file tree 4 files changed +28
-2
lines changed Original file line number Diff line number Diff line change @@ -12,11 +12,15 @@ export default iterateJsdoc(({
12
12
tag : targetTagName
13
13
} ) ;
14
14
15
+ if ( utils . hasTag ( 'private' ) ) {
16
+ return ;
17
+ }
18
+
15
19
if ( _ . isEmpty ( functionExamples ) ) {
16
- return report ( 'Missing JSDoc @' + targetTagName + ' declaration.' ) ;
20
+ report ( 'Missing JSDoc @' + targetTagName + ' declaration.' ) ;
17
21
}
18
22
19
- return _ . forEach ( functionExamples , ( example ) => {
23
+ _ . forEach ( functionExamples , ( example ) => {
20
24
const exampleContent = _ . compact ( ( example . name + ' ' + example . description ) . trim ( ) . split ( '\n' ) ) ;
21
25
22
26
if ( _ . isEmpty ( exampleContent ) ) {
Original file line number Diff line number Diff line change @@ -8,6 +8,10 @@ export default iterateJsdoc(({
8
8
const functionParameterNames = utils . getFunctionParameterNames ( ) ;
9
9
const jsdocParameterNames = utils . getJsdocParameterNames ( ) ;
10
10
11
+ if ( utils . hasTag ( 'private' ) ) {
12
+ return ;
13
+ }
14
+
11
15
// inheritdoc implies that all documentation is inherited; see http://usejsdoc.org/tags-inheritdoc.html
12
16
if ( utils . hasTag ( 'inheritdoc' ) ) {
13
17
return ;
Original file line number Diff line number Diff line change @@ -67,6 +67,15 @@ export default {
67
67
*/
68
68
function quux () {
69
69
70
+ }
71
+ `
72
+ } ,
73
+ {
74
+ code : `
75
+ /**
76
+ * @private
77
+ */
78
+ function quux () {
70
79
}
71
80
`
72
81
}
Original file line number Diff line number Diff line change @@ -133,6 +133,15 @@ export default {
133
133
allowOverrideWithoutParam : true
134
134
}
135
135
}
136
+ } ,
137
+ {
138
+ code : `
139
+ /**
140
+ * @private
141
+ */
142
+ function quux (foo) {
143
+ }
144
+ `
136
145
}
137
146
]
138
147
} ;
You can’t perform that action at this time.
0 commit comments