340 lines · cpp
1// Run lines are sensitive to line numbers and come below the code.2 3#ifndef HEADER4#define HEADER5 6// Not a Doxygen comment. NOT_DOXYGEN7void notdoxy1(void);8 9/* Not a Doxygen comment. NOT_DOXYGEN */10void notdoxy2(void);11 12/*/ Not a Doxygen comment. NOT_DOXYGEN */13void notdoxy3(void);14 15/** Doxygen comment. isdoxy4 IS_DOXYGEN_SINGLE */16void isdoxy4(void);17 18/**19 * Doxygen comment. isdoxy5 IS_DOXYGEN_SINGLE */20void isdoxy5(void);21 22/**23 * Doxygen comment.24 * isdoxy6 IS_DOXYGEN_SINGLE */25void isdoxy6(void);26 27/**28 * Doxygen comment.29 * isdoxy7 IS_DOXYGEN_SINGLE30 */31void isdoxy7(void);32 33/*! Doxygen comment. isdoxy8 IS_DOXYGEN_SINGLE */34void isdoxy8(void);35 36/// Doxygen comment. isdoxy9 IS_DOXYGEN_SINGLE37void isdoxy9(void);38 39// Not a Doxygen comment. NOT_DOXYGEN40/// Doxygen comment. isdoxy10 IS_DOXYGEN_SINGLE41void isdoxy10(void);42 43/// Doxygen comment. isdoxy11 IS_DOXYGEN_SINGLE44// Not a Doxygen comment. NOT_DOXYGEN45void isdoxy11(void);46 47/** Doxygen comment. isdoxy12 IS_DOXYGEN_SINGLE */48/* Not a Doxygen comment. NOT_DOXYGEN */49void isdoxy12(void);50 51/// Doxygen comment. isdoxy13 IS_DOXYGEN_START52/// Doxygen comment. IS_DOXYGEN_END53void isdoxy13(void);54 55/// Doxygen comment. isdoxy14 IS_DOXYGEN_START56/// Blah-blah-blah.57/// Doxygen comment. IS_DOXYGEN_END58void isdoxy14(void);59 60/// Doxygen comment. isdoxy15 IS_DOXYGEN_START61/** Blah-blah-blah */62/// Doxygen comment. IS_DOXYGEN_END63void isdoxy15(void);64 65/** Blah-blah-blah. isdoxy16 IS_DOXYGEN_START *//** Blah */66/// Doxygen comment. IS_DOXYGEN_END67void isdoxy16(void);68 69/// NOT_DOXYGEN70// NOT_DOXYGEN71/// isdoxy17 IS_DOXYGEN_START IS_DOXYGEN_END72void isdoxy17(void);73 74unsigned75// NOT_DOXYGEN76/// NOT_DOXYGEN77// NOT_DOXYGEN78/// isdoxy18 IS_DOXYGEN_START IS_DOXYGEN_END79// NOT_DOXYGEN80int isdoxy18(void);81 82//! It all starts here. isdoxy19 IS_DOXYGEN_START83/*! 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 comments87/** This is a block comment that is associated with the function f. It88 * runs for three lines. IS_DOXYGEN_END89 */90void isdoxy19(int, int);91 92// NOT IN THE COMMENT NOT_DOXYGEN93/// This is a BCPL comment. isdoxy20 IS_DOXYGEN_START94/// It has only two lines.95/** But there are other blocks that are part of the comment, too. IS_DOXYGEN_END */96void isdoxy20(int);97 98void notdoxy21(int); ///< This is a member comment. isdoxy21 IS_DOXYGEN_NOT_ATTACHED99 100void notdoxy22(int); /*!< This is a member comment. isdoxy22 IS_DOXYGEN_NOT_ATTACHED */101 102void notdoxy23(int); /**< This is a member comment. isdoxy23 IS_DOXYGEN_NOT_ATTACHED */103 104void notdoxy24(int); // NOT_DOXYGEN105 106/// IS_DOXYGEN_SINGLE107struct isdoxy25 {108};109 110struct test26 {111 /// IS_DOXYGEN_SINGLE112 int isdoxy26;113};114 115struct test27 {116 int isdoxy27; ///< IS_DOXYGEN_SINGLE117};118 119struct notdoxy28 {120}; ///< IS_DOXYGEN_NOT_ATTACHED121 122/// IS_DOXYGEN_SINGLE123enum isdoxy29 {124};125 126enum notdoxy30 {127}; ///< IS_DOXYGEN_NOT_ATTACHED128 129/// IS_DOXYGEN_SINGLE130namespace isdoxy31 {131};132 133namespace notdoxy32 {134}; ///< IS_DOXYGEN_NOT_ATTACHED135 136class test33 {137 ///< IS_DOXYGEN_NOT_ATTACHED138 int isdoxy33; ///< isdoxy33 IS_DOXYGEN_SINGLE139 int isdoxy34; ///< isdoxy34 IS_DOXYGEN_SINGLE140 141 ///< IS_DOXYGEN_NOT_ATTACHED142 int isdoxy35, ///< isdoxy35 IS_DOXYGEN_SINGLE143 isdoxy36; ///< isdoxy36 IS_DOXYGEN_SINGLE144 145 ///< IS_DOXYGEN_NOT_ATTACHED146 int isdoxy37 ///< isdoxy37 IS_DOXYGEN_SINGLE147 , isdoxy38 ///< isdoxy38 IS_DOXYGEN_SINGLE148 , isdoxy39; ///< isdoxy39 IS_DOXYGEN_SINGLE149};150 151// Verified that Doxygen attaches these.152 153/// isdoxy40 IS_DOXYGEN_SINGLE154// NOT_DOXYGEN155void isdoxy40(int);156 157unsigned158/// isdoxy41 IS_DOXYGEN_SINGLE159// NOT_DOXYGEN160int isdoxy41(int);161 162class test42 {163 int isdoxy42; /* NOT_DOXYGEN */ ///< isdoxy42 IS_DOXYGEN_SINGLE164};165 166/// IS_DOXYGEN_START167/// It is fine to have a command at the end of comment.168///\brief169///170/// Some malformed command.171/** \*/172/**173 * \brief Aaa aaaaaaa aaaa.174 * IS_DOXYGEN_END175 */176void isdoxy43(void);177 178/// IS_DOXYGEN_START Aaa bbb179/// ccc.180///181/// Ddd eee.182/// Fff.183///184/// Ggg. IS_DOXYGEN_END185void isdoxy44(void);186 187/// IS_DOXYGEN_START Aaa bbb188/// ccc.189///190/// \brief191/// Ddd eee.192/// Fff.193///194/// Ggg. IS_DOXYGEN_END195void isdoxy45(void);196 197/// IS_DOXYGEN_START Aaa bbb198/// ccc.199///200/// \short201/// Ddd eee.202/// Fff.203///204/// Ggg. IS_DOXYGEN_END205void isdoxy46(void);206 207/// IS_DOXYGEN_NOT_ATTACHED208#define FOO209void notdoxy47(void);210 211/// IS_DOXYGEN_START Aaa bbb212/// \param ccc213/// \returns ddd IS_DOXYGEN_END214void isdoxy48(int);215 216/// \brief IS_DOXYGEN_START Aaa217/// \returns bbb IS_DOXYGEN_END218void isdoxy49(void);219 220/// \param ccc IS_DOXYGEN_START221/// \returns ddd IS_DOXYGEN_END222void isdoxy50(int);223 224// One of the following lines has trailing whitespace. It is intended, don't225// fix it.226/**227 * Aaa. IS_DOXYGEN_START228 * 229 * Bbb. IS_DOXYGEN_END230 */231void isdoxy51(int);232 233// One of the following lines has trailing whitespace. It is intended, don't234// fix it.235/**236 * Aaa. IS_DOXYGEN_START237 * Bbb.238 * 239 * Ccc. IS_DOXYGEN_END240 */241void isdoxy52(int);242 243/**244 * \fn isdoxy53245 *246 * Aaa. IS_DOXYGEN_START IS_DOXYGEN_END247 */248void isdoxy53(int);249 250#define MYMAC(x,y)251/**252 * Aaa. IS_DOXYGEN_START IS_DOXYGEN_END253 */254MYMAC(0,0)255void isdoxy54(int);256 257#endif258 259// RUN: rm -rf %t260// RUN: mkdir %t261 262// Check that we serialize comment source locations properly.263// RUN: %clang_cc1 -x c++ -std=c++11 -emit-pch -o %t/out.pch %s264// RUN: %clang_cc1 -x c++ -std=c++11 -include-pch %t/out.pch -fsyntax-only %s265 266// RUN: c-index-test -write-pch %t/out.pch -x c++ -std=c++11 %s267// RUN: c-index-test -test-load-source all -comments-xml-schema=%S/../../bindings/xml/comment-xml-schema.rng %s -std=c++11 > %t/out.c-index-direct268// RUN: c-index-test -test-load-tu %t/out.pch all > %t/out.c-index-pch269 270// RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-direct271// RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-pch272 273// Declarations without Doxygen comments should not pick up some Doxygen comments.274// WRONG-NOT: notdoxy{{.*}}Comment=275// WRONG-NOT: test{{.*}}Comment=276 277// Non-Doxygen comments should not be attached to anything.278// WRONG-NOT: NOT_DOXYGEN279 280// Some Doxygen comments are not attached to anything.281// WRONG-NOT: IS_DOXYGEN_NOT_ATTACHED282 283// Ensure we don't pick up extra comments.284// WRONG-NOT: IS_DOXYGEN_START{{.*}}IS_DOXYGEN_START{{.*}}BriefComment=285// WRONG-NOT: IS_DOXYGEN_END{{.*}}IS_DOXYGEN_END{{.*}}BriefComment=286//287// Ensure that XML is not invalid288// WRONG-NOT: CommentXMLInvalid289 290// RUN: FileCheck %s < %t/out.c-index-direct291// RUN: FileCheck %s < %t/out.c-index-pch292 293// These CHECK lines are not located near the code on purpose. This test294// checks that documentation comments are attached to declarations correctly.295// Adding a non-documentation comment with CHECK line between every two296// documentation comments will only test a single code path.297//298// CHECK: annotate-comments.cpp:16:6: FunctionDecl=isdoxy4:{{.*}} isdoxy4 IS_DOXYGEN_SINGLE299// CHECK: annotate-comments.cpp:20:6: FunctionDecl=isdoxy5:{{.*}} isdoxy5 IS_DOXYGEN_SINGLE300// CHECK: annotate-comments.cpp:25:6: FunctionDecl=isdoxy6:{{.*}} isdoxy6 IS_DOXYGEN_SINGLE301// CHECK: annotate-comments.cpp:31:6: FunctionDecl=isdoxy7:{{.*}} isdoxy7 IS_DOXYGEN_SINGLE302// CHECK: annotate-comments.cpp:34:6: FunctionDecl=isdoxy8:{{.*}} isdoxy8 IS_DOXYGEN_SINGLE303// CHECK: annotate-comments.cpp:37:6: FunctionDecl=isdoxy9:{{.*}} isdoxy9 IS_DOXYGEN_SINGLE304// CHECK: annotate-comments.cpp:41:6: FunctionDecl=isdoxy10:{{.*}} isdoxy10 IS_DOXYGEN_SINGLE305// CHECK: annotate-comments.cpp:53:6: FunctionDecl=isdoxy13:{{.*}} isdoxy13 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END306// CHECK: annotate-comments.cpp:58:6: FunctionDecl=isdoxy14:{{.*}} isdoxy14 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END307// CHECK: annotate-comments.cpp:63:6: FunctionDecl=isdoxy15:{{.*}} isdoxy15 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END308// CHECK: annotate-comments.cpp:67:6: FunctionDecl=isdoxy16:{{.*}} isdoxy16 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END309// CHECK: annotate-comments.cpp:72:6: FunctionDecl=isdoxy17:{{.*}} isdoxy17 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END310// CHECK: annotate-comments.cpp:80:5: FunctionDecl=isdoxy18:{{.*}} isdoxy18 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END311// CHECK: annotate-comments.cpp:90:6: FunctionDecl=isdoxy19:{{.*}} isdoxy19 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END312// CHECK: annotate-comments.cpp:96:6: FunctionDecl=isdoxy20:{{.*}} isdoxy20 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END313// CHECK: annotate-comments.cpp:107:8: StructDecl=isdoxy25:{{.*}} IS_DOXYGEN_SINGLE314// CHECK: annotate-comments.cpp:112:7: FieldDecl=isdoxy26:{{.*}} IS_DOXYGEN_SINGLE315// CHECK: annotate-comments.cpp:116:7: FieldDecl=isdoxy27:{{.*}} IS_DOXYGEN_SINGLE316// CHECK: annotate-comments.cpp:123:6: EnumDecl=isdoxy29:{{.*}} IS_DOXYGEN_SINGLE317// CHECK: annotate-comments.cpp:130:11: Namespace=isdoxy31:{{.*}} IS_DOXYGEN_SINGLE318// CHECK: annotate-comments.cpp:138:7: FieldDecl=isdoxy33:{{.*}} isdoxy33 IS_DOXYGEN_SINGLE319// CHECK: annotate-comments.cpp:139:7: FieldDecl=isdoxy34:{{.*}} isdoxy34 IS_DOXYGEN_SINGLE320// CHECK: annotate-comments.cpp:142:7: FieldDecl=isdoxy35:{{.*}} isdoxy35 IS_DOXYGEN_SINGLE321// CHECK: annotate-comments.cpp:143:7: FieldDecl=isdoxy36:{{.*}} isdoxy36 IS_DOXYGEN_SINGLE322// CHECK: annotate-comments.cpp:146:7: FieldDecl=isdoxy37:{{.*}} isdoxy37 IS_DOXYGEN_SINGLE323// CHECK: annotate-comments.cpp:147:7: FieldDecl=isdoxy38:{{.*}} isdoxy38 IS_DOXYGEN_SINGLE324// CHECK: annotate-comments.cpp:148:7: FieldDecl=isdoxy39:{{.*}} isdoxy39 IS_DOXYGEN_SINGLE325// CHECK: annotate-comments.cpp:155:6: FunctionDecl=isdoxy40:{{.*}} isdoxy40 IS_DOXYGEN_SINGLE326// CHECK: annotate-comments.cpp:160:5: FunctionDecl=isdoxy41:{{.*}} isdoxy41 IS_DOXYGEN_SINGLE327// CHECK: annotate-comments.cpp:163:7: FieldDecl=isdoxy42:{{.*}} isdoxy42 IS_DOXYGEN_SINGLE328// CHECK: annotate-comments.cpp:176:6: FunctionDecl=isdoxy43:{{.*}} IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END329 330// CHECK: annotate-comments.cpp:185:6: FunctionDecl=isdoxy44:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb ccc.]331// CHECK: annotate-comments.cpp:195:6: FunctionDecl=isdoxy45:{{.*}} BriefComment=[Ddd eee. Fff.]332// CHECK: annotate-comments.cpp:205:6: FunctionDecl=isdoxy46:{{.*}} BriefComment=[Ddd eee. Fff.]333// CHECK: annotate-comments.cpp:214:6: FunctionDecl=isdoxy48:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb]334// CHECK: annotate-comments.cpp:218:6: FunctionDecl=isdoxy49:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa]335// CHECK: annotate-comments.cpp:222:6: FunctionDecl=isdoxy50:{{.*}} BriefComment=[Returns ddd IS_DOXYGEN_END]336// CHECK: annotate-comments.cpp:231:6: FunctionDecl=isdoxy51:{{.*}} BriefComment=[Aaa. IS_DOXYGEN_START]337// CHECK: annotate-comments.cpp:241:6: FunctionDecl=isdoxy52:{{.*}} BriefComment=[Aaa. IS_DOXYGEN_START Bbb.]338// CHECK: annotate-comments.cpp:248:6: FunctionDecl=isdoxy53:{{.*}} BriefComment=[Aaa. IS_DOXYGEN_START IS_DOXYGEN_END]339// CHECK: annotate-comments.cpp:255:6: FunctionDecl=isdoxy54:{{.*}} BriefComment=[Aaa. IS_DOXYGEN_START IS_DOXYGEN_END]340