dnrops
/
rust
mirror of https://github.com/rust-lang/rust.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add test for PR #126057

This commit is contained in:
Sunshine 2024-06-07 05:49:46 +08:00
parent c3309ef446
commit dd5103bb68
6 changed files with 256 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/librustdoc/html/static/js/externs.js
View File

@ -41,8 +41,9 @@ let ParserState;
* foundElems: number,
* totalElems: number,
* literalSearch: boolean,
* corrections: Array<{from: string, to: integer}>,
* corrections: Array<{from: string, to: integer}> | null,
* typeFingerprint: Uint32Array,
* error: Array<string> | null,
* }}
*/
let ParsedQuery;

2
tests/rustdoc-js/basic.js
View File

@ -1,6 +1,6 @@
const EXPECTED = {
'query': 'Fo',
'others': [
{ 'path': 'basic', 'name': 'Foo' },
{ 'path': 'basic', 'name': 'Foo', 'desc': 'Docs for Foo' },
],
};

22
tests/rustdoc-js/doc-alias.js
View File

@ -5,6 +5,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Struct',
'desc': 'Doc for <code>Struct</code>',
'alias': 'StructItem',
'href': '../doc_alias/struct.Struct.html',
'is_alias': true
@ -17,6 +18,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Struct',
'name': 'field',
'desc': 'Doc for <code>Struct</code>’s <code>field</code>',
'alias': 'StructFieldItem',
'href': '../doc_alias/struct.Struct.html#structfield.field',
'is_alias': true
@ -29,6 +31,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Struct',
'name': 'method',
'desc': 'Doc for <code>Struct::method</code>',
'alias': 'StructMethodItem',
'href': '../doc_alias/struct.Struct.html#method.method',
'is_alias': true
@ -45,6 +48,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Struct',
'name': 'ImplConstItem',
'desc': 'Doc for <code>Struct::ImplConstItem</code>',
'alias': 'StructImplConstItem',
'href': '../doc_alias/struct.Struct.html#associatedconstant.ImplConstItem',
'is_alias': true
@ -57,6 +61,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Struct',
'name': 'function',
'desc': 'Doc for <code>Trait::function</code> implemented for Struct',
'alias': 'ImplTraitFunction',
'href': '../doc_alias/struct.Struct.html#method.function',
'is_alias': true
@ -69,6 +74,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Enum',
'desc': 'Doc for <code>Enum</code>',
'alias': 'EnumItem',
'href': '../doc_alias/enum.Enum.html',
'is_alias': true
@ -81,6 +87,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Enum',
'name': 'Variant',
'desc': 'Doc for <code>Enum::Variant</code>',
'alias': 'VariantItem',
'href': '../doc_alias/enum.Enum.html#variant.Variant',
'is_alias': true
@ -93,6 +100,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Enum',
'name': 'method',
'desc': 'Doc for <code>Enum::method</code>',
'alias': 'EnumMethodItem',
'href': '../doc_alias/enum.Enum.html#method.method',
'is_alias': true
@ -105,6 +113,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Typedef',
'desc': 'Doc for type alias <code>Typedef</code>',
'alias': 'TypedefItem',
'href': '../doc_alias/type.Typedef.html',
'is_alias': true
@ -117,6 +126,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Trait',
'desc': 'Doc for <code>Trait</code>',
'alias': 'TraitItem',
'href': '../doc_alias/trait.Trait.html',
'is_alias': true
@ -129,6 +139,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Trait',
'name': 'Target',
'desc': 'Doc for <code>Trait::Target</code>',
'alias': 'TraitTypeItem',
'href': '../doc_alias/trait.Trait.html#associatedtype.Target',
'is_alias': true
@ -141,6 +152,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Trait',
'name': 'AssociatedConst',
'desc': 'Doc for <code>Trait::AssociatedConst</code>',
'alias': 'AssociatedConstItem',
'href': '../doc_alias/trait.Trait.html#associatedconstant.AssociatedConst',
'is_alias': true
@ -153,6 +165,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Trait',
'name': 'function',
'desc': 'Doc for <code>Trait::function</code>',
'alias': 'TraitFunctionItem',
'href': '../doc_alias/trait.Trait.html#tymethod.function',
'is_alias': true
@ -165,6 +178,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'function',
'desc': 'Doc for <code>function</code>',
'alias': 'FunctionItem',
'href': '../doc_alias/fn.function.html',
'is_alias': true
@ -177,6 +191,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Module',
'desc': 'Doc for <code>Module</code>',
'alias': 'ModuleItem',
'href': '../doc_alias/Module/index.html',
'is_alias': true
@ -189,6 +204,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Const',
'desc': 'Doc for <code>Const</code>',
'alias': 'ConstItem',
'href': '../doc_alias/constant.Const.html',
'is_alias': true
@ -205,6 +221,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Static',
'desc': 'Doc for <code>Static</code>',
'alias': 'StaticItem',
'href': '../doc_alias/static.Static.html',
'is_alias': true
@ -217,6 +234,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Union',
'desc': 'Doc for <code>Union</code>',
'alias': 'UnionItem',
'href': '../doc_alias/union.Union.html',
'is_alias': true
@ -225,6 +243,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Union',
'name': 'union_item',
'desc': 'Doc for <code>Union::union_item</code>',
'href': '../doc_alias/union.Union.html#structfield.union_item'
},
],
@ -235,6 +254,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Union',
'name': 'union_item',
'desc': 'Doc for <code>Union::union_item</code>',
'alias': 'UnionFieldItem',
'href': '../doc_alias/union.Union.html#structfield.union_item',
'is_alias': true
@ -247,6 +267,7 @@ const EXPECTED = [
{
'path': 'doc_alias::Union',
'name': 'method',
'desc': 'Doc for <code>Union::method</code>',
'alias': 'UnionMethodItem',
'href': '../doc_alias/union.Union.html#method.method',
'is_alias': true
@ -259,6 +280,7 @@ const EXPECTED = [
{
'path': 'doc_alias',
'name': 'Macro',
'desc': 'Doc for <code>Macro</code>',
'alias': 'MacroItem',
'href': '../doc_alias/macro.Macro.html',
'is_alias': true

21
tests/rustdoc-js/doc-alias.rs
View File

@ -1,12 +1,16 @@
/// Doc for `Struct`
#[doc(alias = "StructItem")]
pub struct Struct {
/// Doc for `Struct`'s `field`
#[doc(alias = "StructFieldItem")]
pub field: u32,
}
impl Struct {
/// Doc for `Struct::ImplConstItem`
#[doc(alias = "StructImplConstItem")]
pub const ImplConstItem: i32 = 0;
/// Doc for `Struct::method`
#[doc(alias = "StructMethodItem")]
pub fn method(&self) {}
}
@ -15,61 +19,78 @@ impl Trait for Struct {
type Target = u32;
const AssociatedConst: i32 = 12;
/// Doc for `Trait::function` implemented for Struct
#[doc(alias = "ImplTraitFunction")]
fn function() -> Self::Target {
0
}
}
/// Doc for `Enum`
#[doc(alias = "EnumItem")]
pub enum Enum {
/// Doc for `Enum::Variant`
#[doc(alias = "VariantItem")]
Variant,
}
impl Enum {
/// Doc for `Enum::method`
#[doc(alias = "EnumMethodItem")]
pub fn method(&self) {}
}
/// Doc for type alias `Typedef`
#[doc(alias = "TypedefItem")]
pub type Typedef = i32;
/// Doc for `Trait`
#[doc(alias = "TraitItem")]
pub trait Trait {
/// Doc for `Trait::Target`
#[doc(alias = "TraitTypeItem")]
type Target;
/// Doc for `Trait::AssociatedConst`
#[doc(alias = "AssociatedConstItem")]
const AssociatedConst: i32;
/// Doc for `Trait::function`
#[doc(alias = "TraitFunctionItem")]
fn function() -> Self::Target;
}
/// Doc for `function`
#[doc(alias = "FunctionItem")]
pub fn function() {}
/// Doc for `Module`
#[doc(alias = "ModuleItem")]
pub mod Module {}
/// Doc for `Const`
#[doc(alias = "ConstItem")]
pub const Const: u32 = 0;
/// Doc for `Static`
#[doc(alias = "StaticItem")]
pub static Static: u32 = 0;
/// Doc for `Union`
#[doc(alias = "UnionItem")]
pub union Union {
/// Doc for `Union::union_item`
#[doc(alias = "UnionFieldItem")]
pub union_item: u32,
pub y: f32,
}
impl Union {
/// Doc for `Union::method`
#[doc(alias = "UnionMethodItem")]
pub fn method(&self) {}
}
/// Doc for `Macro`
#[doc(alias = "MacroItem")]
#[macro_export]
macro_rules! Macro {

163
tests/rustdoc-js/non-english-identifier.js Normal file
View File

@ -0,0 +1,163 @@
const PARSED = [
{
query: '中文',
elems: [{
name: "中文",
fullPath: ["中文"],
pathWithoutLast: [],
pathLast: "中文",
generics: [],
typeFilter: -1,
}],
returned: [],
foundElems: 1,
original: "中文",
userQuery: "中文",
error: null,
},
{
query: '_0Mixed中英文',
elems: [{
name: "_0mixed中英文",
fullPath: ["_0mixed中英文"],
pathWithoutLast: [],
pathLast: "_0mixed中英文",
generics: [],
typeFilter: -1,
}],
foundElems: 1,
original: "_0Mixed中英文",
returned: [],
userQuery: "_0mixed中英文",
error: null,
},
{
query: 'my_crate::中文API',
elems: [{
name: "my_crate::中文api",
fullPath: ["my_crate", "中文api"],
pathWithoutLast: ["my_crate"],
pathLast: "中文api",
generics: [],
typeFilter: -1,
}],
foundElems: 1,
original: "my_crate::中文API",
returned: [],
userQuery: "my_crate::中文api",
error: null,
},
{
query: '类型A,类型B<约束C>->返回类型<关联类型=路径::约束D>',
elems: [{
name: "类型a",
fullPath: ["类型a"],
pathWithoutLast: [],
pathLast: "类型a",
generics: [],
}, {
name: "类型b",
fullPath: ["类型b"],
pathWithoutLast: [],
pathLast: "类型b",
generics: [{
name: "约束c",
fullPath: ["约束c"],
pathWithoutLast: [],
pathLast: "约束c",
generics: [],
}],
}],
foundElems: 3,
totalElems: 5,
literalSearch: true,
original: "类型A,类型B<约束C>->返回类型<关联类型=路径::约束D>",
returned: [{
name: "返回类型",
fullPath: ["返回类型"],
pathWithoutLast: [],
pathLast: "返回类型",
generics: [],
}],
userQuery: "类型a,类型b<约束c>->返回类型<关联类型=路径::约束d>",
error: null,
},
{
query: 'my_crate 中文宏!',
elems: [{
name: "my_crate 中文宏",
fullPath: ["my_crate", "中文宏"],
pathWithoutLast: ["my_crate"],
pathLast: "中文宏",
generics: [],
typeFilter: 16,
}],
foundElems: 1,
original: "my_crate 中文宏!",
returned: [],
userQuery: "my_crate 中文宏!",
error: null,
},
{
query: '非法符号——',
elems: [],
foundElems: 0,
original: "非法符号——",
returned: [],
userQuery: "非法符号——",
error: "Unexpected `—` after `号`",
}
]
const EXPECTED = [
{
query: '加法',
others: [
{
name: "add",
path: "non_english_identifier",
is_alias: true,
alias: "加法",
href: "../non_english_identifier/macro.add.html"
},
{
name: "add",
path: "non_english_identifier",
is_alias: true,
alias: "加法",
href: "../non_english_identifier/fn.add.html"
},
{
name: "加法",
path: "non_english_identifier",
href: "../non_english_identifier/trait.加法.html",
desc: "Add"
},
{
name: "中文名称的加法宏",
path: "non_english_identifier",
href: "../non_english_identifier/macro.中文名称的加法宏.html",
},
{
name: "中文名称的加法API",
path: "non_english_identifier",
href: "../non_english_identifier/fn.中文名称的加法API.html",
}],
in_args: [{
name: "加上",
path: "non_english_identifier::加法",
href: "../non_english_identifier/trait.加法.html#tymethod.加上",
}],
returned: [],
},
{ // Extensive type-based search is still buggy, experimental & work-in-progress.
query: '可迭代->可选',
others: [{
name: "总计",
path: "non_english_identifier",
href: "../non_english_identifier/fn.总计.html",
desc: "“sum”"
}],
in_args: [],
returned: [],
},
];

47
tests/rustdoc-js/non-english-identifier.rs Normal file
View File

@ -0,0 +1,47 @@
#[doc(alias = "加法")]
pub fn add(left: usize, right: usize) -> usize {
left + right
}
pub fn 中文名称的加法API(left: usize, right: usize) -> usize {
left + right
}
#[macro_export]
macro_rules! 中文名称的加法宏 {
($left:expr, $right:expr) => {
($left) + ($right)
};
}
#[doc(alias = "加法")]
#[macro_export]
macro_rules! add {
($left:expr, $right:expr) => {
($left) + ($right)
};
}
/// Add
pub trait 加法<类型> {
type 结果;
fn 加上(self, 被加数: 类型) -> Self::结果;
}
/// IntoIterator
pub trait 可迭代 {
type 项;
type 转为迭代器: Iterator<Item = Self::项>;
fn 迭代(self) -> Self::转为迭代器;
}
pub type 可选<类型> = Option<类型>;
/// "sum"
pub fn 总计<集合, 个体>(容器: 集合) -> 可选<集合::项>
where
集合: 可迭代<项 = 个体>,
个体: 加法<个体, 结果 = 个体>,
{
容器.迭代().reduce(|累计值, 当前值| 累计值.加上(当前值))
}