Skip to content

Commit cdaf3a4

Browse files
borsbors
committed
Auto merge of #21999 - tomjakubowski:rustdoc-fixes, r=alexcrichton
r? @alexcrichton
2 parents f16de18 + e43c478 commit cdaf3a4

File tree

16 files changed

+155
-25
lines changed

16 files changed

+155
-25
lines changed

‎src/librustc/metadata/encoder.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1466,7 +1466,7 @@ fn encode_info_for_foreign_item(ecx: &EncodeContext,
14661466
encode_def_id(rbml_w, local_def(nitem.id));
14671467
encode_visibility(rbml_w, nitem.vis);
14681468
match nitem.node {
1469-
ast::ForeignItemFn(..) => {
1469+
ast::ForeignItemFn(ref fndecl, _) => {
14701470
encode_family(rbml_w, FN_FAMILY);
14711471
encode_bounds_and_type(rbml_w, ecx,
14721472
&lookup_item_type(ecx.tcx,local_def(nitem.id)));
@@ -1478,6 +1478,7 @@ fn encode_info_for_foreign_item(ecx: &EncodeContext,
14781478
let stab = stability::lookup(ecx.tcx, ast_util::local_def(nitem.id));
14791479
encode_stability(rbml_w, stab);
14801480
encode_symbol(ecx, rbml_w, nitem.id);
1481+
encode_method_argument_names(rbml_w, &*fndecl);
14811482
}
14821483
ast::ForeignItemStatic(_, mutbl) => {
14831484
if mutbl {

‎src/librustdoc/clean/inline.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,13 +306,14 @@ fn build_impl(cx: &DocContext, tcx: &ty::ctxt,
306306
let mut item = method.clean(cx);
307307
item.inner = match item.inner.clone() {
308308
clean::TyMethodItem(clean::TyMethod {
309-
unsafety, decl, self_, generics
309+
unsafety, decl, self_, generics, abi
310310
}) => {
311311
clean::MethodItem(clean::Method {
312312
unsafety: unsafety,
313313
decl: decl,
314314
self_: self_,
315315
generics: generics,
316+
abi: abi
316317
})
317318
}
318319
_ => panic!("not a tymethod"),

‎src/librustdoc/clean/mod.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ pub use self::FunctionRetTy::*;
2727
pub use self::TraitMethod::*;
2828

2929
use syntax;
30+
use syntax::abi;
3031
use syntax::ast;
3132
use syntax::ast_util;
3233
use syntax::ast_util::PostExpansionMethod;
@@ -945,6 +946,7 @@ pub struct Method {
945946
pub self_: SelfTy,
946947
pub unsafety: ast::Unsafety,
947948
pub decl: FnDecl,
949+
pub abi: abi::Abi
948950
}
949951

950952
impl Clean<Item> for ast::Method {
@@ -973,6 +975,7 @@ impl Clean<Item> for ast::Method {
973975
self_: self.pe_explicit_self().node.clean(cx),
974976
unsafety: self.pe_unsafety().clone(),
975977
decl: decl,
978+
abi: self.pe_abi()
976979
}),
977980
}
978981
}
@@ -984,6 +987,7 @@ pub struct TyMethod {
984987
pub decl: FnDecl,
985988
pub generics: Generics,
986989
pub self_: SelfTy,
990+
pub abi: abi::Abi
987991
}
988992

989993
impl Clean<Item> for ast::TypeMethod {
@@ -1011,6 +1015,7 @@ impl Clean<Item> for ast::TypeMethod {
10111015
decl: decl,
10121016
self_: self.explicit_self.node.clean(cx),
10131017
generics: self.generics.clean(cx),
1018+
abi: self.abi
10141019
}),
10151020
}
10161021
}
@@ -1301,6 +1306,7 @@ impl<'tcx> Clean<Item> for ty::Method<'tcx> {
13011306
generics: (&self.generics, subst::FnSpace).clean(cx),
13021307
self_: self_,
13031308
decl: (self.def_id, &sig).clean(cx),
1309+
abi: self.fty.abi
13041310
})
13051311
}
13061312
}

‎src/librustdoc/html/format.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -460,7 +460,8 @@ impl fmt::Display for clean::Type {
460460
f.write_str(name)
461461
}
462462
clean::ResolvedPath{ did, ref typarams, ref path } => {
463-
try!(resolved_path(f, did, path, false));
463+
// Paths like Self::Output should be rendered with all segments
464+
try!(resolved_path(f, did, path, path.segments[0].name == "Self"));
464465
tybounds(f, typarams)
465466
}
466467
clean::Infer => write!(f, "_"),

‎src/librustdoc/html/render.rs

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ use externalfiles::ExternalHtml;
5050

5151
use serialize::json;
5252
use serialize::json::ToJson;
53+
use syntax::abi;
5354
use syntax::ast;
5455
use syntax::ast_util;
5556
use rustc::util::nodemap::NodeSet;
@@ -1809,15 +1810,22 @@ fn assoc_type(w: &mut fmt::Formatter, it: &clean::Item,
18091810
}
18101811

18111812
fn render_method(w: &mut fmt::Formatter, meth: &clean::Item) -> fmt::Result {
1812-
fn method(w: &mut fmt::Formatter, it: &clean::Item, unsafety: ast::Unsafety,
1813-
g: &clean::Generics, selfty: &clean::SelfTy,
1814-
d: &clean::FnDecl) -> fmt::Result {
1815-
write!(w, "{}fn <a href='#{ty}.{name}' class='fnname'>{name}</a>\
1813+
fn method(w: &mut fmt::Formatter, it: &clean::Item,
1814+
unsafety: ast::Unsafety, abi: abi::Abi,
1815+
g: &clean::Generics, selfty: &clean::SelfTy,
1816+
d: &clean::FnDecl) -> fmt::Result {
1817+
use syntax::abi::Abi;
1818+
1819+
write!(w, "{}{}fn <a href='#{ty}.{name}' class='fnname'>{name}</a>\
18161820
{generics}{decl}{where_clause}",
18171821
match unsafety {
18181822
ast::Unsafety::Unsafe => "unsafe ",
18191823
_ => "",
18201824
},
1825+
match abi {
1826+
Abi::Rust => String::new(),
1827+
a => format!("extern {} ", a.to_string())
1828+
},
18211829
ty = shortty(it),
18221830
name = it.name.as_ref().unwrap(),
18231831
generics = *g,
@@ -1826,10 +1834,10 @@ fn render_method(w: &mut fmt::Formatter, meth: &clean::Item) -> fmt::Result {
18261834
}
18271835
match meth.inner {
18281836
clean::TyMethodItem(ref m) => {
1829-
method(w, meth, m.unsafety, &m.generics, &m.self_, &m.decl)
1837+
method(w, meth, m.unsafety, m.abi, &m.generics, &m.self_, &m.decl)
18301838
}
18311839
clean::MethodItem(ref m) => {
1832-
method(w, meth, m.unsafety, &m.generics, &m.self_, &m.decl)
1840+
method(w, meth, m.unsafety, m.abi, &m.generics, &m.self_, &m.decl)
18331841
}
18341842
clean::AssociatedTypeItem(ref typ) => {
18351843
assoc_type(w, meth, typ)

‎src/test/run-make/rustdoc-assoc-types/Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
-include ../tools.mk
2+
3+
all: lib.rs
4+
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc lib.rs
5+
$(HTMLDOCCK) $(TMPDIR)/doc lib.rs

‎src/test/run-make/rustdoc-assoc-types/lib.rs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
#![crate_type="lib"]
12+
13+
// @has lib/trait.Index.html
14+
pub trait Index<I: ?Sized> {
15+
// @has - '//*[@id="associatedtype.Output"]//code' 'type Output: ?Sized'
16+
type Output: ?Sized;
17+
// @has - '//*[@id="tymethod.index"]//code' \
18+
// "fn index<'a>(&'a self, index: I) -> &'a Self::Output"
19+
fn index<'a>(&'a self, index: I) -> &'a Self::Output;
20+
}

‎src/test/run-make/rustdoc-extern-method/Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
-include ../tools.mk
2+
3+
all: foo.rs bar.rs
4+
$(HOST_RPATH_ENV) $(RUSTC) foo.rs
5+
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc foo.rs
6+
$(HOST_RPATH_ENV) $(RUSTDOC) -L $(TMPDIR) -w html -o $(TMPDIR)/doc bar.rs
7+
$(HTMLDOCCK) $(TMPDIR)/doc bar.rs
8+

‎src/test/run-make/rustdoc-extern-method/bar.rs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
extern crate foo;
12+
13+
// @has bar/trait.Foo.html //pre "pub trait Foo"
14+
// @has - '//*[@id="tymethod.foo"]//code' 'extern "rust-call" fn foo'
15+
// @has - '//*[@id="tymethod.foo_"]//code' 'extern "rust-call" fn foo_'
16+
pub use foo::Foo;
17+
18+
// @has bar/trait.Bar.html //pre "pub trait Bar"
19+
pub trait Bar {
20+
// @has - '//*[@id="tymethod.bar"]//code' 'extern "rust-call" fn bar'
21+
extern "rust-call" fn bar(&self, _: ());
22+
// @has - '//*[@id="method.bar_"]//code' 'extern "rust-call" fn bar_'
23+
extern "rust-call" fn bar_(&self, _: ()) { }
24+
}

‎src/test/run-make/rustdoc-extern-method/foo.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
#![crate_type="lib"]
12+
13+
pub trait Foo {
14+
extern "rust-call" fn foo(&self, _: ()) -> i32;
15+
extern "rust-call" fn foo_(&self, _: ()) -> i32 { 0 }
16+
}

‎src/test/run-make/rustdoc-ffi/Makefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
-include ../tools.mk
2+
3+
all: lib.rs
4+
$(HOST_RPATH_ENV) $(RUSTC) lib.rs
5+
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc lib.rs
6+
$(HOST_RPATH_ENV) $(RUSTDOC) -L $(TMPDIR) -w html -o $(TMPDIR)/doc user.rs
7+
$(HTMLDOCCK) $(TMPDIR)/doc lib.rs
8+
$(HTMLDOCCK) $(TMPDIR)/doc user.rs

‎src/test/run-make/rustdoc-ffi/lib.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
#![crate_type="lib"]
12+
13+
extern "C" {
14+
// @has lib/fn.foreigner.html //pre 'pub unsafe fn foreigner(cold_as_ice: u32)'
15+
pub fn foreigner(cold_as_ice: u32);
16+
}

‎src/test/run-make/rustdoc-ffi/user.rs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
2+
// file at the top-level directory of this distribution and at
3+
// http://rust-lang.org/COPYRIGHT.
4+
//
5+
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6+
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7+
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8+
// option. This file may not be copied, modified, or distributed
9+
// except according to those terms.
10+
11+
#![crate_type="lib"]
12+
13+
extern crate lib;
14+
15+
// @has user/fn.foreigner.html //pre 'pub unsafe fn foreigner(cold_as_ice: u32)'
16+
pub use lib::foreigner;

‎src/test/run-make/rustdoc-hidden-line/foo.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,4 @@
3232
pub fn foo() {}
3333

3434
// @!has foo/fn.foo.html invisible
35-
// @matches - //pre '#.*\[.*derive.*\(.*Eq.*\).*\].*//.*Bar'
36-
35+
// @matches - //pre "#\[derive\(PartialEq\)\] // Bar"

‎src/test/run-make/rustdoc-negative-impl/foo.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ pub struct Alpha;
1515
// @matches foo/struct.Bravo.html '//pre' "pub struct Bravo<B>"
1616
pub struct Bravo<B>;
1717

18-
// @matches foo/struct.Alpha.html '//*[@class="impl"]//code' "impl !.*Send.* for .*Alpha"
18+
// @matches foo/struct.Alpha.html '//*[@class="impl"]//code' "impl !Send for Alpha"
1919
impl !Send for Alpha {}
2020

21-
// @matches foo/struct.Bravo.html '//*[@class="impl"]//code' "impl<B> !.*Send.* for .*Bravo.*<B>"
21+
// @matches foo/struct.Bravo.html '//*[@class="impl"]//code' "impl<B> !Send for Bravo<B>"
2222
impl<B> !Send for Bravo<B> {}

‎src/test/run-make/rustdoc-where/foo.rs

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,30 @@
1010

1111
pub trait MyTrait {}
1212

13-
// @matches foo/struct.Alpha.html '//pre' "Alpha.*where.*A:.*MyTrait"
13+
// @has foo/struct.Alpha.html '//pre' "pub struct Alpha<A> where A: MyTrait"
1414
pub struct Alpha<A> where A: MyTrait;
15-
// @matches foo/trait.Bravo.html '//pre' "Bravo.*where.*B:.*MyTrait"
15+
// @has foo/trait.Bravo.html '//pre' "pub trait Bravo<B> where B: MyTrait"
1616
pub trait Bravo<B> where B: MyTrait {}
17-
// @matches foo/fn.charlie.html '//pre' "charlie.*where.*C:.*MyTrait"
17+
// @has foo/fn.charlie.html '//pre' "pub fn charlie<C>() where C: MyTrait"
1818
pub fn charlie<C>() where C: MyTrait {}
1919

2020
pub struct Delta<D>;
21-
// @matches foo/struct.Delta.html '//*[@class="impl"]//code' "impl.*Delta.*where.*D:.*MyTrait"
21+
// @has foo/struct.Delta.html '//*[@class="impl"]//code' \
22+
// "impl<D> Delta<D> where D: MyTrait"
2223
impl<D> Delta<D> where D: MyTrait {
2324
pub fn delta() {}
2425
}
2526

2627
pub struct Echo<E>;
27-
// @matches foo/struct.Echo.html '//*[@class="impl"]//code' \
28-
// "impl.*MyTrait.*for.*Echo.*where.*E:.*MyTrait"
29-
// @matches foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
30-
// "impl.*MyTrait.*for.*Echo.*where.*E:.*MyTrait"
28+
// @has foo/struct.Echo.html '//*[@class="impl"]//code' \
29+
// "impl<E> MyTrait for Echo<E> where E: MyTrait"
30+
// @has foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
31+
// "impl<E> MyTrait for Echo<E> where E: MyTrait"
3132
impl<E> MyTrait for Echo<E> where E: MyTrait {}
3233

3334
pub enum Foxtrot<F> {}
34-
// @matches foo/enum.Foxtrot.html '//*[@class="impl"]//code' \
35-
// "impl.*MyTrait.*for.*Foxtrot.*where.*F:.*MyTrait"
36-
// @matches foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
37-
// "impl.*MyTrait.*for.*Foxtrot.*where.*F:.*MyTrait"
35+
// @has foo/enum.Foxtrot.html '//*[@class="impl"]//code' \
36+
// "impl<F> MyTrait for Foxtrot<F> where F: MyTrait"
37+
// @has foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
38+
// "impl<F> MyTrait for Foxtrot<F> where F: MyTrait"
3839
impl<F> MyTrait for Foxtrot<F> where F: MyTrait {}

0 commit comments

Comments
 (0)