Skip to content

Commit 45081fb

Browse files
evelez7evelez7
authored
[clang-doc] <ul> must be nested in <li> (#168972)
The HTML spec states that only `<li>` can be children of `<ul>`. Nested `<ul>` tags in an unordered list must be children of `<li>`.
1 parent 9a56e55 commit 45081fb

File tree

3 files changed

+80
-62
lines changed

3 files changed

+80
-62
lines changed

‎clang-tools-extra/clang-doc/assets/class-template.mustache‎

Lines changed: 50 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -50,61 +50,71 @@
5050
<li class="sidebar-section">
5151
<a class="sidebar-item" href="#PublicMembers">Public Members</a>
5252
</li>
53-
<ul>
54-
{{#PublicMembers}}
55-
<li class="sidebar-item-container">
56-
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
57-
</li>
58-
{{/PublicMembers}}
59-
</ul>
53+
<li>
54+
<ul>
55+
{{#PublicMembers}}
56+
<li class="sidebar-item-container">
57+
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
58+
</li>
59+
{{/PublicMembers}}
60+
</ul>
61+
</li>
6062
{{/HasPublicMembers}}
6163
{{#ProtectedMembers}}
62-
<li class="sidebar-section">
63-
<a class="sidebar-item" href="#PublicMethods">Protected Members</a>
64-
</li>
64+
<li class="sidebar-section">
65+
<a class="sidebar-item" href="#PublicMethods">Protected Members</a>
66+
</li>
67+
<li>
6568
<ul>
6669
{{#Obj}}
6770
<li class="sidebar-item-container">
6871
<a class="sidebar-item" href="#{{Name}}">{{Name}}</a>
6972
</li>
7073
{{/Obj}}
7174
</ul>
75+
</li>
7276
{{/ProtectedMembers}}
7377
{{#HasPublicFunctions}}
7478
<li class="sidebar-section">
7579
<a class="sidebar-item" href="#PublicMethods">Public Method</a>
7680
</li>
77-
<ul>
78-
{{#PublicFunctions}}
79-
<li class="sidebar-item-container">
80-
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
81-
</li>
82-
{{/PublicFunctions}}
83-
</ul>
81+
<li>
82+
<ul>
83+
{{#PublicFunctions}}
84+
<li class="sidebar-item-container">
85+
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
86+
</li>
87+
{{/PublicFunctions}}
88+
</ul>
89+
</li>
8490
{{/HasPublicFunctions}}
8591
{{#ProtectedFunction}}
8692
<li class="sidebar-section">
8793
<a class="sidebar-item" href="#ProtectedFunction">Protected Method</a>
8894
</li>
89-
<ul>
90-
{{#Obj}}
91-
<li class="sidebar-item-container">
92-
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
93-
</li>
94-
{{/Obj}}
95-
</ul>
95+
<li>
96+
<ul>
97+
{{#Obj}}
98+
<li class="sidebar-item-container">
99+
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
100+
</li>
101+
{{/Obj}}
102+
</ul>
103+
</li>
96104
{{/ProtectedFunction}}
97105
{{#Enums}}
98106
<li class="sidebar-section">
99107
<a class="sidebar-item" href="#Enums">Enums</a>
100108
</li>
101-
<ul>
102-
{{#Obj}}
103-
<li class="sidebar-item-container">
104-
<a class="sidebar-item" href="#{{USR}}">{{EnumName}}</a>
105-
</li>
106-
{{/Obj}}
107-
</ul>
109+
<li>
110+
<ul>
111+
{{#Obj}}
112+
<li class="sidebar-item-container">
113+
<a class="sidebar-item" href="#{{USR}}">{{EnumName}}</a>
114+
</li>
115+
{{/Obj}}
116+
</ul>
117+
</li>
108118
{{/Enums}}
109119
{{#Typedef}}
110120
<li class="sidebar-section">Typedef</li>
@@ -113,13 +123,15 @@
113123
<li class="sidebar-section">
114124
<a class="sidebar-item" href="#Classes">Inner Classes</a>
115125
</li>
116-
<ul>
117-
{{#Links}}
118-
<li class="sidebar-item-container">
119-
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
120-
</li>
121-
{{/Links}}
122-
</ul>
126+
<li>
127+
<ul>
128+
{{#Links}}
129+
<li class="sidebar-item-container">
130+
<a class="sidebar-item" href="#{{ID}}">{{Name}}</a>
131+
</li>
132+
{{/Links}}
133+
</ul>
134+
</li>
123135
{{/Record}}
124136
</ul>
125137
</div>

‎clang-tools-extra/clang-doc/assets/namespace-template.mustache‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -50,25 +50,29 @@
5050
<li class="sidebar-section">
5151
<a class="sidebar-item" href="#Enums">Enums</a>
5252
</li>
53-
<ul>
54-
{{#Enums}}
55-
<li class="sidebar-item-container">
56-
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
57-
</li>
58-
{{/Enums}}
59-
</ul>
53+
<li>
54+
<ul>
55+
{{#Enums}}
56+
<li class="sidebar-item-container">
57+
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
58+
</li>
59+
{{/Enums}}
60+
</ul>
61+
</li>
6062
{{/HasEnums}}
6163
{{#HasRecords}}
6264
<li class="sidebar-section">
6365
<a class="sidebar-item" href="#Classes">Inner Classes</a>
6466
</li>
65-
<ul>
66-
{{#Records}}
67-
<li class="sidebar-item-container">
68-
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
69-
</li>
70-
{{/Records}}
71-
</ul>
67+
<li>
68+
<ul>
69+
{{#Records}}
70+
<li class="sidebar-item-container">
71+
<a class="sidebar-item" href="#{{USR}}">{{Name}}</a>
72+
</li>
73+
{{/Records}}
74+
</ul>
75+
</li>
7276
{{/HasRecrods}}
7377
</ul>
7478
</div>

‎clang-tools-extra/test/clang-doc/mustache-index.cpp‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,21 @@ class Foo;
1313
// CHECK: <li class="sidebar-section">
1414
// CHECK-NEXT: <a class="sidebar-item" href="#Enums">Enums</a>
1515
// CHECK-NEXT: </li>
16-
// CHECK-NEXT: <ul>
17-
// CHECK-NEXT: <li class="sidebar-item-container">
18-
// CHECK-NEXT: <a class="sidebar-item" href="#{{[0-9A-F]*}}">Color</a>
19-
// CHECK-NEXT: </li>
20-
// CHECK-NEXT: </ul>
16+
// CHECK-NEXT: <li>
17+
// CHECK-NEXT: <ul>
18+
// CHECK-NEXT: <li class="sidebar-item-container">
19+
// CHECK-NEXT: <a class="sidebar-item" href="#{{[0-9A-F]*}}">Color</a>
20+
// CHECK-NEXT: </li>
21+
// CHECK-NEXT: </ul>
2122
// CHECK: <li class="sidebar-section">
2223
// CHECK-NEXT: <a class="sidebar-item" href="#Classes">Inner Classes</a>
2324
// CHECK-NEXT: </li>
24-
// CHECK-NEXT: <ul>
25-
// CHECK-NEXT: <li class="sidebar-item-container">
26-
// CHECK-NEXT: <a class="sidebar-item" href="#{{[0-9A-F]*}}">Foo</a>
27-
// CHECK-NEXT: </li>
28-
// CHECK-NEXT: </ul>
25+
// CHECK-NEXT: <li>
26+
// CHECK-NEXT: <ul>
27+
// CHECK-NEXT: <li class="sidebar-item-container">
28+
// CHECK-NEXT: <a class="sidebar-item" href="#{{[0-9A-F]*}}">Foo</a>
29+
// CHECK-NEXT: </li>
30+
// CHECK-NEXT: </ul>
2931

3032
// CHECK: <section id="Enums" class="section-container">
3133
// CHECK-NEXT: <h2>Enumerations</h2>

0 commit comments

Comments
 (0)