blob: 2c8207b8aef5095539e72154bcb5df98bf707701 [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 Gribenko388a5942012-09-14 15:37:29 +0000387/// \invariant aaa
388void test_invariant_1(int a);
389
390// expected-warning@+1 {{empty paragraph passed to '\invariant' command}}
391/// \invariant
392void test_invariant_2(int a);
393
394
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000395// no-warning
396/// \returns Aaa
397int test_returns_right_decl_1(int);
398
399class test_returns_right_decl_2 {
400 // no-warning
401 /// \returns Aaa
402 int test_returns_right_decl_3(int);
403};
404
405// no-warning
406/// \returns Aaa
407template<typename T>
408int test_returns_right_decl_4(T aaa);
409
410// no-warning
411/// \returns Aaa
412template<>
413int test_returns_right_decl_4(int aaa);
414
415/// \returns Aaa
416template<typename T>
417T test_returns_right_decl_5(T aaa);
418
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000419// 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 +0000420/// \returns Aaa
421int test_returns_wrong_decl_1;
422
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000423// 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 +0000424/// \return Aaa
425int test_returns_wrong_decl_2;
426
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000427// 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 +0000428/// \result Aaa
429int test_returns_wrong_decl_3;
430
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000431// expected-warning@+1 {{'\returns' command used in a comment that is attached to a function returning void}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000432/// \returns Aaa
433void test_returns_wrong_decl_4(int);
434
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000435// expected-warning@+1 {{'\returns' command used in a comment that is attached to a function returning void}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000436/// \returns Aaa
437template<typename T>
438void test_returns_wrong_decl_5(T aaa);
439
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000440// expected-warning@+1 {{'\returns' command used in a comment that is attached to a function returning void}}
Dmitri Gribenko89ab7d02012-08-03 21:15:32 +0000441/// \returns Aaa
442template<>
443void test_returns_wrong_decl_5(int aaa);
444
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000445// 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 +0000446/// \returns Aaa
447struct test_returns_wrong_decl_6 { };
448
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000449// 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 +0000450/// \returns Aaa
451class test_returns_wrong_decl_7 {
452 // expected-warning@+1 {{'\returns' command used in a comment that is attached to a constructor}}
453 /// \returns Aaa
454 test_returns_wrong_decl_7();
455
456 // expected-warning@+1 {{'\returns' command used in a comment that is attached to a destructor}}
457 /// \returns Aaa
458 ~test_returns_wrong_decl_7();
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
463enum test_returns_wrong_decl_8 {
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000464 // 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 +0000465 /// \returns Aaa
466 test_returns_wrong_decl_9
467};
468
Dmitri Gribenko88815f32012-08-06 16:29:26 +0000469// 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 +0000470/// \returns Aaa
471namespace test_returns_wrong_decl_10 { };
472
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000473
474// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000475int test1; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000476
477// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
478// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000479int test2, ///< \brief\author Aaa
480 test3; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000481
482// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
483int test4; ///< \brief
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000484 ///< \author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000485
486
487// Check that we attach the comment to the declaration during parsing in the
488// following cases. The test is based on the fact that we don't parse
489// documentation comments that are not attached to anything.
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 +0000493int test_attach1;
494
495// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000496/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000497int test_attach2(int);
498
499// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000500/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000501struct test_attach3 {
502 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000503 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000504 int test_attach4;
505
506 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000507 int test_attach5; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000508
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_attach6(int);
512};
513
514// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000515/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000516class test_attach7 {
517 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000518 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000519 int test_attach8;
520
521 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000522 int test_attach9; ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000523
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 int test_attach10(int);
527};
528
529// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000530/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000531enum test_attach9 {
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 +0000534 test_attach10,
535
536 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000537 test_attach11 ///< \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000538};
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 +0000542struct test_noattach12 *test_attach13;
543
544// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000545/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000546typedef struct test_noattach14 *test_attach15;
547
548// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000549/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000550typedef struct test_attach16 { int a; } test_attach17;
551
552struct S { int a; };
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 S *test_attach18;
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 S *test_attach19;
561
562// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000563/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000564struct test_attach20;
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 +0000568typedef struct test_attach21 {
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 int test_attach22;
572} test_attach23;
573
574// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000575/// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000576namespace test_attach24 {
577 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000578 /// \brief\author Aaa
Dmitri Gribenkoa5ef44f2012-07-11 21:38:39 +0000579 namespace test_attach25 {
580 }
581}
582
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000583// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000584/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000585/// \tparam T Aaa
586template<typename T>
587void test_attach26(T aaa);
588
589// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000590/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000591/// \tparam T Aaa
592template<typename T, typename U>
593void test_attach27(T aaa, U bbb);
594
595// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
596// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000597/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000598/// \tparam T Aaa
599template<>
600void test_attach27(int aaa, int bbb);
601
602// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000603/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000604/// \tparam T Aaa
605template<typename T>
606class test_attach28 {
607 T aaa;
608};
609
610// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000611/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000612using test_attach29 = test_attach28<int>;
613
614// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000615/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000616/// \tparam T Aaa
617template<typename T, typename U>
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000618class test_attach30 { };
619
620// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000621/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000622/// \tparam T Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000623template<typename T>
624class test_attach30<T, int> { };
625
626// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000627/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000628template<>
629class test_attach30<int, int> { };
630
631// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000632/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000633template<typename T>
634using test_attach31 = test_attach30<T, int>;
635
636// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000637/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000638/// \tparam T Aaa
639template<typename T, typename U, typename V>
640class test_attach32 { };
641
642// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000643/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000644/// \tparam T Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000645template<typename T, typename U>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000646class test_attach32<T, U, int> { };
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000647
648// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000649/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000650/// \tparam T Aaa
651template<typename T>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000652class test_attach32<T, int, int> { };
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000653
654// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
655// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000656/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000657/// \tparam T Aaa
658template<>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000659class test_attach32<int, int, int> { };
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000660
661// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000662/// \brief\author Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000663class test_attach33 {
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000664 // expected-warning@+1 {{empty paragraph passed to '\brief' command}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000665 /// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000666 /// \tparam T Aaa
667 template<typename T, typename U>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000668 void test_attach34(T aaa, U bbb);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000669};
670
671template<typename T>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000672class test_attach35 {
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000673 // 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
677 template<typename TT, typename UU>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000678 void test_attach36(TT aaa, UU bbb);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000679};
680
681// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
682// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000683/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000684/// \tparam T Aaa
685template<> template<>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000686void test_attach35<int>::test_attach36(int aaa, int bbb) {}
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000687
688template<typename T>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000689class test_attach37 {
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000690 // expected-warning@+2 {{empty paragraph passed to '\brief' command}}
691 // expected-warning@+2 {{'\tparam' command used in a comment that is not attached to a template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000692 /// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000693 /// \tparam T Aaa
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000694 void test_attach38(int aaa, int bbb);
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000695
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000696 void test_attach39(int aaa, int bbb);
697};
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000698
699// expected-warning@+2 {{empty paragraph passed to '\brief' command}}
700// expected-warning@+2 {{template parameter 'T' not found in the template declaration}}
Dmitri Gribenko9443c572012-08-06 17:08:27 +0000701/// \brief\author Aaa
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000702/// \tparam T Aaa
703template<>
Dmitri Gribenkoc27bc802012-08-02 20:49:51 +0000704void test_attach37<int>::test_attach38(int aaa, int bbb) {}
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000705
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000706// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
707/// \brief\author Aaa
708/// \tparam T Aaa
709template<typename T>
710void test_attach37<T>::test_attach39(int aaa, int bbb) {}
711
Dmitri Gribenko1599eac2012-08-16 18:19:43 +0000712// We used to emit warning that parameter 'a' is not found because we parsed
713// the comment in context of the redeclaration which does not have parameter
714// names.
715template <typename T>
716struct test_attach38 {
717 /*!
718 \param a First param
719 \param b Second param
720 */
721 template <typename B>
722 void test_attach39(T a, B b);
723};
724
725template <>
726template <typename B>
727void test_attach38<int>::test_attach39(int, B);
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000728
Dmitri Gribenko96b09862012-07-31 22:37:06 +0000729
Dmitri Gribenko9f08f492012-07-20 20:18:53 +0000730// PR13411, reduced. We used to crash on this.
731/**
732 * @code Aaa.
733 */
734void test_nocrash1(int);
735
Dmitri Gribenkoe5deb792012-07-30 18:05:28 +0000736// We used to crash on this.
737// expected-warning@+2 {{empty paragraph passed to '\param' command}}
738// expected-warning@+1 {{empty paragraph passed to '\brief' command}}
739/// \param\brief
740void test_nocrash2(int);
741
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000742// PR13593, example 1 and 2
Douglas Gregorcd81df22012-08-13 16:37:30 +0000743
744/**
745* Bla.
746*/
747template <typename>
748void test_nocrash3();
749
750/// Foo
751template <typename, typename>
752void test_nocrash4() { }
753
754template <typename>
755void test_nocrash3()
756{
757}
Dmitri Gribenkoc41ace92012-08-14 17:17:18 +0000758
759// PR13593, example 3
760
761/**
762 * aaa
763 */
764template <typename T>
765inline T test_nocrash5(T a1)
766{
767 return a1;
768}
769
770///
771//,
772
773inline void test_nocrash6()
774{
775 test_nocrash5(1);
776}
777
778// We used to crash on this.
779
780/*!
781 Blah.
782*/
783typedef const struct test_nocrash7 * test_nocrash8;
784
Dmitri Gribenkob0b8a962012-09-11 19:22:03 +0000785// We used to crash on this.
786
787/// aaa \unknown aaa \unknown aaa
788int test_nocrash9;
789