Skip to content

Commit b24a3fd

Browse files
Sunshine40lcnr
Sunshine40
authored and
lcnr
committed
Add test for PR rust-lang#126057 
1 parent 4722990 commit b24a3fd

File tree

6 files changed

+256
-2
lines changed

6 files changed

+256
-2
lines changed

‎src/librustdoc/html/static/js/externs.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ let ParserState;
4141
* foundElems: number,
4242
* totalElems: number,
4343
* literalSearch: boolean,
44-
* corrections: Array<{from: string, to: integer}>,
44+
* corrections: Array<{from: string, to: integer}> | null,
4545
* typeFingerprint: Uint32Array,
46+
* error: Array<string> | null,
4647
* }}
4748
*/
4849
let ParsedQuery;

‎tests/rustdoc-js/basic.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
const EXPECTED = {
22
'query': 'Fo',
33
'others': [
4-
{ 'path': 'basic', 'name': 'Foo' },
4+
{ 'path': 'basic', 'name': 'Foo', 'desc': 'Docs for Foo' },
55
],
66
};

‎tests/rustdoc-js/doc-alias.js‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ const EXPECTED = [
55
{
66
'path': 'doc_alias',
77
'name': 'Struct',
8+
'desc': 'Doc for <code>Struct</code>',
89
'alias': 'StructItem',
910
'href': '../doc_alias/struct.Struct.html',
1011
'is_alias': true
@@ -17,6 +18,7 @@ const EXPECTED = [
1718
{
1819
'path': 'doc_alias::Struct',
1920
'name': 'field',
21+
'desc': 'Doc for <code>Struct</code>’s <code>field</code>',
2022
'alias': 'StructFieldItem',
2123
'href': '../doc_alias/struct.Struct.html#structfield.field',
2224
'is_alias': true
@@ -29,6 +31,7 @@ const EXPECTED = [
2931
{
3032
'path': 'doc_alias::Struct',
3133
'name': 'method',
34+
'desc': 'Doc for <code>Struct::method</code>',
3235
'alias': 'StructMethodItem',
3336
'href': '../doc_alias/struct.Struct.html#method.method',
3437
'is_alias': true
@@ -45,6 +48,7 @@ const EXPECTED = [
4548
{
4649
'path': 'doc_alias::Struct',
4750
'name': 'ImplConstItem',
51+
'desc': 'Doc for <code>Struct::ImplConstItem</code>',
4852
'alias': 'StructImplConstItem',
4953
'href': '../doc_alias/struct.Struct.html#associatedconstant.ImplConstItem',
5054
'is_alias': true
@@ -57,6 +61,7 @@ const EXPECTED = [
5761
{
5862
'path': 'doc_alias::Struct',
5963
'name': 'function',
64+
'desc': 'Doc for <code>Trait::function</code> implemented for Struct',
6065
'alias': 'ImplTraitFunction',
6166
'href': '../doc_alias/struct.Struct.html#method.function',
6267
'is_alias': true
@@ -69,6 +74,7 @@ const EXPECTED = [
6974
{
7075
'path': 'doc_alias',
7176
'name': 'Enum',
77+
'desc': 'Doc for <code>Enum</code>',
7278
'alias': 'EnumItem',
7379
'href': '../doc_alias/enum.Enum.html',
7480
'is_alias': true
@@ -81,6 +87,7 @@ const EXPECTED = [
8187
{
8288
'path': 'doc_alias::Enum',
8389
'name': 'Variant',
90+
'desc': 'Doc for <code>Enum::Variant</code>',
8491
'alias': 'VariantItem',
8592
'href': '../doc_alias/enum.Enum.html#variant.Variant',
8693
'is_alias': true
@@ -93,6 +100,7 @@ const EXPECTED = [
93100
{
94101
'path': 'doc_alias::Enum',
95102
'name': 'method',
103+
'desc': 'Doc for <code>Enum::method</code>',
96104
'alias': 'EnumMethodItem',
97105
'href': '../doc_alias/enum.Enum.html#method.method',
98106
'is_alias': true
@@ -105,6 +113,7 @@ const EXPECTED = [
105113
{
106114
'path': 'doc_alias',
107115
'name': 'Typedef',
116+
'desc': 'Doc for type alias <code>Typedef</code>',
108117
'alias': 'TypedefItem',
109118
'href': '../doc_alias/type.Typedef.html',
110119
'is_alias': true
@@ -117,6 +126,7 @@ const EXPECTED = [
117126
{
118127
'path': 'doc_alias',
119128
'name': 'Trait',
129+
'desc': 'Doc for <code>Trait</code>',
120130
'alias': 'TraitItem',
121131
'href': '../doc_alias/trait.Trait.html',
122132
'is_alias': true
@@ -129,6 +139,7 @@ const EXPECTED = [
129139
{
130140
'path': 'doc_alias::Trait',
131141
'name': 'Target',
142+
'desc': 'Doc for <code>Trait::Target</code>',
132143
'alias': 'TraitTypeItem',
133144
'href': '../doc_alias/trait.Trait.html#associatedtype.Target',
134145
'is_alias': true
@@ -141,6 +152,7 @@ const EXPECTED = [
141152
{
142153
'path': 'doc_alias::Trait',
143154
'name': 'AssociatedConst',
155+
'desc': 'Doc for <code>Trait::AssociatedConst</code>',
144156
'alias': 'AssociatedConstItem',
145157
'href': '../doc_alias/trait.Trait.html#associatedconstant.AssociatedConst',
146158
'is_alias': true
@@ -153,6 +165,7 @@ const EXPECTED = [
153165
{
154166
'path': 'doc_alias::Trait',
155167
'name': 'function',
168+
'desc': 'Doc for <code>Trait::function</code>',
156169
'alias': 'TraitFunctionItem',
157170
'href': '../doc_alias/trait.Trait.html#tymethod.function',
158171
'is_alias': true
@@ -165,6 +178,7 @@ const EXPECTED = [
165178
{
166179
'path': 'doc_alias',
167180
'name': 'function',
181+
'desc': 'Doc for <code>function</code>',
168182
'alias': 'FunctionItem',
169183
'href': '../doc_alias/fn.function.html',
170184
'is_alias': true
@@ -177,6 +191,7 @@ const EXPECTED = [
177191
{
178192
'path': 'doc_alias',
179193
'name': 'Module',
194+
'desc': 'Doc for <code>Module</code>',
180195
'alias': 'ModuleItem',
181196
'href': '../doc_alias/Module/index.html',
182197
'is_alias': true
@@ -189,6 +204,7 @@ const EXPECTED = [
189204
{
190205
'path': 'doc_alias',
191206
'name': 'Const',
207+
'desc': 'Doc for <code>Const</code>',
192208
'alias': 'ConstItem',
193209
'href': '../doc_alias/constant.Const.html',
194210
'is_alias': true
@@ -205,6 +221,7 @@ const EXPECTED = [
205221
{
206222
'path': 'doc_alias',
207223
'name': 'Static',
224+
'desc': 'Doc for <code>Static</code>',
208225
'alias': 'StaticItem',
209226
'href': '../doc_alias/static.Static.html',
210227
'is_alias': true
@@ -217,6 +234,7 @@ const EXPECTED = [
217234
{
218235
'path': 'doc_alias',
219236
'name': 'Union',
237+
'desc': 'Doc for <code>Union</code>',
220238
'alias': 'UnionItem',
221239
'href': '../doc_alias/union.Union.html',
222240
'is_alias': true
@@ -225,6 +243,7 @@ const EXPECTED = [
225243
{
226244
'path': 'doc_alias::Union',
227245
'name': 'union_item',
246+
'desc': 'Doc for <code>Union::union_item</code>',
228247
'href': '../doc_alias/union.Union.html#structfield.union_item'
229248
},
230249
],
@@ -235,6 +254,7 @@ const EXPECTED = [
235254
{
236255
'path': 'doc_alias::Union',
237256
'name': 'union_item',
257+
'desc': 'Doc for <code>Union::union_item</code>',
238258
'alias': 'UnionFieldItem',
239259
'href': '../doc_alias/union.Union.html#structfield.union_item',
240260
'is_alias': true
@@ -247,6 +267,7 @@ const EXPECTED = [
247267
{
248268
'path': 'doc_alias::Union',
249269
'name': 'method',
270+
'desc': 'Doc for <code>Union::method</code>',
250271
'alias': 'UnionMethodItem',
251272
'href': '../doc_alias/union.Union.html#method.method',
252273
'is_alias': true
@@ -259,6 +280,7 @@ const EXPECTED = [
259280
{
260281
'path': 'doc_alias',
261282
'name': 'Macro',
283+
'desc': 'Doc for <code>Macro</code>',
262284
'alias': 'MacroItem',
263285
'href': '../doc_alias/macro.Macro.html',
264286
'is_alias': true

‎tests/rustdoc-js/doc-alias.rs‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1+
/// Doc for `Struct`
12
#[doc(alias = "StructItem")]
23
pub struct Struct {
4+
/// Doc for `Struct`'s `field`
35
#[doc(alias = "StructFieldItem")]
46
pub field: u32,
57
}
68

79
impl Struct {
10+
/// Doc for `Struct::ImplConstItem`
811
#[doc(alias = "StructImplConstItem")]
912
pub const ImplConstItem: i32 = 0;
13+
/// Doc for `Struct::method`
1014
#[doc(alias = "StructMethodItem")]
1115
pub fn method(&self) {}
1216
}
@@ -15,61 +19,78 @@ impl Trait for Struct {
1519
type Target = u32;
1620
const AssociatedConst: i32 = 12;
1721

22+
/// Doc for `Trait::function` implemented for Struct
1823
#[doc(alias = "ImplTraitFunction")]
1924
fn function() -> Self::Target {
2025
0
2126
}
2227
}
2328

29+
/// Doc for `Enum`
2430
#[doc(alias = "EnumItem")]
2531
pub enum Enum {
32+
/// Doc for `Enum::Variant`
2633
#[doc(alias = "VariantItem")]
2734
Variant,
2835
}
2936

3037
impl Enum {
38+
/// Doc for `Enum::method`
3139
#[doc(alias = "EnumMethodItem")]
3240
pub fn method(&self) {}
3341
}
3442

43+
/// Doc for type alias `Typedef`
3544
#[doc(alias = "TypedefItem")]
3645
pub type Typedef = i32;
3746

47+
/// Doc for `Trait`
3848
#[doc(alias = "TraitItem")]
3949
pub trait Trait {
50+
/// Doc for `Trait::Target`
4051
#[doc(alias = "TraitTypeItem")]
4152
type Target;
53+
/// Doc for `Trait::AssociatedConst`
4254
#[doc(alias = "AssociatedConstItem")]
4355
const AssociatedConst: i32;
4456

57+
/// Doc for `Trait::function`
4558
#[doc(alias = "TraitFunctionItem")]
4659
fn function() -> Self::Target;
4760
}
4861

62+
/// Doc for `function`
4963
#[doc(alias = "FunctionItem")]
5064
pub fn function() {}
5165

66+
/// Doc for `Module`
5267
#[doc(alias = "ModuleItem")]
5368
pub mod Module {}
5469

70+
/// Doc for `Const`
5571
#[doc(alias = "ConstItem")]
5672
pub const Const: u32 = 0;
5773

74+
/// Doc for `Static`
5875
#[doc(alias = "StaticItem")]
5976
pub static Static: u32 = 0;
6077

78+
/// Doc for `Union`
6179
#[doc(alias = "UnionItem")]
6280
pub union Union {
81+
/// Doc for `Union::union_item`
6382
#[doc(alias = "UnionFieldItem")]
6483
pub union_item: u32,
6584
pub y: f32,
6685
}
6786

6887
impl Union {
88+
/// Doc for `Union::method`
6989
#[doc(alias = "UnionMethodItem")]
7090
pub fn method(&self) {}
7191
}
7292

93+
/// Doc for `Macro`
7394
#[doc(alias = "MacroItem")]
7495
#[macro_export]
7596
macro_rules! Macro {

0 commit comments

Comments
 (0)