File tree 3 files changed +32
-11
lines changed
3 files changed +32
-11
lines changed Original file line number Diff line number Diff line change 1
1
/**
2
- * This function returns the number one .
2
+ * This description is ignored because the method has a tagged description .
3
3
* @returns {number } numberone
4
+ * @description This function returns the number one.
4
5
* @see {@link http://github.com/|github }
5
6
* @see TestCase
6
7
* @see [markdown link](http://foo.com/)
Original file line number Diff line number Diff line change 62
62
"name" : " number"
63
63
}
64
64
},
65
+ {
66
+ "title" : " description" ,
67
+ "description" : " This function returns the number one." ,
68
+ "lineNumber" : 3
69
+ },
65
70
{
66
71
"title" : " see" ,
67
72
"description" : " {@link http://github.com/|github}" ,
68
- "lineNumber" : 3
73
+ "lineNumber" : 4
69
74
},
70
75
{
71
76
"title" : " see" ,
72
77
"description" : " TestCase" ,
73
- "lineNumber" : 4
78
+ "lineNumber" : 5
74
79
},
75
80
{
76
81
"title" : " see" ,
77
82
"description" : " [markdown link](http://foo.com/)" ,
78
- "lineNumber" : 5
83
+ "lineNumber" : 6
79
84
},
80
85
{
81
86
"title" : " version" ,
82
87
"description" : " 1.0.0" ,
83
- "lineNumber" : 6
88
+ "lineNumber" : 7
84
89
},
85
90
{
86
91
"title" : " since" ,
87
92
"description" : " 2.0.0" ,
88
- "lineNumber" : 7
93
+ "lineNumber" : 8
89
94
},
90
95
{
91
96
"title" : " copyright" ,
92
97
"description" : " Tom MacWright" ,
93
- "lineNumber" : 8
98
+ "lineNumber" : 9
94
99
},
95
100
{
96
101
"title" : " license" ,
97
102
"description" : " BSD" ,
98
- "lineNumber" : 9
103
+ "lineNumber" : 10
99
104
}
100
105
],
101
106
"loc" : {
104
109
"column" : 0
105
110
},
106
111
"end" : {
107
- "line" : 11 ,
112
+ "line" : 12 ,
108
113
"column" : 3
109
114
}
110
115
},
111
116
"context" : {
112
117
"loc" : {
113
118
"start" : {
114
- "line" : 12 ,
119
+ "line" : 13 ,
115
120
"column" : 0
116
121
},
117
122
"end" : {
118
- "line" : 15 ,
123
+ "line" : 16 ,
119
124
"column" : 2
120
125
}
121
126
}
Original file line number Diff line number Diff line change @@ -107,6 +107,21 @@ test('parse - @augments', function(t) {
107
107
t . end ( ) ;
108
108
} ) ;
109
109
110
+ test ( 'parse - @description' , function ( t ) {
111
+ t . deepEqual (
112
+ evaluate ( function ( ) {
113
+ /**
114
+ * This is a free-form description
115
+ * @description This tagged description wins, and [is markdown](http://markdown.com).
116
+ */
117
+ } ) [ 0 ] . description ,
118
+ remark ( ) . parse ( 'This tagged description wins, and [is markdown](http://markdown.com).' ) ,
119
+ 'description'
120
+ ) ;
121
+
122
+ t . end ( ) ;
123
+ } ) ;
124
+
110
125
/*
111
126
* Dossier-style augments tag
112
127
* https://github.com/google/closure-library/issues/746
You can’t perform that action at this time.
0 commit comments