blob: a18a0a44a4ed85ca8e8acddd110c07429db47b60 [file] [log] [blame]
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +00001// RUN: %clang_cc1 -std=c++11 -fsyntax-only -Wdocumentation -Wdocumentation-pedantic -verify %s
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +00002
Dmitri Gribenkof303d4c2012-08-07 17:54:38 +00003// This file contains lots of corner cases, so ensure that XML we generate is not invalid.
4// RUN: c-index-test -test-load-source all -comments-xml-schema=%S/../../bindings/xml/comment-xml-schema.rng %s | FileCheck %s -check-prefix=WRONG
5// WRONG-NOT: CommentXMLInvalid
6
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +00007// expected-warning@+1 {{expected quoted string after equals sign}}
8/// <a href=>
9int test_html1(int);
10
11// expected-warning@+1 {{expected quoted string after equals sign}}
12/// <a href==>
13int test_html2(int);
14
15// expected-warning@+2 {{expected quoted string after equals sign}}
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000016// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000017/// <a href= blah
18int test_html3(int);
19
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000020// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000021/// <a =>
22int test_html4(int);
23
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000024// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000025/// <a "aaa">
26int test_html5(int);
27
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000028// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000029/// <a a="b" =>
30int test_html6(int);
31
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000032// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000033/// <a a="b" "aaa">
34int test_html7(int);
35
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000036// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000037/// <a a="b" =
38int test_html8(int);
39
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000040// expected-warning@+2 {{HTML start tag prematurely ended, expected attribute name or '>'}} expected-note@+1 {{HTML tag started here}}
Dmitri Gribenko834a5bd2012-08-22 22:56:08 +000041/** Aaa bbb<img ddd eee
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000042 * fff ggg.
43 */
44int test_html9(int);
45
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000046// expected-warning@+1 {{HTML start tag prematurely ended, expected attribute name or '>'}}
Dmitri Gribenko834a5bd2012-08-22 22:56:08 +000047/** Aaa bbb<img ddd eee 42%
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000048 * fff ggg.
49 */
50int test_html10(int);
51
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000052// expected-warning@+1 {{HTML end tag 'br' is forbidden}}
Dmitri Gribenko3d986982012-07-12 23:37:09 +000053/// <br></br>
54int test_html11(int);
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000055
56/// <blockquote>Meow</blockquote>
57int test_html_nesting1(int);
58
59/// <b><i>Meow</i></b>
60int test_html_nesting2(int);
61
62/// <p>Aaa<br>
63/// Bbb</p>
64int test_html_nesting3(int);
65
66/// <p>Aaa<br />
67/// Bbb</p>
68int test_html_nesting4(int);
69
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000070// expected-warning@+1 {{HTML end tag does not match any start tag}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000071/// <b><i>Meow</a>
72int test_html_nesting5(int);
73
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000074// expected-warning@+2 {{HTML start tag 'i' closed by 'b'}}
75// expected-warning@+1 {{HTML end tag does not match any start tag}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000076/// <b><i>Meow</b></b>
77int test_html_nesting6(int);
78
Dmitri Gribenko3f38bf22012-07-13 00:44:24 +000079// expected-warning@+2 {{HTML start tag 'i' closed by 'b'}}
80// expected-warning@+1 {{HTML end tag does not match any start tag}}
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000081/// <b><i>Meow</b></i>
82int test_html_nesting7(int);
83
84
85// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +000086/// \brief\returns Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000087int test_block_command1(int);
88
89// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +000090/// \brief \returns Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000091int test_block_command2(int);
92
93// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
94/// \brief
Dmitri Gribenko9443c572012-08-06 17:08:27 +000095/// \returns Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +000096int test_block_command3(int);
97
98// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
99/// \brief
100///
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000101/// \returns Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000102int test_block_command4(int);
103
104// There is trailing whitespace on one of the following lines, don't remove it!
105// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
106/// \brief
107///
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000108/// \returns Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000109int test_block_command5(int);
110
Dmitri Gribenko858e69f2012-07-19 00:01:56 +0000111/// \brief \c Aaa
112int test_block_command6(int);
113
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000114// expected-warning@+5 {{duplicated command '\brief'}} expected-note@+1 {{previous command '\brief' here}}
115/// \brief Aaa
116///
117/// Bbb
118///
119/// \brief Ccc
120int test_duplicate_brief1(int);
121
122// expected-warning@+5 {{duplicated command '\short'}} expected-note@+1 {{previous command '\short' here}}
123/// \short Aaa
124///
125/// Bbb
126///
127/// \short Ccc
128int test_duplicate_brief2(int);
129
130// expected-warning@+5 {{duplicated command '\brief'}} expected-note@+1 {{previous command '\short' (an alias of '\brief') here}}
131/// \short Aaa
132///
133/// Bbb
134///
135/// \brief Ccc
136int test_duplicate_brief3(int);
137
138
139// expected-warning@+5 {{duplicated command '\return'}} expected-note@+1 {{previous command '\return' here}}
140/// \return Aaa
141///
142/// Bbb
143///
144/// \return Ccc
145int test_duplicate_returns1(int);
146
147// expected-warning@+5 {{duplicated command '\returns'}} expected-note@+1 {{previous command '\returns' here}}
148/// \returns Aaa
149///
150/// Bbb
151///
152/// \returns Ccc
153int test_duplicate_returns2(int);
154
155// expected-warning@+5 {{duplicated command '\result'}} expected-note@+1 {{previous command '\result' here}}
156/// \result Aaa
157///
158/// Bbb
159///
160/// \result Ccc
161int test_duplicate_returns3(int);
162
163// expected-warning@+5 {{duplicated command '\return'}} expected-note@+1 {{previous command '\returns' (an alias of '\return') here}}
164/// \returns Aaa
165///
166/// Bbb
167///
168/// \return Ccc
169int test_duplicate_returns4(int);
170
171
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000172// expected-warning@+1 {{'\param' command used in a comment that is not attached to a function declaration}}
173/// \param a Blah blah.
174int test_param1;
175
176// expected-warning@+1 {{empty paragraph passed to '\param' command}}
177/// \param
178/// \param a Blah blah.
179int test_param2(int a);
180
181// expected-warning@+1 {{empty paragraph passed to '\param' command}}
182/// \param a
183int test_param3(int a);
184
185/// \param a Blah blah.
186int test_param4(int a);
187
188/// \param [in] a Blah blah.
189int test_param5(int a);
190
191/// \param [out] a Blah blah.
192int test_param6(int a);
193
194/// \param [in,out] a Blah blah.
195int test_param7(int a);
196
197// expected-warning@+1 {{whitespace is not allowed in parameter passing direction}}
198/// \param [ in ] a Blah blah.
199int test_param8(int a);
200
201// expected-warning@+1 {{whitespace is not allowed in parameter passing direction}}
202/// \param [in, out] a Blah blah.
203int test_param9(int a);
204
205// expected-warning@+1 {{unrecognized parameter passing direction, valid directions are '[in]', '[out]' and '[in,out]'}}
206/// \param [ junk] a Blah blah.
207int test_param10(int a);
208
Dmitri Gribenko2e721042012-07-24 21:56:59 +0000209// expected-warning@+1 {{parameter 'a' not found in the function declaration}}
Dmitri Gribenko56bf6fd2012-07-24 21:46:24 +0000210/// \param a Blah blah.
211int test_param11();
212
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000213// expected-warning@+1 {{parameter 'A' not found in the function declaration}} expected-note@+1 {{did you mean 'a'?}}
214/// \param A Blah blah.
Dmitri Gribenko56bf6fd2012-07-24 21:46:24 +0000215int test_param12(int a);
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000216
217// expected-warning@+1 {{parameter 'aab' not found in the function declaration}} expected-note@+1 {{did you mean 'aaa'?}}
218/// \param aab Blah blah.
Dmitri Gribenko56bf6fd2012-07-24 21:46:24 +0000219int test_param13(int aaa, int bbb);
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000220
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000221// expected-warning@+2 {{parameter 'aab' not found in the function declaration}} expected-note@+2 {{did you mean 'bbb'?}}
222/// \param aaa Blah blah.
223/// \param aab Blah blah.
224int test_param14(int aaa, int bbb);
225
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000226// expected-warning@+1 {{parameter 'aab' not found in the function declaration}}
227/// \param aab Blah blah.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000228int test_param15(int bbb, int ccc);
229
230// expected-warning@+1 {{parameter 'aab' not found in the function declaration}}
231/// \param aab Ccc.
232/// \param aaa Aaa.
233/// \param bbb Bbb.
234int test_param16(int aaa, int bbb);
235
236// expected-warning@+2 {{parameter 'aab' not found in the function declaration}}
237/// \param aaa Aaa.
238/// \param aab Ccc.
239/// \param bbb Bbb.
240int test_param17(int aaa, int bbb);
241
242// expected-warning@+3 {{parameter 'aab' not found in the function declaration}}
243/// \param aaa Aaa.
244/// \param bbb Bbb.
245/// \param aab Ccc.
246int test_param18(int aaa, int bbb);
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000247
248class C {
249 // expected-warning@+1 {{parameter 'aaa' not found in the function declaration}}
250 /// \param aaa Blah blah.
251 C(int bbb, int ccc);
252
253 // expected-warning@+1 {{parameter 'aaa' not found in the function declaration}}
254 /// \param aaa Blah blah.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000255 int test_param19(int bbb, int ccc);
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000256};
257
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000258// expected-warning@+1 {{parameter 'aab' not found in the function declaration}}
259/// \param aab Blah blah.
260template<typename T>
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000261void test_param20(int bbb, int ccc);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000262
Dmitri Gribenko65822772012-07-24 21:44:16 +0000263// expected-warning@+3 {{parameter 'a' is already documented}}
264// expected-note@+1 {{previous documentation}}
265/// \param a Aaa.
266/// \param a Aaa.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000267int test_param21(int a);
Dmitri Gribenko65822772012-07-24 21:44:16 +0000268
269// expected-warning@+4 {{parameter 'x2' is already documented}}
270// expected-note@+2 {{previous documentation}}
271/// \param x1 Aaa.
272/// \param x2 Bbb.
273/// \param x2 Ccc.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000274int test_param22(int x1, int x2, int x3);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000275
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000276// expected-warning@+2 {{parameter 'bbb' not found in the function declaration}} expected-note@+2 {{did you mean 'ccc'?}}
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000277/// \param aaa Meow.
278/// \param bbb Bbb.
279/// \returns aaa.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000280typedef int test_param23(int aaa, int ccc);
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000281
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000282// expected-warning@+2 {{parameter 'bbb' not found in the function declaration}} expected-note@+2 {{did you mean 'ccc'?}}
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000283/// \param aaa Meow.
284/// \param bbb Bbb.
285/// \returns aaa.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000286typedef int (*test_param24)(int aaa, int ccc);
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000287
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000288// expected-warning@+2 {{parameter 'bbb' not found in the function declaration}} expected-note@+2 {{did you mean 'ccc'?}}
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000289/// \param aaa Meow.
290/// \param bbb Bbb.
291/// \returns aaa.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000292typedef int (* const test_param25)(int aaa, int ccc);
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000293
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000294// expected-warning@+2 {{parameter 'bbb' not found in the function declaration}} expected-note@+2 {{did you mean 'ccc'?}}
Dmitri Gribenko70ff1092012-08-24 00:05:30 +0000295/// \param aaa Meow.
296/// \param bbb Bbb.
297/// \returns aaa.
Dmitri Gribenko9edd2c82012-08-24 17:45:39 +0000298typedef int (C::*test_param26)(int aaa, int ccc);
299
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000300
301// expected-warning@+1 {{'\tparam' command used in a comment that is not attached to a template declaration}}
302/// \tparam T Aaa
303int test_tparam1;
304
305// expected-warning@+1 {{'\tparam' command used in a comment that is not attached to a template declaration}}
306/// \tparam T Aaa
307void test_tparam2(int aaa);
308
309// expected-warning@+1 {{empty paragraph passed to '\tparam' command}}
310/// \tparam
311/// \param aaa Blah blah
312template<typename T>
313void test_tparam3(T aaa);
314
315// expected-warning@+1 {{template parameter 'T' not found in the template declaration}} expected-note@+1 {{did you mean 'TT'?}}
316/// \tparam T Aaa
317template<typename TT>
318void test_tparam4(TT aaa);
319
320// expected-warning@+1 {{template parameter 'T' not found in the template declaration}} expected-note@+1 {{did you mean 'TT'?}}
321/// \tparam T Aaa
322template<typename TT>
323class test_tparam5 {
324 // expected-warning@+1 {{template parameter 'T' not found in the template declaration}} expected-note@+1 {{did you mean 'TTT'?}}
325 /// \tparam T Aaa
326 template<typename TTT>
327 void test_tparam6(TTT aaa);
328};
329
330/// \tparam T1 Aaa
331/// \tparam T2 Bbb
332template<typename T1, typename T2>
333void test_tparam7(T1 aaa, T2 bbb);
334
335// expected-warning@+1 {{template parameter 'SomTy' not found in the template declaration}} expected-note@+1 {{did you mean 'SomeTy'?}}
336/// \tparam SomTy Aaa
337/// \tparam OtherTy Bbb
338template<typename SomeTy, typename OtherTy>
339void test_tparam8(SomeTy aaa, OtherTy bbb);
340
341// expected-warning@+2 {{template parameter 'T1' is already documented}} expected-note@+1 {{previous documentation}}
342/// \tparam T1 Aaa
343/// \tparam T1 Bbb
344template<typename T1, typename T2>
345void test_tparam9(T1 aaa, T2 bbb);
346
347/// \tparam T Aaa
348/// \tparam TT Bbb
349template<template<typename T> class TT>
350void test_tparam10(TT<int> aaa);
351
352/// \tparam T Aaa
353/// \tparam TT Bbb
354/// \tparam TTT Ccc
355template<template<template<typename T> class TT, class C> class TTT>
356void test_tparam11();
357
358/// \tparam I Aaa
359template<int I>
360void test_tparam12();
361
Dmitri Gribenko967e5d72012-08-02 21:36:57 +0000362template<typename T, typename U>
363class test_tparam13 { };
364
365/// \tparam T Aaa
366template<typename T>
367using test_tparam14 = test_tparam13<T, int>;
368
369// expected-warning@+1 {{template parameter 'U' not found in the template declaration}} expected-note@+1 {{did you mean 'T'?}}
370/// \tparam U Aaa
371template<typename T>
372using test_tparam15 = test_tparam13<T, int>;
373
Dmitri Gribenkoabcf0dc2012-09-13 20:36:01 +0000374
375/// Aaa
376/// \deprecated Bbb
377void test_deprecated_1(int a);
378
379// We don't want \deprecated to warn about empty paragraph. It is fine to use
380// \deprecated by itself without explanations.
381
382/// Aaa
383/// \deprecated
384void test_deprecated_2(int a);
385
386
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000387// no-warning
388/// \returns Aaa
389int test_returns_right_decl_1(int);
390
391class test_returns_right_decl_2 {
392 // no-warning
393 /// \returns Aaa
394 int test_returns_right_decl_3(int);
395};
396
397// no-warning
398/// \returns Aaa
399template<typename T>
400int test_returns_right_decl_4(T aaa);
401
402// no-warning
403/// \returns Aaa
404template<>
405int test_returns_right_decl_4(int aaa);
406
407/// \returns Aaa
408template<typename T>
409T test_returns_right_decl_5(T aaa);
410
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000411// expected-warning@+1 {{'\returns' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000412/// \returns Aaa
413int test_returns_wrong_decl_1;
414
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000415// expected-warning@+1 {{'\return' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000416/// \return Aaa
417int test_returns_wrong_decl_2;
418
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000419// expected-warning@+1 {{'\result' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000420/// \result Aaa
421int test_returns_wrong_decl_3;
422
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000423// expected-warning@+1 {{'\returns' command used in a comment that is attached to a function returning void}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000424/// \returns Aaa
425void test_returns_wrong_decl_4(int);
426
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000427// expected-warning@+1 {{'\returns' command used in a comment that is attached to a function returning void}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000428/// \returns Aaa
429template<typename T>
430void test_returns_wrong_decl_5(T aaa);
431
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000432// expected-warning@+1 {{'\returns' command used in a comment that is attached to a function returning void}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000433/// \returns Aaa
434template<>
435void test_returns_wrong_decl_5(int aaa);
436
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000437// expected-warning@+1 {{'\returns' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000438/// \returns Aaa
439struct test_returns_wrong_decl_6 { };
440
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000441// expected-warning@+1 {{'\returns' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000442/// \returns Aaa
443class test_returns_wrong_decl_7 {
444 // expected-warning@+1 {{'\returns' command used in a comment that is attached to a constructor}}
445 /// \returns Aaa
446 test_returns_wrong_decl_7();
447
448 // expected-warning@+1 {{'\returns' command used in a comment that is attached to a destructor}}
449 /// \returns Aaa
450 ~test_returns_wrong_decl_7();
451};
452
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000453// expected-warning@+1 {{'\returns' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000454/// \returns Aaa
455enum test_returns_wrong_decl_8 {
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000456 // expected-warning@+1 {{'\returns' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000457 /// \returns Aaa
458 test_returns_wrong_decl_9
459};
460
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000461// expected-warning@+1 {{'\returns' command used in a comment that is not attached to a function or method declaration}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000462/// \returns Aaa
463namespace test_returns_wrong_decl_10 { };
464
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000465
466// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000467int test1; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000468
469// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
470// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000471int test2, ///< \brief\author Aaa
472 test3; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000473
474// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
475int test4; ///< \brief
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000476 ///< \author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000477
478
479// Check that we attach the comment to the declaration during parsing in the
480// following cases. The test is based on the fact that we don't parse
481// documentation comments that are not attached to anything.
482
483// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000484/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000485int test_attach1;
486
487// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000488/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000489int test_attach2(int);
490
491// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000492/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000493struct test_attach3 {
494 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000495 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000496 int test_attach4;
497
498 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000499 int test_attach5; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000500
501 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000502 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000503 int test_attach6(int);
504};
505
506// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000507/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000508class test_attach7 {
509 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000510 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000511 int test_attach8;
512
513 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000514 int test_attach9; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000515
516 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000517 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000518 int test_attach10(int);
519};
520
521// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000522/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000523enum test_attach9 {
524 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000525 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000526 test_attach10,
527
528 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000529 test_attach11 ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000530};
531
532// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000533/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000534struct test_noattach12 *test_attach13;
535
536// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000537/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000538typedef struct test_noattach14 *test_attach15;
539
540// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000541/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000542typedef struct test_attach16 { int a; } test_attach17;
543
544struct S { int a; };
545
546// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000547/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000548struct S *test_attach18;
549
550// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000551/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000552typedef struct S *test_attach19;
553
554// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000555/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000556struct test_attach20;
557
558// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000559/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000560typedef struct test_attach21 {
561 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000562 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000563 int test_attach22;
564} test_attach23;
565
566// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000567/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000568namespace test_attach24 {
569 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000570 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000571 namespace test_attach25 {
572 }
573}
574
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000575// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000576/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000577/// \tparam T Aaa
578template<typename T>
579void test_attach26(T aaa);
580
581// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000582/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000583/// \tparam T Aaa
584template<typename T, typename U>
585void test_attach27(T aaa, U bbb);
586
587// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
588// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000589/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000590/// \tparam T Aaa
591template<>
592void test_attach27(int aaa, int bbb);
593
594// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000595/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000596/// \tparam T Aaa
597template<typename T>
598class test_attach28 {
599 T aaa;
600};
601
602// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000603/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000604using test_attach29 = test_attach28<int>;
605
606// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000607/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000608/// \tparam T Aaa
609template<typename T, typename U>
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000610class test_attach30 { };
611
612// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000613/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000614/// \tparam T Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000615template<typename T>
616class test_attach30<T, int> { };
617
618// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000619/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000620template<>
621class test_attach30<int, int> { };
622
623// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000624/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000625template<typename T>
626using test_attach31 = test_attach30<T, int>;
627
628// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000629/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000630/// \tparam T Aaa
631template<typename T, typename U, typename V>
632class test_attach32 { };
633
634// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000635/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000636/// \tparam T Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000637template<typename T, typename U>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000638class test_attach32<T, U, int> { };
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000639
640// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000641/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000642/// \tparam T Aaa
643template<typename T>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000644class test_attach32<T, int, int> { };
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000645
646// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
647// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000648/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000649/// \tparam T Aaa
650template<>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000651class test_attach32<int, int, int> { };
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000652
653// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000654/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000655class test_attach33 {
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000656 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000657 /// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000658 /// \tparam T Aaa
659 template<typename T, typename U>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000660 void test_attach34(T aaa, U bbb);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000661};
662
663template<typename T>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000664class test_attach35 {
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000665 // expected-warning@+2 {{empty paragraph passed to '\brief' command}}
666 // expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000667 /// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000668 /// \tparam T Aaa
669 template<typename TT, typename UU>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000670 void test_attach36(TT aaa, UU bbb);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000671};
672
673// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
674// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000675/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000676/// \tparam T Aaa
677template<> template<>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000678void test_attach35<int>::test_attach36(int aaa, int bbb) {}
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000679
680template<typename T>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000681class test_attach37 {
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000682 // expected-warning@+2 {{empty paragraph passed to '\brief' command}}
683 // expected-warning@+2 {{'\tparam' command used in a comment that is not attached to a template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000684 /// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000685 /// \tparam T Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000686 void test_attach38(int aaa, int bbb);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000687
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000688 void test_attach39(int aaa, int bbb);
689};
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000690
691// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
692// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000693/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000694/// \tparam T Aaa
695template<>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000696void test_attach37<int>::test_attach38(int aaa, int bbb) {}
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000697
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000698// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
699/// \brief\author Aaa
700/// \tparam T Aaa
701template<typename T>
702void test_attach37<T>::test_attach39(int aaa, int bbb) {}
703
Dmitri Gribenko1599eac2012-08-16 18:19:43 +0000704// We used to emit warning that parameter 'a' is not found because we parsed
705// the comment in context of the redeclaration which does not have parameter
706// names.
707template <typename T>
708struct test_attach38 {
709 /*!
710 \param a First param
711 \param b Second param
712 */
713 template <typename B>
714 void test_attach39(T a, B b);
715};
716
717template <>
718template <typename B>
719void test_attach38<int>::test_attach39(int, B);
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000720
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000721
Dmitri Gribenko9f08f492012-07-20 20:18:53 +0000722// PR13411, reduced. We used to crash on this.
723/**
724 * @code Aaa.
725 */
726void test_nocrash1(int);
727
Dmitri Gribenkoe5deb792012-07-30 18:05:28 +0000728// We used to crash on this.
729// expected-warning@+2 {{empty paragraph passed to '\param' command}}
730// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
731/// \param\brief
732void test_nocrash2(int);
733
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000734// PR13593, example 1 and 2
Douglas Gregorcd81df22012-08-13 16:37:30 +0000735
736/**
737* Bla.
738*/
739template <typename>
740void test_nocrash3();
741
742/// Foo
743template <typename, typename>
744void test_nocrash4() { }
745
746template <typename>
747void test_nocrash3()
748{
749}
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000750
751// PR13593, example 3
752
753/**
754 * aaa
755 */
756template <typename T>
757inline T test_nocrash5(T a1)
758{
759 return a1;
760}
761
762///
763//,
764
765inline void test_nocrash6()
766{
767 test_nocrash5(1);
768}
769
770// We used to crash on this.
771
772/*!
773 Blah.
774*/
775typedef const struct test_nocrash7 * test_nocrash8;
776
Dmitri Gribenkob0b8a962012-09-11 19:22:03 +0000777// We used to crash on this.
778
779/// aaa \unknown aaa \unknown aaa
780int test_nocrash9;
781