Skip to content

Commit f756c39

Browse files
PeterChou1PeterChou1
committed
[clang-doc] fix up enum test cases
1 parent cd98a8c commit f756c39

File tree

1 file changed

+113
-17
lines changed
  • clang-tools-extra/test/clang-doc

1 file changed

+113
-17
lines changed

‎clang-tools-extra/test/clang-doc/enum.cpp

Lines changed: 113 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,13 @@
22
// RUN: clang-doc --format=html --doxygen --output=%t --executor=standalone %s
33
// RUN: clang-doc --format=md --doxygen --output=%t --executor=standalone %s
44
// RUN: FileCheck %s < %t/GlobalNamespace/index.html -check-prefix=HTML-INDEX
5+
// RUN: FileCheck %s < %t/GlobalNamespace/Animals.html -check-prefix=HTML-ANIMAL
6+
// RUN: FileCheck %s < %t/Vehicles/index.html -check-prefix=HTML-VEHICLES
57
// RUN: FileCheck %s < %t/GlobalNamespace/index.md -check-prefix=MD-INDEX
8+
// RUN: FileCheck %s < %t/GlobalNamespace/Animals.md -check-prefix=MD-ANIMAL
9+
// RUN: FileCheck %s < %t/Vehicles/index.md -check-prefix=MD-VEHICLES
610

7-
/**
8-
* @brief For specifying RGB colors
9-
*/
10-
enum Color {
11-
Red,
12-
Green,
13-
Blue
14-
};
1511

16-
// HTML-INDEX: <h1>Global Namespace</h1>
17-
// HTML-INDEX: <h2 id="Enums">Enums</h2>
18-
// HTML-INDEX: <h3 id="{{([0-9A-F]{40})}}">enum Color</h3>
19-
// HTML-INDEX: <li>Red</li>
20-
// HTML-INDEX: <li>Green</li>
21-
// HTML-INDEX: <li>Blue</li>
22-
// HTML-INDEX: <p>Defined at line 10 of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
2312

2413
// MD-INDEX: # Global Namespace
2514
// MD-INDEX: ## Enums
@@ -28,5 +17,112 @@ enum Color {
2817
// MD-INDEX: | Red |
2918
// MD-INDEX: | Green |
3019
// MD-INDEX: | Blue |
31-
// MD-INDEX: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#10*
32-
// MD-INDEX: **brief** For specifying RGB colors
20+
// MD-INDEX: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE+13]]*
21+
// MD-INDEX: **brief** For specifying RGB colors
22+
23+
// HTML-INDEX: <h1>Global Namespace</h1>
24+
// HTML-INDEX: <h2 id="Enums">Enums</h2>
25+
// HTML-INDEX: <h3 id="{{([0-9A-F]{40})}}">enum Color</h3>
26+
// HTML-INDEX: <li>Red</li>
27+
// HTML-INDEX: <li>Green</li>
28+
// HTML-INDEX: <li>Blue</li>
29+
// HTML-INDEX: <p>Defined at line [[@LINE+4]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
30+
/**
31+
* @brief For specifying RGB colors
32+
*/
33+
enum Color {
34+
Red, ///< Red
35+
Green, ///< Green
36+
Blue ///< Blue
37+
};
38+
39+
40+
// MD-INDEX: | enum class Shapes |
41+
// MD-INDEX: --
42+
// MD-INDEX: | Circle |
43+
// MD-INDEX: | Rectangle |
44+
// MD-INDEX: | Triangle |
45+
// MD-INDEX: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE+11]]*
46+
// MD-INDEX: **brief** Shape Types
47+
48+
// HTML-INDEX: <h3 id="{{([0-9A-F]{40})}}">enum class Shapes</h3>
49+
// HTML-INDEX: <li>Circle</li>
50+
// HTML-INDEX: <li>Rectangle</li>
51+
// HTML-INDEX: <li>Triangle</li>
52+
// HTML-INDEX: <p>Defined at line [[@LINE+4]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
53+
/**
54+
* @brief Shape Types
55+
*/
56+
enum class Shapes {
57+
/// Circle
58+
Circle,
59+
/// Rectangle
60+
Rectangle,
61+
/// Triangle
62+
Triangle
63+
};
64+
65+
66+
// MD-ANIMAL: # class Animals
67+
// MD-ANIMAL: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE+18]]*
68+
// MD-ANIMAL: ## Enums
69+
// MD-ANIMAL: | enum AnimalType |
70+
// MD-ANIMAL: --
71+
// MD-ANIMAL: | Dog |
72+
// MD-ANIMAL: | Cat |
73+
// MD-ANIMAL: | Iguana |
74+
// MD-ANIMAL: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE+16]]*
75+
// MD-ANIMAL: **brief** specify what animal the class is
76+
77+
// HTML-ANIMAL: <h1>class Animals</h1>
78+
// HTML-ANIMAL: <p>Defined at line [[@LINE+7]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
79+
// HTML-ANIMAL: <h2 id="Enums">Enums</h2>
80+
// HTML-ANIMAL: <h3 id="{{([0-9A-F]{40})}}">enum AnimalType</h3>
81+
// HTML-ANIMAL: <li>Dog</li>
82+
// HTML-ANIMAL: <li>Cat</li>
83+
// HTML-ANIMAL: <li>Iguana</li>
84+
// HTML-ANIMAL: <p>Defined at line [[@LINE+6]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
85+
class Animals {
86+
public:
87+
/**
88+
* @brief specify what animal the class is
89+
*/
90+
enum AnimalType {
91+
Dog, /// Man's best friend
92+
Cat, /// Man's other best friend
93+
Iguana /// A lizard
94+
};
95+
};
96+
97+
98+
99+
// MD-VEHICLES: # namespace Vehicles
100+
// MD-VEHICLES: ## Enums
101+
// MD-VEHICLES: | enum Car |
102+
// MD-VEHICLES: --
103+
// MD-VEHICLES: | Sedan |
104+
// MD-VEHICLES: | SUV |
105+
// MD-VEHICLES: | Pickup |
106+
// MD-VEHICLES: | Hatchback |
107+
// MD-VEHICLES: *Defined at {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp#[[@LINE+15]]*
108+
// MD-VEHICLES: **brief** specify type of car
109+
110+
// HTML-VEHICLES: <h1>namespace Vehicles</h1>
111+
// HTML-VEHICLES: <h2 id="Enums">Enums</h2>
112+
// HTML-VEHICLES: <h3 id="{{([0-9A-F]{40})}}">enum Car</h3>
113+
// HTML-VEHICLES: <li>Sedan</li>
114+
// HTML-VEHICLES: <li>SUV</li>
115+
// HTML-VEHICLES: <li>Pickup</li>
116+
// HTML-VEHICLES: <li>Hatchback</li>
117+
// HTML-VEHICLES: <p>Defined at line [[@LINE+5]] of file {{.*}}clang-tools-extra{{[\/]}}test{{[\/]}}clang-doc{{[\/]}}enum.cpp</p>
118+
namespace Vehicles {
119+
/**
120+
* @brief specify type of car
121+
*/
122+
enum Car {
123+
Sedan, /// Sedan
124+
SUV, /// SUV
125+
Pickup, /// Pickup
126+
Hatchback /// Hatchback
127+
};
128+
}

0 commit comments

Comments
 (0)