mirror of
https://github.com/rust-lang/rust.git
synced 2024-12-30 17:34:54 +00:00
Auto merge of #21999 - tomjakubowski:rustdoc-fixes, r=alexcrichton
r? @alexcrichton
This commit is contained in:
commit
cdaf3a4393
@ -1466,7 +1466,7 @@ fn encode_info_for_foreign_item(ecx: &EncodeContext,
|
||||
encode_def_id(rbml_w, local_def(nitem.id));
|
||||
encode_visibility(rbml_w, nitem.vis);
|
||||
match nitem.node {
|
||||
ast::ForeignItemFn(..) => {
|
||||
ast::ForeignItemFn(ref fndecl, _) => {
|
||||
encode_family(rbml_w, FN_FAMILY);
|
||||
encode_bounds_and_type(rbml_w, ecx,
|
||||
&lookup_item_type(ecx.tcx,local_def(nitem.id)));
|
||||
@ -1478,6 +1478,7 @@ fn encode_info_for_foreign_item(ecx: &EncodeContext,
|
||||
let stab = stability::lookup(ecx.tcx, ast_util::local_def(nitem.id));
|
||||
encode_stability(rbml_w, stab);
|
||||
encode_symbol(ecx, rbml_w, nitem.id);
|
||||
encode_method_argument_names(rbml_w, &*fndecl);
|
||||
}
|
||||
ast::ForeignItemStatic(_, mutbl) => {
|
||||
if mutbl {
|
||||
|
@ -306,13 +306,14 @@ fn build_impl(cx: &DocContext, tcx: &ty::ctxt,
|
||||
let mut item = method.clean(cx);
|
||||
item.inner = match item.inner.clone() {
|
||||
clean::TyMethodItem(clean::TyMethod {
|
||||
unsafety, decl, self_, generics
|
||||
unsafety, decl, self_, generics, abi
|
||||
}) => {
|
||||
clean::MethodItem(clean::Method {
|
||||
unsafety: unsafety,
|
||||
decl: decl,
|
||||
self_: self_,
|
||||
generics: generics,
|
||||
abi: abi
|
||||
})
|
||||
}
|
||||
_ => panic!("not a tymethod"),
|
||||
|
@ -27,6 +27,7 @@ pub use self::FunctionRetTy::*;
|
||||
pub use self::TraitMethod::*;
|
||||
|
||||
use syntax;
|
||||
use syntax::abi;
|
||||
use syntax::ast;
|
||||
use syntax::ast_util;
|
||||
use syntax::ast_util::PostExpansionMethod;
|
||||
@ -945,6 +946,7 @@ pub struct Method {
|
||||
pub self_: SelfTy,
|
||||
pub unsafety: ast::Unsafety,
|
||||
pub decl: FnDecl,
|
||||
pub abi: abi::Abi
|
||||
}
|
||||
|
||||
impl Clean<Item> for ast::Method {
|
||||
@ -973,6 +975,7 @@ impl Clean<Item> for ast::Method {
|
||||
self_: self.pe_explicit_self().node.clean(cx),
|
||||
unsafety: self.pe_unsafety().clone(),
|
||||
decl: decl,
|
||||
abi: self.pe_abi()
|
||||
}),
|
||||
}
|
||||
}
|
||||
@ -984,6 +987,7 @@ pub struct TyMethod {
|
||||
pub decl: FnDecl,
|
||||
pub generics: Generics,
|
||||
pub self_: SelfTy,
|
||||
pub abi: abi::Abi
|
||||
}
|
||||
|
||||
impl Clean<Item> for ast::TypeMethod {
|
||||
@ -1011,6 +1015,7 @@ impl Clean<Item> for ast::TypeMethod {
|
||||
decl: decl,
|
||||
self_: self.explicit_self.node.clean(cx),
|
||||
generics: self.generics.clean(cx),
|
||||
abi: self.abi
|
||||
}),
|
||||
}
|
||||
}
|
||||
@ -1301,6 +1306,7 @@ impl<'tcx> Clean<Item> for ty::Method<'tcx> {
|
||||
generics: (&self.generics, subst::FnSpace).clean(cx),
|
||||
self_: self_,
|
||||
decl: (self.def_id, &sig).clean(cx),
|
||||
abi: self.fty.abi
|
||||
})
|
||||
}
|
||||
}
|
||||
|
@ -460,7 +460,8 @@ impl fmt::Display for clean::Type {
|
||||
f.write_str(name)
|
||||
}
|
||||
clean::ResolvedPath{ did, ref typarams, ref path } => {
|
||||
try!(resolved_path(f, did, path, false));
|
||||
// Paths like Self::Output should be rendered with all segments
|
||||
try!(resolved_path(f, did, path, path.segments[0].name == "Self"));
|
||||
tybounds(f, typarams)
|
||||
}
|
||||
clean::Infer => write!(f, "_"),
|
||||
|
@ -50,6 +50,7 @@ use externalfiles::ExternalHtml;
|
||||
|
||||
use serialize::json;
|
||||
use serialize::json::ToJson;
|
||||
use syntax::abi;
|
||||
use syntax::ast;
|
||||
use syntax::ast_util;
|
||||
use rustc::util::nodemap::NodeSet;
|
||||
@ -1809,15 +1810,22 @@ fn assoc_type(w: &mut fmt::Formatter, it: &clean::Item,
|
||||
}
|
||||
|
||||
fn render_method(w: &mut fmt::Formatter, meth: &clean::Item) -> fmt::Result {
|
||||
fn method(w: &mut fmt::Formatter, it: &clean::Item, unsafety: ast::Unsafety,
|
||||
fn method(w: &mut fmt::Formatter, it: &clean::Item,
|
||||
unsafety: ast::Unsafety, abi: abi::Abi,
|
||||
g: &clean::Generics, selfty: &clean::SelfTy,
|
||||
d: &clean::FnDecl) -> fmt::Result {
|
||||
write!(w, "{}fn <a href='#{ty}.{name}' class='fnname'>{name}</a>\
|
||||
use syntax::abi::Abi;
|
||||
|
||||
write!(w, "{}{}fn <a href='#{ty}.{name}' class='fnname'>{name}</a>\
|
||||
{generics}{decl}{where_clause}",
|
||||
match unsafety {
|
||||
ast::Unsafety::Unsafe => "unsafe ",
|
||||
_ => "",
|
||||
},
|
||||
match abi {
|
||||
Abi::Rust => String::new(),
|
||||
a => format!("extern {} ", a.to_string())
|
||||
},
|
||||
ty = shortty(it),
|
||||
name = it.name.as_ref().unwrap(),
|
||||
generics = *g,
|
||||
@ -1826,10 +1834,10 @@ fn render_method(w: &mut fmt::Formatter, meth: &clean::Item) -> fmt::Result {
|
||||
}
|
||||
match meth.inner {
|
||||
clean::TyMethodItem(ref m) => {
|
||||
method(w, meth, m.unsafety, &m.generics, &m.self_, &m.decl)
|
||||
method(w, meth, m.unsafety, m.abi, &m.generics, &m.self_, &m.decl)
|
||||
}
|
||||
clean::MethodItem(ref m) => {
|
||||
method(w, meth, m.unsafety, &m.generics, &m.self_, &m.decl)
|
||||
method(w, meth, m.unsafety, m.abi, &m.generics, &m.self_, &m.decl)
|
||||
}
|
||||
clean::AssociatedTypeItem(ref typ) => {
|
||||
assoc_type(w, meth, typ)
|
||||
|
5
src/test/run-make/rustdoc-assoc-types/Makefile
Normal file
5
src/test/run-make/rustdoc-assoc-types/Makefile
Normal file
@ -0,0 +1,5 @@
|
||||
-include ../tools.mk
|
||||
|
||||
all: lib.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc lib.rs
|
||||
$(HTMLDOCCK) $(TMPDIR)/doc lib.rs
|
20
src/test/run-make/rustdoc-assoc-types/lib.rs
Normal file
20
src/test/run-make/rustdoc-assoc-types/lib.rs
Normal file
@ -0,0 +1,20 @@
|
||||
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
||||
// file at the top-level directory of this distribution and at
|
||||
// http://rust-lang.org/COPYRIGHT.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
#![crate_type="lib"]
|
||||
|
||||
// @has lib/trait.Index.html
|
||||
pub trait Index<I: ?Sized> {
|
||||
// @has - '//*[@id="associatedtype.Output"]//code' 'type Output: ?Sized'
|
||||
type Output: ?Sized;
|
||||
// @has - '//*[@id="tymethod.index"]//code' \
|
||||
// "fn index<'a>(&'a self, index: I) -> &'a Self::Output"
|
||||
fn index<'a>(&'a self, index: I) -> &'a Self::Output;
|
||||
}
|
8
src/test/run-make/rustdoc-extern-method/Makefile
Normal file
8
src/test/run-make/rustdoc-extern-method/Makefile
Normal file
@ -0,0 +1,8 @@
|
||||
-include ../tools.mk
|
||||
|
||||
all: foo.rs bar.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTC) foo.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc foo.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTDOC) -L $(TMPDIR) -w html -o $(TMPDIR)/doc bar.rs
|
||||
$(HTMLDOCCK) $(TMPDIR)/doc bar.rs
|
||||
|
24
src/test/run-make/rustdoc-extern-method/bar.rs
Normal file
24
src/test/run-make/rustdoc-extern-method/bar.rs
Normal file
@ -0,0 +1,24 @@
|
||||
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
||||
// file at the top-level directory of this distribution and at
|
||||
// http://rust-lang.org/COPYRIGHT.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
extern crate foo;
|
||||
|
||||
// @has bar/trait.Foo.html //pre "pub trait Foo"
|
||||
// @has - '//*[@id="tymethod.foo"]//code' 'extern "rust-call" fn foo'
|
||||
// @has - '//*[@id="tymethod.foo_"]//code' 'extern "rust-call" fn foo_'
|
||||
pub use foo::Foo;
|
||||
|
||||
// @has bar/trait.Bar.html //pre "pub trait Bar"
|
||||
pub trait Bar {
|
||||
// @has - '//*[@id="tymethod.bar"]//code' 'extern "rust-call" fn bar'
|
||||
extern "rust-call" fn bar(&self, _: ());
|
||||
// @has - '//*[@id="method.bar_"]//code' 'extern "rust-call" fn bar_'
|
||||
extern "rust-call" fn bar_(&self, _: ()) { }
|
||||
}
|
16
src/test/run-make/rustdoc-extern-method/foo.rs
Normal file
16
src/test/run-make/rustdoc-extern-method/foo.rs
Normal file
@ -0,0 +1,16 @@
|
||||
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
||||
// file at the top-level directory of this distribution and at
|
||||
// http://rust-lang.org/COPYRIGHT.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
#![crate_type="lib"]
|
||||
|
||||
pub trait Foo {
|
||||
extern "rust-call" fn foo(&self, _: ()) -> i32;
|
||||
extern "rust-call" fn foo_(&self, _: ()) -> i32 { 0 }
|
||||
}
|
8
src/test/run-make/rustdoc-ffi/Makefile
Normal file
8
src/test/run-make/rustdoc-ffi/Makefile
Normal file
@ -0,0 +1,8 @@
|
||||
-include ../tools.mk
|
||||
|
||||
all: lib.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTC) lib.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc lib.rs
|
||||
$(HOST_RPATH_ENV) $(RUSTDOC) -L $(TMPDIR) -w html -o $(TMPDIR)/doc user.rs
|
||||
$(HTMLDOCCK) $(TMPDIR)/doc lib.rs
|
||||
$(HTMLDOCCK) $(TMPDIR)/doc user.rs
|
16
src/test/run-make/rustdoc-ffi/lib.rs
Normal file
16
src/test/run-make/rustdoc-ffi/lib.rs
Normal file
@ -0,0 +1,16 @@
|
||||
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
||||
// file at the top-level directory of this distribution and at
|
||||
// http://rust-lang.org/COPYRIGHT.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
#![crate_type="lib"]
|
||||
|
||||
extern "C" {
|
||||
// @has lib/fn.foreigner.html //pre 'pub unsafe fn foreigner(cold_as_ice: u32)'
|
||||
pub fn foreigner(cold_as_ice: u32);
|
||||
}
|
16
src/test/run-make/rustdoc-ffi/user.rs
Normal file
16
src/test/run-make/rustdoc-ffi/user.rs
Normal file
@ -0,0 +1,16 @@
|
||||
// Copyright 2015 The Rust Project Developers. See the COPYRIGHT
|
||||
// file at the top-level directory of this distribution and at
|
||||
// http://rust-lang.org/COPYRIGHT.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
||||
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
||||
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
||||
// option. This file may not be copied, modified, or distributed
|
||||
// except according to those terms.
|
||||
|
||||
#![crate_type="lib"]
|
||||
|
||||
extern crate lib;
|
||||
|
||||
// @has user/fn.foreigner.html //pre 'pub unsafe fn foreigner(cold_as_ice: u32)'
|
||||
pub use lib::foreigner;
|
@ -32,5 +32,4 @@
|
||||
pub fn foo() {}
|
||||
|
||||
// @!has foo/fn.foo.html invisible
|
||||
// @matches - //pre '#.*\[.*derive.*\(.*Eq.*\).*\].*//.*Bar'
|
||||
|
||||
// @matches - //pre "#\[derive\(PartialEq\)\] // Bar"
|
||||
|
@ -15,8 +15,8 @@ pub struct Alpha;
|
||||
// @matches foo/struct.Bravo.html '//pre' "pub struct Bravo<B>"
|
||||
pub struct Bravo<B>;
|
||||
|
||||
// @matches foo/struct.Alpha.html '//*[@class="impl"]//code' "impl !.*Send.* for .*Alpha"
|
||||
// @matches foo/struct.Alpha.html '//*[@class="impl"]//code' "impl !Send for Alpha"
|
||||
impl !Send for Alpha {}
|
||||
|
||||
// @matches foo/struct.Bravo.html '//*[@class="impl"]//code' "impl<B> !.*Send.* for .*Bravo.*<B>"
|
||||
// @matches foo/struct.Bravo.html '//*[@class="impl"]//code' "impl<B> !Send for Bravo<B>"
|
||||
impl<B> !Send for Bravo<B> {}
|
||||
|
@ -10,29 +10,30 @@
|
||||
|
||||
pub trait MyTrait {}
|
||||
|
||||
// @matches foo/struct.Alpha.html '//pre' "Alpha.*where.*A:.*MyTrait"
|
||||
// @has foo/struct.Alpha.html '//pre' "pub struct Alpha<A> where A: MyTrait"
|
||||
pub struct Alpha<A> where A: MyTrait;
|
||||
// @matches foo/trait.Bravo.html '//pre' "Bravo.*where.*B:.*MyTrait"
|
||||
// @has foo/trait.Bravo.html '//pre' "pub trait Bravo<B> where B: MyTrait"
|
||||
pub trait Bravo<B> where B: MyTrait {}
|
||||
// @matches foo/fn.charlie.html '//pre' "charlie.*where.*C:.*MyTrait"
|
||||
// @has foo/fn.charlie.html '//pre' "pub fn charlie<C>() where C: MyTrait"
|
||||
pub fn charlie<C>() where C: MyTrait {}
|
||||
|
||||
pub struct Delta<D>;
|
||||
// @matches foo/struct.Delta.html '//*[@class="impl"]//code' "impl.*Delta.*where.*D:.*MyTrait"
|
||||
// @has foo/struct.Delta.html '//*[@class="impl"]//code' \
|
||||
// "impl<D> Delta<D> where D: MyTrait"
|
||||
impl<D> Delta<D> where D: MyTrait {
|
||||
pub fn delta() {}
|
||||
}
|
||||
|
||||
pub struct Echo<E>;
|
||||
// @matches foo/struct.Echo.html '//*[@class="impl"]//code' \
|
||||
// "impl.*MyTrait.*for.*Echo.*where.*E:.*MyTrait"
|
||||
// @matches foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
|
||||
// "impl.*MyTrait.*for.*Echo.*where.*E:.*MyTrait"
|
||||
// @has foo/struct.Echo.html '//*[@class="impl"]//code' \
|
||||
// "impl<E> MyTrait for Echo<E> where E: MyTrait"
|
||||
// @has foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
|
||||
// "impl<E> MyTrait for Echo<E> where E: MyTrait"
|
||||
impl<E> MyTrait for Echo<E> where E: MyTrait {}
|
||||
|
||||
pub enum Foxtrot<F> {}
|
||||
// @matches foo/enum.Foxtrot.html '//*[@class="impl"]//code' \
|
||||
// "impl.*MyTrait.*for.*Foxtrot.*where.*F:.*MyTrait"
|
||||
// @matches foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
|
||||
// "impl.*MyTrait.*for.*Foxtrot.*where.*F:.*MyTrait"
|
||||
// @has foo/enum.Foxtrot.html '//*[@class="impl"]//code' \
|
||||
// "impl<F> MyTrait for Foxtrot<F> where F: MyTrait"
|
||||
// @has foo/trait.MyTrait.html '//*[@id="implementors-list"]//code' \
|
||||
// "impl<F> MyTrait for Foxtrot<F> where F: MyTrait"
|
||||
impl<F> MyTrait for Foxtrot<F> where F: MyTrait {}
|
||||
|
Loading…
Reference in New Issue
Block a user