Rollup merge of #32558 - sanxiyn:rustdoc-self-link, r=steveklabnik
Avoid linking to itself in implementors section of trait page Fix #32474.
This commit is contained in:
commit
5d0dca363f
4 changed files with 54 additions and 10 deletions
|
@ -1518,6 +1518,13 @@ impl Type {
|
|||
_ => None,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn trait_name(&self) -> Option<String> {
|
||||
match *self {
|
||||
ResolvedPath { ref path, .. } => Some(path.last_name()),
|
||||
_ => None,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl GetDefId for Type {
|
||||
|
@ -2009,6 +2016,10 @@ impl Path {
|
|||
}]
|
||||
}
|
||||
}
|
||||
|
||||
pub fn last_name(&self) -> String {
|
||||
self.segments.last().unwrap().name.clone()
|
||||
}
|
||||
}
|
||||
|
||||
impl Clean<Path> for hir::Path {
|
||||
|
|
|
@ -561,17 +561,31 @@ impl fmt::Display for clean::Type {
|
|||
}
|
||||
}
|
||||
|
||||
impl fmt::Display for clean::Impl {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
write!(f, "impl{} ", self.generics)?;
|
||||
if let Some(ref ty) = self.trait_ {
|
||||
write!(f, "{}{} for ",
|
||||
if self.polarity == Some(clean::ImplPolarity::Negative) { "!" } else { "" },
|
||||
*ty)?;
|
||||
fn fmt_impl(i: &clean::Impl, f: &mut fmt::Formatter, link_trait: bool) -> fmt::Result {
|
||||
write!(f, "impl{} ", i.generics)?;
|
||||
if let Some(ref ty) = i.trait_ {
|
||||
write!(f, "{}",
|
||||
if i.polarity == Some(clean::ImplPolarity::Negative) { "!" } else { "" })?;
|
||||
if link_trait {
|
||||
write!(f, "{}", *ty)?;
|
||||
} else {
|
||||
write!(f, "{}", ty.trait_name().unwrap())?;
|
||||
}
|
||||
write!(f, "{}{}", self.for_, WhereClause(&self.generics))?;
|
||||
write!(f, " for ")?;
|
||||
}
|
||||
write!(f, "{}{}", i.for_, WhereClause(&i.generics))?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
impl fmt::Display for clean::Impl {
|
||||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
fmt_impl(self, f, true)
|
||||
}
|
||||
}
|
||||
|
||||
// The difference from above is that trait is not hyperlinked.
|
||||
pub fn fmt_impl_for_trait_page(i: &clean::Impl, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
fmt_impl(i, f, false)
|
||||
}
|
||||
|
||||
impl fmt::Display for clean::Arguments {
|
||||
|
@ -667,7 +681,7 @@ impl fmt::Display for clean::Import {
|
|||
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
||||
match *self {
|
||||
clean::SimpleImport(ref name, ref src) => {
|
||||
if *name == src.path.segments.last().unwrap().name {
|
||||
if *name == src.path.last_name() {
|
||||
write!(f, "use {};", *src)
|
||||
} else {
|
||||
write!(f, "use {} as {};", *src, *name)
|
||||
|
|
|
@ -69,6 +69,7 @@ use html::escape::Escape;
|
|||
use html::format::{ConstnessSpace};
|
||||
use html::format::{TyParamBounds, WhereClause, href, AbiSpace};
|
||||
use html::format::{VisSpace, Method, UnsafetySpace, MutableSpace};
|
||||
use html::format::fmt_impl_for_trait_page;
|
||||
use html::item_type::ItemType;
|
||||
use html::markdown::{self, Markdown};
|
||||
use html::{highlight, layout};
|
||||
|
@ -2010,7 +2011,9 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
|
|||
match cache.implementors.get(&it.def_id) {
|
||||
Some(implementors) => {
|
||||
for i in implementors {
|
||||
writeln!(w, "<li><code>{}</code></li>", i.impl_)?;
|
||||
write!(w, "<li><code>")?;
|
||||
fmt_impl_for_trait_page(&i.impl_, w)?;
|
||||
writeln!(w, "</code></li>")?;
|
||||
}
|
||||
}
|
||||
None => {}
|
||||
|
|
16
src/test/rustdoc/trait-self-link.rs
Normal file
16
src/test/rustdoc/trait-self-link.rs
Normal file
|
@ -0,0 +1,16 @@
|
|||
// Copyright 2016 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.
|
||||
|
||||
// @!has trait_self_link/trait.Foo.html //a/@href ../trait_self_link/trait.Foo.html
|
||||
pub trait Foo {}
|
||||
|
||||
pub struct Bar;
|
||||
|
||||
impl Foo for Bar {}
|
Loading…
Add table
Add a link
Reference in a new issue