annotate-comments.cpp revision 659a7124c7069b3e01dd171f7290562f58f9e97a
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 7void 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_SINGLE 30 */ 31void isdoxy7(void); 32 33/*! Doxygen comment. isdoxy8 IS_DOXYGEN_SINGLE */ 34void isdoxy8(void); 35 36/// Doxygen comment. isdoxy9 IS_DOXYGEN_SINGLE 37void isdoxy9(void); 38 39// Not a Doxygen comment. NOT_DOXYGEN 40/// Doxygen comment. isdoxy10 IS_DOXYGEN_SINGLE 41void isdoxy10(void); 42 43/// Doxygen comment. isdoxy11 IS_DOXYGEN_SINGLE 44// Not a Doxygen comment. NOT_DOXYGEN 45void 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_START 52/// Doxygen comment. IS_DOXYGEN_END 53void isdoxy13(void); 54 55/// Doxygen comment. isdoxy14 IS_DOXYGEN_START 56/// Blah-blah-blah. 57/// Doxygen comment. IS_DOXYGEN_END 58void isdoxy14(void); 59 60/// Doxygen comment. isdoxy15 IS_DOXYGEN_START 61/** Blah-blah-blah */ 62/// Doxygen comment. IS_DOXYGEN_END 63void isdoxy15(void); 64 65/** Blah-blah-blah. isdoxy16 IS_DOXYGEN_START *//** Blah */ 66/// Doxygen comment. IS_DOXYGEN_END 67void isdoxy16(void); 68 69/// isdoxy17 IS_DOXYGEN_START 70// Not a Doxygen comment, but still picked up. 71/// IS_DOXYGEN_END 72void isdoxy17(void); 73 74unsigned 75// NOT_DOXYGEN 76/// isdoxy18 IS_DOXYGEN_START 77// Not a Doxygen comment, but still picked up. 78/// IS_DOXYGEN_END 79// NOT_DOXYGEN 80int 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 */ 90void 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 */ 96void isdoxy20(int); 97 98void notdoxy21(int); ///< This is a member comment. isdoxy21 IS_DOXYGEN_NOT_ATTACHED 99 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_DOXYGEN 105 106/// IS_DOXYGEN_SINGLE 107struct isdoxy25 { 108}; 109 110struct test26 { 111 /// IS_DOXYGEN_SINGLE 112 int isdoxy26; 113}; 114 115struct test27 { 116 int isdoxy27; ///< IS_DOXYGEN_SINGLE 117}; 118 119struct notdoxy28 { 120}; ///< IS_DOXYGEN_NOT_ATTACHED 121 122/// IS_DOXYGEN_SINGLE 123enum isdoxy29 { 124}; 125 126enum notdoxy30 { 127}; ///< IS_DOXYGEN_NOT_ATTACHED 128 129/// IS_DOXYGEN_SINGLE 130namespace isdoxy31 { 131}; 132 133namespace notdoxy32 { 134}; ///< IS_DOXYGEN_NOT_ATTACHED 135 136class 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 155void isdoxy40(int); 156 157unsigned 158/// isdoxy41 IS_DOXYGEN_SINGLE 159// NOT_DOXYGEN 160int isdoxy41(int); 161 162class 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 */ 176void isdoxy43(void); 177 178/// IS_DOXYGEN_START Aaa bbb 179/// ccc. 180/// 181/// Ddd eee. 182/// Fff. 183/// 184/// Ggg. IS_DOXYGEN_END 185void 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 195void 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 205void isdoxy46(void); 206 207/// IS_DOXYGEN_NOT_ATTACHED 208#define FOO 209void notdoxy47(void); 210 211/// IS_DOXYGEN_START Aaa bbb 212/// \param ccc 213/// \returns ddd IS_DOXYGEN_END 214void isdoxy48(int); 215 216#endif 217 218// RUN: rm -rf %t 219// RUN: mkdir %t 220// RUN: %clang_cc1 -x c++ -emit-pch -o %t/out.pch %s 221// RUN: %clang_cc1 -x c++ -include-pch %t/out.pch -fsyntax-only %s 222 223// RUN: c-index-test -test-load-source all %s > %t/out.c-index-direct 224// RUN: c-index-test -test-load-tu %t/out.pch all > %t/out.c-index-pch 225 226// RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-direct 227// RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-pch 228 229// Declarations without Doxygen comments should not pick up some Doxygen comments. 230// WRONG-NOT: notdoxy{{.*}}Comment= 231// WRONG-NOT: test{{.*}}Comment= 232 233// Non-Doxygen comments should not be attached to anything. 234// WRONG-NOT: NOT_DOXYGEN 235 236// Some Doxygen comments are not attached to anything. 237// WRONG-NOT: IS_DOXYGEN_NOT_ATTACHED 238 239// Ensure we don't pick up extra comments. 240// WRONG-NOT: IS_DOXYGEN_START{{.*}}IS_DOXYGEN_START{{.*}}BriefComment= 241// WRONG-NOT: IS_DOXYGEN_END{{.*}}IS_DOXYGEN_END{{.*}}BriefComment= 242 243// RUN: FileCheck %s < %t/out.c-index-direct 244// RUN: FileCheck %s < %t/out.c-index-pch 245 246// CHECK: annotate-comments.cpp:16:6: FunctionDecl=isdoxy4:{{.*}} isdoxy4 IS_DOXYGEN_SINGLE 247// CHECK: annotate-comments.cpp:20:6: FunctionDecl=isdoxy5:{{.*}} isdoxy5 IS_DOXYGEN_SINGLE 248// CHECK: annotate-comments.cpp:25:6: FunctionDecl=isdoxy6:{{.*}} isdoxy6 IS_DOXYGEN_SINGLE 249// CHECK: annotate-comments.cpp:31:6: FunctionDecl=isdoxy7:{{.*}} isdoxy7 IS_DOXYGEN_SINGLE 250// CHECK: annotate-comments.cpp:34:6: FunctionDecl=isdoxy8:{{.*}} isdoxy8 IS_DOXYGEN_SINGLE 251// CHECK: annotate-comments.cpp:37:6: FunctionDecl=isdoxy9:{{.*}} isdoxy9 IS_DOXYGEN_SINGLE 252// CHECK: annotate-comments.cpp:41:6: FunctionDecl=isdoxy10:{{.*}} isdoxy10 IS_DOXYGEN_SINGLE 253// CHECK: annotate-comments.cpp:53:6: FunctionDecl=isdoxy13:{{.*}} isdoxy13 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 254// CHECK: annotate-comments.cpp:58:6: FunctionDecl=isdoxy14:{{.*}} isdoxy14 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 255// CHECK: annotate-comments.cpp:63:6: FunctionDecl=isdoxy15:{{.*}} isdoxy15 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 256// CHECK: annotate-comments.cpp:67:6: FunctionDecl=isdoxy16:{{.*}} isdoxy16 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 257// CHECK: annotate-comments.cpp:72:6: FunctionDecl=isdoxy17:{{.*}} isdoxy17 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 258// CHECK: annotate-comments.cpp:80:5: FunctionDecl=isdoxy18:{{.*}} isdoxy18 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 259// CHECK: annotate-comments.cpp:90:6: FunctionDecl=isdoxy19:{{.*}} isdoxy19 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 260// CHECK: annotate-comments.cpp:96:6: FunctionDecl=isdoxy20:{{.*}} isdoxy20 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 261// CHECK: annotate-comments.cpp:107:8: StructDecl=isdoxy25:{{.*}} IS_DOXYGEN_SINGLE 262// CHECK: annotate-comments.cpp:112:7: FieldDecl=isdoxy26:{{.*}} IS_DOXYGEN_SINGLE 263// CHECK: annotate-comments.cpp:116:7: FieldDecl=isdoxy27:{{.*}} IS_DOXYGEN_SINGLE 264// CHECK: annotate-comments.cpp:123:6: EnumDecl=isdoxy29:{{.*}} IS_DOXYGEN_SINGLE 265// CHECK: annotate-comments.cpp:130:11: Namespace=isdoxy31:{{.*}} IS_DOXYGEN_SINGLE 266// CHECK: annotate-comments.cpp:138:7: FieldDecl=isdoxy33:{{.*}} isdoxy33 IS_DOXYGEN_SINGLE 267// CHECK: annotate-comments.cpp:139:7: FieldDecl=isdoxy34:{{.*}} isdoxy34 IS_DOXYGEN_SINGLE 268// CHECK: annotate-comments.cpp:142:7: FieldDecl=isdoxy35:{{.*}} isdoxy35 IS_DOXYGEN_SINGLE 269// CHECK: annotate-comments.cpp:143:7: FieldDecl=isdoxy36:{{.*}} isdoxy36 IS_DOXYGEN_SINGLE 270// CHECK: annotate-comments.cpp:146:7: FieldDecl=isdoxy37:{{.*}} isdoxy37 IS_DOXYGEN_SINGLE 271// CHECK: annotate-comments.cpp:147:7: FieldDecl=isdoxy38:{{.*}} isdoxy38 IS_DOXYGEN_SINGLE 272// CHECK: annotate-comments.cpp:148:7: FieldDecl=isdoxy39:{{.*}} isdoxy39 IS_DOXYGEN_SINGLE 273// CHECK: annotate-comments.cpp:155:6: FunctionDecl=isdoxy40:{{.*}} isdoxy40 IS_DOXYGEN_SINGLE 274// CHECK: annotate-comments.cpp:160:5: FunctionDecl=isdoxy41:{{.*}} isdoxy41 IS_DOXYGEN_SINGLE 275// CHECK: annotate-comments.cpp:163:7: FieldDecl=isdoxy42:{{.*}} isdoxy42 IS_DOXYGEN_SINGLE 276// CHECK: annotate-comments.cpp:176:6: FunctionDecl=isdoxy43:{{.*}} IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 277 278// CHECK: annotate-comments.cpp:185:6: FunctionDecl=isdoxy44:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb ccc.] 279// CHECK: annotate-comments.cpp:195:6: FunctionDecl=isdoxy45:{{.*}} BriefComment=[Ddd eee. Fff.] 280// CHECK: annotate-comments.cpp:205:6: FunctionDecl=isdoxy46:{{.*}} BriefComment=[Ddd eee. Fff.] 281// CHECK: annotate-comments.cpp:214:6: FunctionDecl=isdoxy48:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb] 282 283