1 // Run lines are sensitive to line numbers and come below the code. 2 3 #ifndef HEADER 4 #define HEADER 5 6 // Not a Doxygen comment. NOT_DOXYGEN 7 void notdoxy1(void); 8 9 /* Not a Doxygen comment. NOT_DOXYGEN */ 10 void notdoxy2(void); 11 12 /*/ Not a Doxygen comment. NOT_DOXYGEN */ 13 void notdoxy3(void); 14 15 /** Doxygen comment. isdoxy4 IS_DOXYGEN_SINGLE */ 16 void isdoxy4(void); 17 18 /** 19 * Doxygen comment. isdoxy5 IS_DOXYGEN_SINGLE */ 20 void isdoxy5(void); 21 22 /** 23 * Doxygen comment. 24 * isdoxy6 IS_DOXYGEN_SINGLE */ 25 void isdoxy6(void); 26 27 /** 28 * Doxygen comment. 29 * isdoxy7 IS_DOXYGEN_SINGLE 30 */ 31 void isdoxy7(void); 32 33 /*! Doxygen comment. isdoxy8 IS_DOXYGEN_SINGLE */ 34 void isdoxy8(void); 35 36 /// Doxygen comment. isdoxy9 IS_DOXYGEN_SINGLE 37 void isdoxy9(void); 38 39 // Not a Doxygen comment. NOT_DOXYGEN 40 /// Doxygen comment. isdoxy10 IS_DOXYGEN_SINGLE 41 void isdoxy10(void); 42 43 /// Doxygen comment. isdoxy11 IS_DOXYGEN_SINGLE 44 // Not a Doxygen comment. NOT_DOXYGEN 45 void isdoxy11(void); 46 47 /** Doxygen comment. isdoxy12 IS_DOXYGEN_SINGLE */ 48 /* Not a Doxygen comment. NOT_DOXYGEN */ 49 void isdoxy12(void); 50 51 /// Doxygen comment. isdoxy13 IS_DOXYGEN_START 52 /// Doxygen comment. IS_DOXYGEN_END 53 void isdoxy13(void); 54 55 /// Doxygen comment. isdoxy14 IS_DOXYGEN_START 56 /// Blah-blah-blah. 57 /// Doxygen comment. IS_DOXYGEN_END 58 void isdoxy14(void); 59 60 /// Doxygen comment. isdoxy15 IS_DOXYGEN_START 61 /** Blah-blah-blah */ 62 /// Doxygen comment. IS_DOXYGEN_END 63 void isdoxy15(void); 64 65 /** Blah-blah-blah. isdoxy16 IS_DOXYGEN_START *//** Blah */ 66 /// Doxygen comment. IS_DOXYGEN_END 67 void isdoxy16(void); 68 69 /// isdoxy17 IS_DOXYGEN_START 70 // Not a Doxygen comment, but still picked up. 71 /// IS_DOXYGEN_END 72 void isdoxy17(void); 73 74 unsigned 75 // NOT_DOXYGEN 76 /// isdoxy18 IS_DOXYGEN_START 77 // Not a Doxygen comment, but still picked up. 78 /// IS_DOXYGEN_END 79 // NOT_DOXYGEN 80 int isdoxy18(void); 81 82 //! It all starts here. isdoxy19 IS_DOXYGEN_START 83 /*! It's a little odd to continue line this, 84 * 85 * but we need more multi-line comments. */ 86 /// This comment comes before my other comments 87 /** This is a block comment that is associated with the function f. It 88 * runs for three lines. IS_DOXYGEN_END 89 */ 90 void isdoxy19(int, int); 91 92 // NOT IN THE COMMENT NOT_DOXYGEN 93 /// This is a BCPL comment. isdoxy20 IS_DOXYGEN_START 94 /// It has only two lines. 95 /** But there are other blocks that are part of the comment, too. IS_DOXYGEN_END */ 96 void isdoxy20(int); 97 98 void isdoxy21(int); ///< This is a member comment. isdoxy21 IS_DOXYGEN_SINGLE 99 100 void isdoxy22(int); /*!< This is a member comment. isdoxy22 IS_DOXYGEN_SINGLE */ 101 102 void isdoxy23(int); /**< This is a member comment. isdoxy23 IS_DOXYGEN_SINGLE */ 103 104 void notdoxy24(int); // NOT_DOXYGEN 105 106 /// IS_DOXYGEN_SINGLE 107 struct isdoxy25 { 108 }; 109 110 struct test26 { 111 /// IS_DOXYGEN_SINGLE 112 int isdoxy26; 113 }; 114 115 struct test27 { 116 int isdoxy27; ///< IS_DOXYGEN_SINGLE 117 }; 118 119 struct notdoxy28 { 120 }; ///< IS_DOXYGEN_NOT_ATTACHED 121 122 /// IS_DOXYGEN_SINGLE 123 enum isdoxy29 { 124 }; 125 126 enum notdoxy30 { 127 }; ///< IS_DOXYGEN_NOT_ATTACHED 128 129 /// IS_DOXYGEN_SINGLE 130 namespace isdoxy31 { 131 }; 132 133 namespace notdoxy32 { 134 }; ///< IS_DOXYGEN_NOT_ATTACHED 135 136 class test33 { 137 ///< IS_DOXYGEN_NOT_ATTACHED 138 int isdoxy33; ///< isdoxy33 IS_DOXYGEN_SINGLE 139 int isdoxy34; ///< isdoxy34 IS_DOXYGEN_SINGLE 140 141 ///< IS_DOXYGEN_NOT_ATTACHED 142 int isdoxy35, ///< isdoxy35 IS_DOXYGEN_SINGLE 143 isdoxy36; ///< isdoxy36 IS_DOXYGEN_SINGLE 144 145 ///< IS_DOXYGEN_NOT_ATTACHED 146 int isdoxy37 ///< isdoxy37 IS_DOXYGEN_SINGLE 147 , isdoxy38 ///< isdoxy38 IS_DOXYGEN_SINGLE 148 , isdoxy39; ///< isdoxy39 IS_DOXYGEN_SINGLE 149 }; 150 151 // Verified that Doxygen attaches these. 152 153 /// isdoxy40 IS_DOXYGEN_SINGLE 154 // NOT_DOXYGEN 155 void isdoxy40(int); 156 157 unsigned 158 /// isdoxy41 IS_DOXYGEN_SINGLE 159 // NOT_DOXYGEN 160 int isdoxy41(int); 161 162 class test42 { 163 int isdoxy42; /* NOT_DOXYGEN */ ///< isdoxy42 IS_DOXYGEN_SINGLE 164 }; 165 166 /// IS_DOXYGEN_START 167 /// It is fine to have a command at the end of comment. 168 ///\brief 169 /// 170 /// Some malformed command. 171 /* \*/ 172 /** 173 * \brief Aaa aaaaaaa aaaa. 174 * IS_DOXYGEN_END 175 */ 176 void isdoxy43(void); 177 178 /// IS_DOXYGEN_START Aaa bbb 179 /// ccc. 180 /// 181 /// Ddd eee. 182 /// Fff. 183 /// 184 /// Ggg. IS_DOXYGEN_END 185 void isdoxy44(void); 186 187 /// IS_DOXYGEN_START Aaa bbb 188 /// ccc. 189 /// 190 /// \brief 191 /// Ddd eee. 192 /// Fff. 193 /// 194 /// Ggg. IS_DOXYGEN_END 195 void isdoxy45(void); 196 197 /// IS_DOXYGEN_NOT_ATTACHED 198 #define FOO 199 void notdoxy46(void); 200 201 /// IS_DOXYGEN_START Aaa bbb 202 /// \param ccc 203 /// \returns ddd IS_DOXYGEN_END 204 void isdoxy47(int); 205 206 #endif 207 208 // RUN: rm -rf %t 209 // RUN: mkdir %t 210 // RUN: %clang_cc1 -x c++ -emit-pch -o %t/out.pch %s 211 // RUN: %clang_cc1 -x c++ -include-pch %t/out.pch -fsyntax-only %s 212 213 // RUN: c-index-test -test-load-source all %s > %t/out.c-index-direct 214 // RUN: c-index-test -test-load-tu %t/out.pch all > %t/out.c-index-pch 215 216 // RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-direct 217 // RUN: FileCheck %s -check-prefix=WRONG < %t/out.c-index-pch 218 219 // Declarations without Doxygen comments should not pick up some Doxygen comments. 220 // WRONG-NOT: notdoxy{{.*}}Comment= 221 // WRONG-NOT: test{{.*}}Comment= 222 223 // Non-Doxygen comments should not be attached to anything. 224 // WRONG-NOT: NOT_DOXYGEN 225 226 // Some Doxygen comments are not attached to anything. 227 // WRONG-NOT: IS_DOXYGEN_NOT_ATTACHED 228 229 // Ensure we don't pick up extra comments. 230 // WRONG-NOT: IS_DOXYGEN_START{{.*}}IS_DOXYGEN_START{{.*}}BriefComment= 231 // WRONG-NOT: IS_DOXYGEN_END{{.*}}IS_DOXYGEN_END{{.*}}BriefComment= 232 233 // RUN: FileCheck %s < %t/out.c-index-direct 234 // RUN: FileCheck %s < %t/out.c-index-pch 235 236 // CHECK: annotate-comments.cpp:16:6: FunctionDecl=isdoxy4:{{.*}} isdoxy4 IS_DOXYGEN_SINGLE 237 // CHECK: annotate-comments.cpp:20:6: FunctionDecl=isdoxy5:{{.*}} isdoxy5 IS_DOXYGEN_SINGLE 238 // CHECK: annotate-comments.cpp:25:6: FunctionDecl=isdoxy6:{{.*}} isdoxy6 IS_DOXYGEN_SINGLE 239 // CHECK: annotate-comments.cpp:31:6: FunctionDecl=isdoxy7:{{.*}} isdoxy7 IS_DOXYGEN_SINGLE 240 // CHECK: annotate-comments.cpp:34:6: FunctionDecl=isdoxy8:{{.*}} isdoxy8 IS_DOXYGEN_SINGLE 241 // CHECK: annotate-comments.cpp:37:6: FunctionDecl=isdoxy9:{{.*}} isdoxy9 IS_DOXYGEN_SINGLE 242 // CHECK: annotate-comments.cpp:41:6: FunctionDecl=isdoxy10:{{.*}} isdoxy10 IS_DOXYGEN_SINGLE 243 // CHECK: annotate-comments.cpp:53:6: FunctionDecl=isdoxy13:{{.*}} isdoxy13 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 244 // CHECK: annotate-comments.cpp:58:6: FunctionDecl=isdoxy14:{{.*}} isdoxy14 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 245 // CHECK: annotate-comments.cpp:63:6: FunctionDecl=isdoxy15:{{.*}} isdoxy15 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 246 // CHECK: annotate-comments.cpp:67:6: FunctionDecl=isdoxy16:{{.*}} isdoxy16 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 247 // CHECK: annotate-comments.cpp:72:6: FunctionDecl=isdoxy17:{{.*}} isdoxy17 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 248 // CHECK: annotate-comments.cpp:80:5: FunctionDecl=isdoxy18:{{.*}} isdoxy18 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 249 // CHECK: annotate-comments.cpp:90:6: FunctionDecl=isdoxy19:{{.*}} isdoxy19 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 250 // CHECK: annotate-comments.cpp:96:6: FunctionDecl=isdoxy20:{{.*}} isdoxy20 IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 251 // CHECK: annotate-comments.cpp:98:6: FunctionDecl=isdoxy21:{{.*}} isdoxy21 IS_DOXYGEN_SINGLE 252 // CHECK: annotate-comments.cpp:100:6: FunctionDecl=isdoxy22:{{.*}} isdoxy22 IS_DOXYGEN_SINGLE 253 // CHECK: annotate-comments.cpp:102:6: FunctionDecl=isdoxy23:{{.*}} isdoxy23 IS_DOXYGEN_SINGLE 254 // CHECK: annotate-comments.cpp:107:8: StructDecl=isdoxy25:{{.*}} IS_DOXYGEN_SINGLE 255 // CHECK: annotate-comments.cpp:112:7: FieldDecl=isdoxy26:{{.*}} IS_DOXYGEN_SINGLE 256 // CHECK: annotate-comments.cpp:116:7: FieldDecl=isdoxy27:{{.*}} IS_DOXYGEN_SINGLE 257 // CHECK: annotate-comments.cpp:123:6: EnumDecl=isdoxy29:{{.*}} IS_DOXYGEN_SINGLE 258 // CHECK: annotate-comments.cpp:130:11: Namespace=isdoxy31:{{.*}} IS_DOXYGEN_SINGLE 259 // CHECK: annotate-comments.cpp:138:7: FieldDecl=isdoxy33:{{.*}} isdoxy33 IS_DOXYGEN_SINGLE 260 // CHECK: annotate-comments.cpp:139:7: FieldDecl=isdoxy34:{{.*}} isdoxy34 IS_DOXYGEN_SINGLE 261 // CHECK: annotate-comments.cpp:142:7: FieldDecl=isdoxy35:{{.*}} isdoxy35 IS_DOXYGEN_SINGLE 262 // CHECK: annotate-comments.cpp:143:7: FieldDecl=isdoxy36:{{.*}} isdoxy36 IS_DOXYGEN_SINGLE 263 // CHECK: annotate-comments.cpp:146:7: FieldDecl=isdoxy37:{{.*}} isdoxy37 IS_DOXYGEN_SINGLE 264 // CHECK: annotate-comments.cpp:147:7: FieldDecl=isdoxy38:{{.*}} isdoxy38 IS_DOXYGEN_SINGLE 265 // CHECK: annotate-comments.cpp:148:7: FieldDecl=isdoxy39:{{.*}} isdoxy39 IS_DOXYGEN_SINGLE 266 // CHECK: annotate-comments.cpp:155:6: FunctionDecl=isdoxy40:{{.*}} isdoxy40 IS_DOXYGEN_SINGLE 267 // CHECK: annotate-comments.cpp:160:5: FunctionDecl=isdoxy41:{{.*}} isdoxy41 IS_DOXYGEN_SINGLE 268 // CHECK: annotate-comments.cpp:163:7: FieldDecl=isdoxy42:{{.*}} isdoxy42 IS_DOXYGEN_SINGLE 269 // CHECK: annotate-comments.cpp:176:6: FunctionDecl=isdoxy43:{{.*}} IS_DOXYGEN_START{{.*}} IS_DOXYGEN_END 270 271 // CHECK: annotate-comments.cpp:185:6: FunctionDecl=isdoxy44:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb ccc.] 272 // CHECK: annotate-comments.cpp:195:6: FunctionDecl=isdoxy45:{{.*}} BriefComment=[Ddd eee. Fff.] 273 // CHECK: annotate-comments.cpp:204:6: FunctionDecl=isdoxy47:{{.*}} BriefComment=[IS_DOXYGEN_START Aaa bbb] 274 275