xref: /llvm-project/clang/test/Index/annotate-comments.cpp (revision 4586df765e927de6eb2d21ee849f7b847b3e91ec)
1 // Run lines are sensitive to line numbers and come below the code.
2 
3 #ifndef HEADER
4 #define HEADER
5 
6 // Not a Doxygen comment.  NOT_DOXYGEN
7 void notdoxy1(void);
8 
9 /* Not a Doxygen comment.  NOT_DOXYGEN */
10 void notdoxy2(void);
11 
12 /*/ Not a Doxygen comment.  NOT_DOXYGEN */
13 void notdoxy3(void);
14 
15 /** Doxygen comment.  isdoxy4 IS_DOXYGEN_SINGLE */
16 void isdoxy4(void);
17 
18 /**
19  * Doxygen comment.  isdoxy5 IS_DOXYGEN_SINGLE */
20 void isdoxy5(void);
21 
22 /**
23  * Doxygen comment.
24  * isdoxy6 IS_DOXYGEN_SINGLE */
25 void isdoxy6(void);
26 
27 /**
28  * Doxygen comment.
29  * isdoxy7 IS_DOXYGEN_SINGLE
30  */
31 void isdoxy7(void);
32 
33 /*! Doxygen comment.  isdoxy8 IS_DOXYGEN_SINGLE */
34 void isdoxy8(void);
35 
36 /// Doxygen comment.  isdoxy9 IS_DOXYGEN_SINGLE
37 void isdoxy9(void);
38 
39 // Not a Doxygen comment.  NOT_DOXYGEN
40 /// Doxygen comment.  isdoxy10 IS_DOXYGEN_SINGLE
41 void isdoxy10(void);
42 
43 /// Doxygen comment.  isdoxy11 IS_DOXYGEN_SINGLE
44 // Not a Doxygen comment.  NOT_DOXYGEN
45 void isdoxy11(void);
46 
47 /** Doxygen comment.  isdoxy12  IS_DOXYGEN_SINGLE */
48 /* Not a Doxygen comment.  NOT_DOXYGEN */
49 void isdoxy12(void);
50 
51 /// Doxygen comment.  isdoxy13 IS_DOXYGEN_START
52 /// Doxygen comment.  IS_DOXYGEN_END
53 void isdoxy13(void);
54 
55 /// Doxygen comment.  isdoxy14 IS_DOXYGEN_START
56 /// Blah-blah-blah.
57 /// Doxygen comment.  IS_DOXYGEN_END
58 void isdoxy14(void);
59 
60 /// Doxygen comment.  isdoxy15 IS_DOXYGEN_START
61 /** Blah-blah-blah */
62 /// Doxygen comment.  IS_DOXYGEN_END
63 void isdoxy15(void);
64 
65 /** Blah-blah-blah. isdoxy16 IS_DOXYGEN_START *//** Blah */
66 /// Doxygen comment.  IS_DOXYGEN_END
67 void isdoxy16(void);
68 
69 /// isdoxy17 IS_DOXYGEN_START
70 // Not a Doxygen comment, but still picked up.
71 /// IS_DOXYGEN_END
72 void isdoxy17(void);
73 
74 unsigned
75 // NOT_DOXYGEN
76 /// isdoxy18 IS_DOXYGEN_START
77 // Not a Doxygen comment, but still picked up.
78 /// IS_DOXYGEN_END
79 // NOT_DOXYGEN
80 int isdoxy18(void);
81 
82 //! It all starts here. isdoxy19 IS_DOXYGEN_START
83 /*! It's a little odd to continue line this,
84  *
85  * but we need more multi-line comments. */
86 /// This comment comes before my other comments
87 /** This is a block comment that is associated with the function f. It
88  *  runs for three lines.  IS_DOXYGEN_END
89  */
90 void isdoxy19(int, int);
91 
92 // NOT IN THE COMMENT  NOT_DOXYGEN
93 /// This is a BCPL comment.  isdoxy20 IS_DOXYGEN_START
94 /// It has only two lines.
95 /** But there are other blocks that are part of the comment, too.  IS_DOXYGEN_END */
96 void isdoxy20(int);
97 
98 void notdoxy21(int); ///< This is a member comment.  isdoxy21 IS_DOXYGEN_NOT_ATTACHED
99 
100 void notdoxy22(int); /*!< This is a member comment.  isdoxy22 IS_DOXYGEN_NOT_ATTACHED */
101 
102 void notdoxy23(int); /**< This is a member comment.  isdoxy23 IS_DOXYGEN_NOT_ATTACHED */
103 
104 void notdoxy24(int); // NOT_DOXYGEN
105 
106 /// IS_DOXYGEN_SINGLE
107 struct isdoxy25 {
108 };
109 
110 struct test26 {
111   /// IS_DOXYGEN_SINGLE
112   int isdoxy26;
113 };
114 
115 struct test27 {
116   int isdoxy27; ///< IS_DOXYGEN_SINGLE
117 };
118 
119 struct notdoxy28 {
120 }; ///< IS_DOXYGEN_NOT_ATTACHED
121 
122 /// IS_DOXYGEN_SINGLE
123 enum isdoxy29 {
124 };
125 
126 enum notdoxy30 {
127 }; ///< IS_DOXYGEN_NOT_ATTACHED
128 
129 /// IS_DOXYGEN_SINGLE
130 namespace isdoxy31 {
131 };
132 
133 namespace notdoxy32 {
134 }; ///< IS_DOXYGEN_NOT_ATTACHED
135 
136 class test33 {
137                 ///< IS_DOXYGEN_NOT_ATTACHED
138   int isdoxy33; ///< isdoxy33 IS_DOXYGEN_SINGLE
139   int isdoxy34; ///< isdoxy34 IS_DOXYGEN_SINGLE
140 
141                 ///< IS_DOXYGEN_NOT_ATTACHED
142   int isdoxy35, ///< isdoxy35 IS_DOXYGEN_SINGLE
143       isdoxy36; ///< isdoxy36 IS_DOXYGEN_SINGLE
144 
145                 ///< IS_DOXYGEN_NOT_ATTACHED
146   int isdoxy37  ///< isdoxy37 IS_DOXYGEN_SINGLE
147     , isdoxy38  ///< isdoxy38 IS_DOXYGEN_SINGLE
148     , isdoxy39; ///< isdoxy39 IS_DOXYGEN_SINGLE
149 };
150 
151 // Verified that Doxygen attaches these.
152 
153 /// isdoxy40 IS_DOXYGEN_SINGLE
154 // NOT_DOXYGEN
155 void isdoxy40(int);
156 
157 unsigned
158 /// isdoxy41 IS_DOXYGEN_SINGLE
159 // NOT_DOXYGEN
160 int isdoxy41(int);
161 
162 class test42 {
163   int isdoxy42; /* NOT_DOXYGEN */ ///< isdoxy42 IS_DOXYGEN_SINGLE
164 };
165 
166 /// IS_DOXYGEN_START
167 /// It is fine to have a command at the end of comment.
168 ///\brief
169 ///
170 /// Some malformed command.
171 /* \*/
172 /**
173  * \brief Aaa aaaaaaa aaaa.
174  * IS_DOXYGEN_END
175  */
176 void isdoxy43(void);
177 
178 /// IS_DOXYGEN_START Aaa bbb
179 /// ccc.
180 ///
181 /// Ddd eee.
182 /// Fff.
183 ///
184 /// Ggg. IS_DOXYGEN_END
185 void isdoxy44(void);
186 
187 /// IS_DOXYGEN_START Aaa bbb
188 /// ccc.
189 ///
190 /// \brief
191 /// Ddd eee.
192 /// Fff.
193 ///
194 /// Ggg. IS_DOXYGEN_END
195 void isdoxy45(void);
196 
197 /// IS_DOXYGEN_START Aaa bbb
198 /// ccc.
199 ///
200 /// \short
201 /// Ddd eee.
202 /// Fff.
203 ///
204 /// Ggg. IS_DOXYGEN_END
205 void isdoxy46(void);
206 
207 /// IS_DOXYGEN_NOT_ATTACHED
208 #define FOO
209 void notdoxy47(void);
210 
211 /// IS_DOXYGEN_START Aaa bbb
212 /// \param ccc
213 /// \returns ddd IS_DOXYGEN_END
214 void isdoxy48(int);
215 
216 /// \brief IS_DOXYGEN_START Aaa
217 /// \returns bbb IS_DOXYGEN_END
218 void isdoxy49(void);
219 
220 /// \param ccc IS_DOXYGEN_START
221 /// \returns ddd IS_DOXYGEN_END
222 void isdoxy50(int);
223 
224 /// Aaa.
225 void comment_to_html_conversion_1();
226 
227 /// \brief Aaa.
228 void comment_to_html_conversion_2();
229 
230 /// \short Aaa.
231 void comment_to_html_conversion_3();
232 
233 /// Aaa.
234 ///
235 /// \brief Bbb.
236 void comment_to_html_conversion_4();
237 
238 /// Aaa.
239 ///
240 /// \brief Bbb.
241 ///
242 /// Ccc.
243 void comment_to_html_conversion_5();
244 
245 /// \brief Aaa.
246 /// \brief Bbb.
247 void comment_to_html_conversion_6();
248 
249 /// Aaa.
250 ///
251 /// \return Bbb.
252 void comment_to_html_conversion_7();
253 
254 /// Aaa.
255 ///
256 /// \returns Bbb.
257 void comment_to_html_conversion_8();
258 
259 /// Aaa.
260 ///
261 /// \result Bbb.
262 void comment_to_html_conversion_9();
263 
264 /// \returns Aaa.
265 /// \returns Bbb.
266 void comment_to_html_conversion_10();
267 
268 /// Aaa.
269 ///
270 /// Bbb.
271 ///
272 /// \returns Ccc.
273 void comment_to_html_conversion_11();
274 
275 /// \param
276 void comment_to_html_conversion_12(int x1);
277 
278 /// \param x1 Aaa.
279 void comment_to_html_conversion_13(int x1);
280 
281 /// \param zzz Aaa.
282 void comment_to_html_conversion_14(int x1);
283 
284 /// \param x2 Bbb.
285 /// \param x1 Aaa.
286 void comment_to_html_conversion_15(int x1, int x2);
287 
288 /// \param x2 Bbb.
289 /// \param zzz Aaa.
290 /// \param x1 Aaa.
291 void comment_to_html_conversion_16(int x1, int x2);
292 
293 /// \brief Aaa.
294 ///
295 /// Bbb.
296 ///
297 /// \param x2 Ddd.
298 /// \param x1 Ccc.
299 /// \returns Eee.
300 void comment_to_html_conversion_17(int x1, int x2);
301 
302 /// <br><a href="http://example.com/">Aaa</a>
303 void comment_to_html_conversion_18();
304 
305 /// \verbatim
306 /// <a href="http://example.com/">Aaa</a>
307 /// <a href='http://example.com/'>Aaa</a>
308 /// \endverbatim
309 void comment_to_html_conversion_19();
310 
311 /// \b Aaa
312 void comment_to_html_conversion_20();
313 
314 /// \c Aaa \p Bbb
315 void comment_to_html_conversion_21();
316 
317 /// \a Aaa \e Bbb \em Ccc
318 void comment_to_html_conversion_22();
319 
320 /// \\ \@ \& \$ \# \< \> \% \" \. \::
321 void comment_to_html_conversion_23();
322 
323 /// &amp; &lt; &gt; &quot;
324 void comment_to_html_conversion_24();
325 
326 /// <em>0&lt;i</em>
327 void comment_to_html_conversion_25();
328 
329 #endif
330 
331 // RUN: rm -rf %t
332 // RUN: mkdir %t
333 // RUN: %clang_cc1 -x c++ -emit-pch -o %t/out.pch %s
334 // RUN: %clang_cc1 -x c++ -include-pch %t/out.pch -fsyntax-only %s
335 
336 // RUN: c-index-test -test-load-source all %s > %t/out.c-index-direct
337 // RUN: c-index-test -test-load-tu %t/out.pch all > %t/out.c-index-pch
338 
339 // RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-direct
340 // RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-pch
341 
342 // Declarations without Doxygen comments should not pick up some Doxygen comments.
343 // WRONG-NOT: notdoxy{{.*}}Comment=
344 // WRONG-NOT: test{{.*}}Comment=
345 
346 // Non-Doxygen comments should not be attached to anything.
347 // WRONG-NOT: NOT_DOXYGEN
348 
349 // Some Doxygen comments are not attached to anything.
350 // WRONG-NOT: IS_DOXYGEN_NOT_ATTACHED
351 
352 // Ensure we don't pick up extra comments.
353 // WRONG-NOT: IS_DOXYGEN_START{{.*}}IS_DOXYGEN_START{{.*}}BriefComment=
354 // WRONG-NOT: IS_DOXYGEN_END{{.*}}IS_DOXYGEN_END{{.*}}BriefComment=
355 
356 // RUN: FileCheck %s < %t/out.c-index-direct
357 // RUN: FileCheck %s < %t/out.c-index-pch
358 
359 // CHECK: annotate-comments.cpp:16:6: FunctionDecl=isdoxy4:{{.*}} isdoxy4 IS_DOXYGEN_SINGLE
360 // CHECK: annotate-comments.cpp:20:6: FunctionDecl=isdoxy5:{{.*}} isdoxy5 IS_DOXYGEN_SINGLE
361 // CHECK: annotate-comments.cpp:25:6: FunctionDecl=isdoxy6:{{.*}} isdoxy6 IS_DOXYGEN_SINGLE
362 // CHECK: annotate-comments.cpp:31:6: FunctionDecl=isdoxy7:{{.*}} isdoxy7 IS_DOXYGEN_SINGLE
363 // CHECK: annotate-comments.cpp:34:6: FunctionDecl=isdoxy8:{{.*}} isdoxy8 IS_DOXYGEN_SINGLE
364 // CHECK: annotate-comments.cpp:37:6: FunctionDecl=isdoxy9:{{.*}} isdoxy9 IS_DOXYGEN_SINGLE
365 // CHECK: annotate-comments.cpp:41:6: FunctionDecl=isdoxy10:{{.*}} isdoxy10 IS_DOXYGEN_SINGLE
366 // CHECK: annotate-comments.cpp:53:6: FunctionDecl=isdoxy13:{{.*}} isdoxy13 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
367 // CHECK: annotate-comments.cpp:58:6: FunctionDecl=isdoxy14:{{.*}} isdoxy14 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
368 // CHECK: annotate-comments.cpp:63:6: FunctionDecl=isdoxy15:{{.*}} isdoxy15 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
369 // CHECK: annotate-comments.cpp:67:6: FunctionDecl=isdoxy16:{{.*}} isdoxy16 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
370 // CHECK: annotate-comments.cpp:72:6: FunctionDecl=isdoxy17:{{.*}} isdoxy17 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
371 // CHECK: annotate-comments.cpp:80:5: FunctionDecl=isdoxy18:{{.*}} isdoxy18 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
372 // CHECK: annotate-comments.cpp:90:6: FunctionDecl=isdoxy19:{{.*}} isdoxy19 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
373 // CHECK: annotate-comments.cpp:96:6: FunctionDecl=isdoxy20:{{.*}} isdoxy20 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
374 // CHECK: annotate-comments.cpp:107:8: StructDecl=isdoxy25:{{.*}} IS_DOXYGEN_SINGLE
375 // CHECK: annotate-comments.cpp:112:7: FieldDecl=isdoxy26:{{.*}} IS_DOXYGEN_SINGLE
376 // CHECK: annotate-comments.cpp:116:7: FieldDecl=isdoxy27:{{.*}} IS_DOXYGEN_SINGLE
377 // CHECK: annotate-comments.cpp:123:6: EnumDecl=isdoxy29:{{.*}} IS_DOXYGEN_SINGLE
378 // CHECK: annotate-comments.cpp:130:11: Namespace=isdoxy31:{{.*}} IS_DOXYGEN_SINGLE
379 // CHECK: annotate-comments.cpp:138:7: FieldDecl=isdoxy33:{{.*}} isdoxy33 IS_DOXYGEN_SINGLE
380 // CHECK: annotate-comments.cpp:139:7: FieldDecl=isdoxy34:{{.*}} isdoxy34 IS_DOXYGEN_SINGLE
381 // CHECK: annotate-comments.cpp:142:7: FieldDecl=isdoxy35:{{.*}} isdoxy35 IS_DOXYGEN_SINGLE
382 // CHECK: annotate-comments.cpp:143:7: FieldDecl=isdoxy36:{{.*}} isdoxy36 IS_DOXYGEN_SINGLE
383 // CHECK: annotate-comments.cpp:146:7: FieldDecl=isdoxy37:{{.*}} isdoxy37 IS_DOXYGEN_SINGLE
384 // CHECK: annotate-comments.cpp:147:7: FieldDecl=isdoxy38:{{.*}} isdoxy38 IS_DOXYGEN_SINGLE
385 // CHECK: annotate-comments.cpp:148:7: FieldDecl=isdoxy39:{{.*}} isdoxy39 IS_DOXYGEN_SINGLE
386 // CHECK: annotate-comments.cpp:155:6: FunctionDecl=isdoxy40:{{.*}} isdoxy40 IS_DOXYGEN_SINGLE
387 // CHECK: annotate-comments.cpp:160:5: FunctionDecl=isdoxy41:{{.*}} isdoxy41 IS_DOXYGEN_SINGLE
388 // CHECK: annotate-comments.cpp:163:7: FieldDecl=isdoxy42:{{.*}} isdoxy42 IS_DOXYGEN_SINGLE
389 // CHECK: annotate-comments.cpp:176:6: FunctionDecl=isdoxy43:{{.*}} IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END
390 
391 // CHECK: annotate-comments.cpp:185:6: FunctionDecl=isdoxy44:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb ccc.]
392 // CHECK: annotate-comments.cpp:195:6: FunctionDecl=isdoxy45:{{.*}} BriefComment=[Ddd eee. Fff.]
393 // CHECK: annotate-comments.cpp:205:6: FunctionDecl=isdoxy46:{{.*}} BriefComment=[Ddd eee. Fff.]
394 // CHECK: annotate-comments.cpp:214:6: FunctionDecl=isdoxy48:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb]
395 // CHECK: annotate-comments.cpp:218:6: FunctionDecl=isdoxy49:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa]
396 // CHECK: annotate-comments.cpp:222:6: FunctionDecl=isdoxy50:{{.*}} BriefComment=[Returns ddd IS_DOXYGEN_END]
397 
398 // CHECK: annotate-comments.cpp:225:6: FunctionDecl=comment_to_html_conversion_1:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p>]
399 // CHECK-NEXT:  CommentAST=[
400 // CHECK-NEXT:    (CXComment_FullComment
401 // CHECK-NEXT:       (CXComment_Paragraph
402 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.])))]
403 // CHECK: annotate-comments.cpp:228:6: FunctionDecl=comment_to_html_conversion_2:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p>]
404 // CHECK-NEXT:  CommentAST=[
405 // CHECK-NEXT:    (CXComment_FullComment
406 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
407 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
408 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[brief]
409 // CHECK-NEXT:         (CXComment_Paragraph
410 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.]))))]
411 // CHECK: annotate-comments.cpp:231:6: FunctionDecl=comment_to_html_conversion_3:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p>]
412 // CHECK-NEXT:  CommentAST=[
413 // CHECK-NEXT:    (CXComment_FullComment
414 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
415 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
416 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[short]
417 // CHECK-NEXT:         (CXComment_Paragraph
418 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.]))))]
419 // CHECK: annotate-comments.cpp:236:6: FunctionDecl=comment_to_html_conversion_4:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Bbb.</p><p> Aaa.</p>]
420 // CHECK-NEXT:  CommentAST=[
421 // CHECK-NEXT:    (CXComment_FullComment
422 // CHECK-NEXT:       (CXComment_Paragraph
423 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.]))
424 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
425 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
426 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[brief]
427 // CHECK-NEXT:         (CXComment_Paragraph
428 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.]))))]
429 // CHECK: annotate-comments.cpp:243:6: FunctionDecl=comment_to_html_conversion_5:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Bbb.</p><p> Aaa.</p><p> Ccc.</p>]
430 // CHECK-NEXT:  CommentAST=[
431 // CHECK-NEXT:    (CXComment_FullComment
432 // CHECK-NEXT:       (CXComment_Paragraph
433 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.]))
434 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
435 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
436 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[brief]
437 // CHECK-NEXT:         (CXComment_Paragraph
438 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.])))
439 // CHECK-NEXT:       (CXComment_Paragraph
440 // CHECK-NEXT:         (CXComment_Text Text=[ Ccc.])))]
441 // CHECK: annotate-comments.cpp:247:6: FunctionDecl=comment_to_html_conversion_6:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa. </p><p class="para-brief"> Bbb.</p>]
442 // CHECK-NEXT:  CommentAST=[
443 // CHECK-NEXT:    (CXComment_FullComment
444 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
445 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
446 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[brief]
447 // CHECK-NEXT:         (CXComment_Paragraph
448 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.] HasTrailingNewline)
449 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
450 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[brief]
451 // CHECK-NEXT:         (CXComment_Paragraph
452 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.]))))]
453 // CHECK: annotate-comments.cpp:252:6: FunctionDecl=comment_to_html_conversion_7:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p><p class="para-returns"><span class="word-returns">Returns</span>  Bbb.</p>]
454 // CHECK-NEXT:  CommentAST=[
455 // CHECK-NEXT:    (CXComment_FullComment
456 // CHECK-NEXT:       (CXComment_Paragraph
457 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.]))
458 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
459 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
460 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[return]
461 // CHECK-NEXT:         (CXComment_Paragraph
462 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.]))))]
463 // CHECK: annotate-comments.cpp:257:6: FunctionDecl=comment_to_html_conversion_8:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p><p class="para-returns"><span class="word-returns">Returns</span>  Bbb.</p>]
464 // CHECK-NEXT:  CommentAST=[
465 // CHECK-NEXT:    (CXComment_FullComment
466 // CHECK-NEXT:       (CXComment_Paragraph
467 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.]))
468 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
469 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
470 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[returns]
471 // CHECK-NEXT:         (CXComment_Paragraph
472 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.]))))]
473 // CHECK: annotate-comments.cpp:262:6: FunctionDecl=comment_to_html_conversion_9:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p><p class="para-returns"><span class="word-returns">Returns</span>  Bbb.</p>]
474 // CHECK-NEXT:  CommentAST=[
475 // CHECK-NEXT:    (CXComment_FullComment
476 // CHECK-NEXT:       (CXComment_Paragraph
477 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.]))
478 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
479 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
480 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[result]
481 // CHECK-NEXT:         (CXComment_Paragraph
482 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.]))))]
483 // CHECK: annotate-comments.cpp:266:6: FunctionDecl=comment_to_html_conversion_10:{{.*}} FullCommentAsHTML=[<p class="para-returns"><span class="word-returns">Returns</span>  Bbb.</p><p class="para-returns"><span class="word-returns">Returns</span>  Aaa. </p>]
484 // CHECK-NEXT:  CommentAST=[
485 // CHECK-NEXT:    (CXComment_FullComment
486 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
487 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
488 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[returns]
489 // CHECK-NEXT:         (CXComment_Paragraph
490 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.] HasTrailingNewline)
491 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
492 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[returns]
493 // CHECK-NEXT:         (CXComment_Paragraph
494 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.]))))]
495 // CHECK: annotate-comments.cpp:273:6: FunctionDecl=comment_to_html_conversion_11:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p><p> Bbb.</p><p class="para-returns"><span class="word-returns">Returns</span>  Ccc.</p>]
496 // CHECK-NEXT:  CommentAST=[
497 // CHECK-NEXT:    (CXComment_FullComment
498 // CHECK-NEXT:       (CXComment_Paragraph
499 // CHECK-NEXT:         (CXComment_Text Text=[ Aaa.]))
500 // CHECK-NEXT:       (CXComment_Paragraph
501 // CHECK-NEXT:         (CXComment_Text Text=[ Bbb.]))
502 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
503 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
504 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[returns]
505 // CHECK-NEXT:         (CXComment_Paragraph
506 // CHECK-NEXT:           (CXComment_Text Text=[ Ccc.]))))]
507 // CHECK: annotate-comments.cpp:276:6: FunctionDecl=comment_to_html_conversion_12:{{.*}} FullCommentAsHTML=[]
508 // CHECK-NEXT:  CommentAST=[
509 // CHECK-NEXT:    (CXComment_FullComment
510 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
511 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
512 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[] ParamIndex=Invalid
513 // CHECK-NEXT:         (CXComment_Paragraph IsWhitespace)))]
514 // CHECK: annotate-comments.cpp:279:6: FunctionDecl=comment_to_html_conversion_13:{{.*}} FullCommentAsHTML=[<dl><dt class="param-name-index-0">x1</dt><dd class="param-descr-index-0"> Aaa.</dd></dl>]
515 // CHECK-NEXT:  CommentAST=[
516 // CHECK-NEXT:    (CXComment_FullComment
517 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
518 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
519 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x1] ParamIndex=0
520 // CHECK-NEXT:         (CXComment_Paragraph
521 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.]))))]
522 // CHECK: annotate-comments.cpp:282:6: FunctionDecl=comment_to_html_conversion_14:{{.*}} FullCommentAsHTML=[<dl><dt class="param-name-index-invalid">zzz</dt><dd class="param-descr-index-invalid"> Aaa.</dd></dl>]
523 // CHECK-NEXT:  CommentAST=[
524 // CHECK-NEXT:    (CXComment_FullComment
525 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
526 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
527 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[zzz] ParamIndex=Invalid
528 // CHECK-NEXT:         (CXComment_Paragraph
529 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.]))))]
530 // CHECK: annotate-comments.cpp:286:6: FunctionDecl=comment_to_html_conversion_15:{{.*}} FullCommentAsHTML=[<dl><dt class="param-name-index-0">x1</dt><dd class="param-descr-index-0"> Aaa.</dd><dt class="param-name-index-1">x2</dt><dd class="param-descr-index-1"> Bbb. </dd></dl>]
531 // CHECK-NEXT:  CommentAST=[
532 // CHECK-NEXT:    (CXComment_FullComment
533 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
534 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
535 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x2] ParamIndex=1
536 // CHECK-NEXT:         (CXComment_Paragraph
537 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.] HasTrailingNewline)
538 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
539 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x1] ParamIndex=0
540 // CHECK-NEXT:         (CXComment_Paragraph
541 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.]))))]
542 // CHECK: annotate-comments.cpp:291:6: FunctionDecl=comment_to_html_conversion_16:{{.*}} FullCommentAsHTML=[<dl><dt class="param-name-index-0">x1</dt><dd class="param-descr-index-0"> Aaa.</dd><dt class="param-name-index-1">x2</dt><dd class="param-descr-index-1"> Bbb. </dd><dt class="param-name-index-invalid">zzz</dt><dd class="param-descr-index-invalid"> Aaa. </dd></dl>]
543 // CHECK-NEXT:  CommentAST=[
544 // CHECK-NEXT:    (CXComment_FullComment
545 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
546 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
547 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x2] ParamIndex=1
548 // CHECK-NEXT:         (CXComment_Paragraph
549 // CHECK-NEXT:           (CXComment_Text Text=[ Bbb.] HasTrailingNewline)
550 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
551 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[zzz] ParamIndex=Invalid
552 // CHECK-NEXT:         (CXComment_Paragraph
553 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.] HasTrailingNewline)
554 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
555 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x1] ParamIndex=0
556 // CHECK-NEXT:         (CXComment_Paragraph
557 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.]))))]
558 // CHECK: annotate-comments.cpp:300:6: FunctionDecl=comment_to_html_conversion_17:{{.*}} FullCommentAsHTML=[<p class="para-brief"> Aaa.</p><p> Bbb.</p><dl><dt class="param-name-index-0">x1</dt><dd class="param-descr-index-0"> Ccc. </dd><dt class="param-name-index-1">x2</dt><dd class="param-descr-index-1"> Ddd. </dd></dl><p class="para-returns"><span class="word-returns">Returns</span>  Eee.</p>]
559 // CHECK-NEXT:  CommentAST=[
560 // CHECK-NEXT:    (CXComment_FullComment
561 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
562 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
563 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[brief]
564 // CHECK-NEXT:         (CXComment_Paragraph
565 // CHECK-NEXT:           (CXComment_Text Text=[ Aaa.])))
566 // CHECK-NEXT:       (CXComment_Paragraph
567 // CHECK-NEXT:         (CXComment_Text Text=[ Bbb.]))
568 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
569 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
570 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x2] ParamIndex=1
571 // CHECK-NEXT:         (CXComment_Paragraph
572 // CHECK-NEXT:           (CXComment_Text Text=[ Ddd.] HasTrailingNewline)
573 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
574 // CHECK-NEXT:       (CXComment_ParamCommand in implicitly ParamName=[x1] ParamIndex=0
575 // CHECK-NEXT:         (CXComment_Paragraph
576 // CHECK-NEXT:           (CXComment_Text Text=[ Ccc.] HasTrailingNewline)
577 // CHECK-NEXT:           (CXComment_Text Text=[ ] IsWhitespace)))
578 // CHECK-NEXT:       (CXComment_BlockCommand CommandName=[returns]
579 // CHECK-NEXT:         (CXComment_Paragraph
580 // CHECK-NEXT:           (CXComment_Text Text=[ Eee.]))))]
581 // CHECK: annotate-comments.cpp:303:6: FunctionDecl=comment_to_html_conversion_18:{{.*}} FullCommentAsHTML=[<p class="para-brief"> <br><a href="http://example.com/">Aaa</a></p>]
582 // CHECK-NEXT:  CommentAST=[
583 // CHECK-NEXT:    (CXComment_FullComment
584 // CHECK-NEXT:       (CXComment_Paragraph
585 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
586 // CHECK-NEXT:         (CXComment_HTMLStartTag Name=[br])
587 // CHECK-NEXT:         (CXComment_HTMLStartTag Name=[a] Attrs: href=http://example.com/)
588 // CHECK-NEXT:         (CXComment_Text Text=[Aaa])
589 // CHECK-NEXT:         (CXComment_HTMLEndTag Name=[a])))]
590 // CHECK: annotate-comments.cpp:309:6: FunctionDecl=comment_to_html_conversion_19:{{.*}} FullCommentAsHTML=[<pre> &lt;a href=&quot;http:&#47;&#47;example.com&#47;&quot;&gt;Aaa&lt;&#47;a&gt;\n &lt;a href=&#39;http:&#47;&#47;example.com&#47;&#39;&gt;Aaa&lt;&#47;a&gt;</pre>]
591 // CHECK-NEXT:  CommentAST=[
592 // CHECK-NEXT:    (CXComment_FullComment
593 // CHECK-NEXT:       (CXComment_Paragraph IsWhitespace
594 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace))
595 // CHECK-NEXT:       (CXComment_VerbatimBlockCommand CommandName=[verbatim]
596 // CHECK-NEXT:         (CXComment_VerbatimBlockLine Text=[ <a href="http://example.com/">Aaa</a>])
597 // CHECK-NEXT:         (CXComment_VerbatimBlockLine Text=[ <a href='http://example.com/'>Aaa</a>])))]
598 // CHECK: annotate-comments.cpp:312:6: FunctionDecl=comment_to_html_conversion_20:{{.*}} FullCommentAsHTML=[<p class="para-brief"> <b>Aaa</b></p>]
599 // CHECK-NEXT:  CommentAST=[
600 // CHECK-NEXT:    (CXComment_FullComment
601 // CHECK-NEXT:       (CXComment_Paragraph
602 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
603 // CHECK-NEXT:         (CXComment_InlineCommand CommandName=[b] RenderBold Arg[0]=Aaa)))]
604 // CHECK: annotate-comments.cpp:315:6: FunctionDecl=comment_to_html_conversion_21:{{.*}} FullCommentAsHTML=[<p class="para-brief"> <tt>Aaa</tt> <tt>Bbb</tt></p>]
605 // CHECK-NEXT:  CommentAST=[
606 // CHECK-NEXT:    (CXComment_FullComment
607 // CHECK-NEXT:       (CXComment_Paragraph
608 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
609 // CHECK-NEXT:         (CXComment_InlineCommand CommandName=[c] RenderMonospaced Arg[0]=Aaa)
610 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
611 // CHECK-NEXT:         (CXComment_InlineCommand CommandName=[p] RenderMonospaced Arg[0]=Bbb)))]
612 // CHECK: annotate-comments.cpp:318:6: FunctionDecl=comment_to_html_conversion_22:{{.*}} FullCommentAsHTML=[<p class="para-brief"> <em>Aaa</em> <em>Bbb</em> <em>Ccc</em></p>]
613 // CHECK-NEXT:  CommentAST=[
614 // CHECK-NEXT:    (CXComment_FullComment
615 // CHECK-NEXT:       (CXComment_Paragraph
616 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
617 // CHECK-NEXT:         (CXComment_InlineCommand CommandName=[a] RenderEmphasized Arg[0]=Aaa)
618 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
619 // CHECK-NEXT:         (CXComment_InlineCommand CommandName=[e] RenderEmphasized Arg[0]=Bbb)
620 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
621 // CHECK-NEXT:         (CXComment_InlineCommand CommandName=[em] RenderEmphasized Arg[0]=Ccc)))]
622 // CHECK: annotate-comments.cpp:321:6: FunctionDecl=comment_to_html_conversion_23:{{.*}} FullCommentAsHTML=[<p class="para-brief"> \ @ &amp; $ # &lt; &gt; % &quot; . ::</p>]
623 // CHECK-NEXT:  CommentAST=[
624 // CHECK-NEXT:    (CXComment_FullComment
625 // CHECK-NEXT:       (CXComment_Paragraph
626 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
627 // CHECK-NEXT:         (CXComment_Text Text=[\])
628 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
629 // CHECK-NEXT:         (CXComment_Text Text=[@])
630 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
631 // CHECK-NEXT:         (CXComment_Text Text=[&])
632 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
633 // CHECK-NEXT:         (CXComment_Text Text=[$])
634 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
635 // CHECK-NEXT:         (CXComment_Text Text=[#])
636 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
637 // CHECK-NEXT:         (CXComment_Text Text=[<])
638 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
639 // CHECK-NEXT:         (CXComment_Text Text=[>])
640 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
641 // CHECK-NEXT:         (CXComment_Text Text=[%])
642 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
643 // CHECK-NEXT:         (CXComment_Text Text=["])
644 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
645 // CHECK-NEXT:         (CXComment_Text Text=[.])
646 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
647 // CHECK-NEXT:         (CXComment_Text Text=[::])))]
648 // CHECK: annotate-comments.cpp:324:6: FunctionDecl=comment_to_html_conversion_24:{{.*}} FullCommentAsHTML=[<p class="para-brief"> &amp; &lt; &gt; &quot;</p>]
649 // CHECK-NEXT:  CommentAST=[
650 // CHECK-NEXT:    (CXComment_FullComment
651 // CHECK-NEXT:       (CXComment_Paragraph
652 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
653 // CHECK-NEXT:         (CXComment_Text Text=[&])
654 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
655 // CHECK-NEXT:         (CXComment_Text Text=[<])
656 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
657 // CHECK-NEXT:         (CXComment_Text Text=[>])
658 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
659 // CHECK-NEXT:         (CXComment_Text Text=["])))]
660 // CHECK: annotate-comments.cpp:327:6: FunctionDecl=comment_to_html_conversion_25:{{.*}} FullCommentAsHTML=[<p class="para-brief"> <em>0&lt;i</em></p>]
661 // CHECK-NEXT:  CommentAST=[
662 // CHECK-NEXT:    (CXComment_FullComment
663 // CHECK-NEXT:       (CXComment_Paragraph
664 // CHECK-NEXT:         (CXComment_Text Text=[ ] IsWhitespace)
665 // CHECK-NEXT:         (CXComment_HTMLStartTag Name=[em])
666 // CHECK-NEXT:         (CXComment_Text Text=[0])
667 // CHECK-NEXT:         (CXComment_Text Text=[<])
668 // CHECK-NEXT:         (CXComment_Text Text=[i])
669 // CHECK-NEXT:         (CXComment_HTMLEndTag Name=[em])))]
670 
671