diff options
| author | Oliver Middleton <olliemail27@gmail.com> | 2017-02-08 21:15:20 +0000 |
|---|---|---|
| committer | Oliver Middleton <olliemail27@gmail.com> | 2017-02-08 21:15:20 +0000 |
| commit | 147d173d02ea030af23fad07c7e99b2900e710f2 (patch) | |
| tree | 09ee8af3816cc72d6b9c2ad3017435df560ebe85 | |
| parent | fc02736d59252fe408dd6c2f7e2c4b6f229e4443 (diff) | |
| download | rust-147d173d02ea030af23fad07c7e99b2900e710f2.tar.gz rust-147d173d02ea030af23fad07c7e99b2900e710f2.zip | |
rustdoc: Show attributes on all item types
Currently attributes are only shown for structs, unions and enums but they should be shown for all items. For example it is useful to know if a function is `#[no_mangle]`.
| -rw-r--r-- | src/librustdoc/html/render.rs | 20 | ||||
| -rw-r--r-- | src/test/rustdoc/attributes.rs | 27 |
2 files changed, 42 insertions, 5 deletions
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 40eb7e5ab78..fe397e980bd 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -1936,7 +1936,9 @@ impl<'a> fmt::Display for Initializer<'a> { fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, c: &clean::Constant) -> fmt::Result { - write!(w, "<pre class='rust const'>{vis}const \ + write!(w, "<pre class='rust const'>")?; + render_attributes(w, it)?; + write!(w, "{vis}const \ {name}: {typ}{init}</pre>", vis = VisSpace(&it.visibility), name = it.name.as_ref().unwrap(), @@ -1947,7 +1949,9 @@ fn item_constant(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, fn item_static(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, s: &clean::Static) -> fmt::Result { - write!(w, "<pre class='rust static'>{vis}static {mutability}\ + write!(w, "<pre class='rust static'>")?; + render_attributes(w, it)?; + write!(w, "{vis}static {mutability}\ {name}: {typ}{init}</pre>", vis = VisSpace(&it.visibility), mutability = MutableSpace(s.mutability), @@ -1971,7 +1975,9 @@ fn item_function(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, AbiSpace(f.abi), it.name.as_ref().unwrap(), f.generics).len(); - write!(w, "<pre class='rust fn'>{vis}{constness}{unsafety}{abi}fn \ + write!(w, "<pre class='rust fn'>")?; + render_attributes(w, it)?; + write!(w, "{vis}{constness}{unsafety}{abi}fn \ {name}{generics}{decl}{where_clause}</pre>", vis = VisSpace(&it.visibility), constness = ConstnessSpace(vis_constness), @@ -2006,7 +2012,9 @@ fn item_trait(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, } // Output the trait definition - write!(w, "<pre class='rust trait'>{}{}trait {}{}{}{} ", + write!(w, "<pre class='rust trait'>")?; + render_attributes(w, it)?; + write!(w, "{}{}trait {}{}{}{} ", VisSpace(&it.visibility), UnsafetySpace(t.unsafety), it.name.as_ref().unwrap(), @@ -2987,7 +2995,9 @@ fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLi fn item_typedef(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item, t: &clean::Typedef) -> fmt::Result { let indent = format!("type {}{:#} ", it.name.as_ref().unwrap(), t.generics).len(); - write!(w, "<pre class='rust typedef'>type {}{}{where_clause} = {type_};</pre>", + write!(w, "<pre class='rust typedef'>")?; + render_attributes(w, it)?; + write!(w, "type {}{}{where_clause} = {type_};</pre>", it.name.as_ref().unwrap(), t.generics, where_clause = WhereClause(&t.generics, indent), diff --git a/src/test/rustdoc/attributes.rs b/src/test/rustdoc/attributes.rs new file mode 100644 index 00000000000..22e50900113 --- /dev/null +++ b/src/test/rustdoc/attributes.rs @@ -0,0 +1,27 @@ +// Copyright 2017 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_name = "foo"] + +// @has foo/fn.f.html '//*[@class="docblock attributes"]' '#[no_mangle]' +#[no_mangle] +pub extern "C" fn f() {} + +// @has foo/fn.g.html '//*[@class="docblock attributes"]' '#[export_name = "bar"]' +#[export_name = "bar"] +pub extern "C" fn g() {} + +// @has foo/enum.Foo.html '//*[@class="docblock attributes"]' '#[repr(i64)]' +// @has foo/enum.Foo.html '//*[@class="docblock attributes"]' '#[must_use]' +#[repr(i64)] +#[must_use] +pub enum Foo { + Bar, +} |
