Rollup merge of #56315 - weiznich:rustdoc_inline_macro_reexport, r=QuietMisdreavus
Rustdoc inline macro reexport Fixes #56173 I assume this needs to have tests? Any pointers where these need to be added?
This commit is contained in:
commit
3073c7af5f
@ -100,7 +100,7 @@ impl<'a, 'tcx, 'rcx, 'cstore> RustdocVisitor<'a, 'tcx, 'rcx, 'cstore> {
|
||||
None);
|
||||
// attach the crate's exported macros to the top-level module:
|
||||
let macro_exports: Vec<_> =
|
||||
krate.exported_macros.iter().map(|def| self.visit_local_macro(def)).collect();
|
||||
krate.exported_macros.iter().map(|def| self.visit_local_macro(def, None)).collect();
|
||||
self.module.macros.extend(macro_exports);
|
||||
self.module.is_crate = true;
|
||||
|
||||
@ -376,6 +376,10 @@ impl<'a, 'tcx, 'rcx, 'cstore> RustdocVisitor<'a, 'tcx, 'rcx, 'cstore> {
|
||||
});
|
||||
true
|
||||
}
|
||||
Node::MacroDef(def) if !glob => {
|
||||
om.macros.push(self.visit_local_macro(def, renamed));
|
||||
true
|
||||
}
|
||||
_ => false,
|
||||
};
|
||||
self.view_item_stack.remove(&def_node_id);
|
||||
@ -593,7 +597,11 @@ impl<'a, 'tcx, 'rcx, 'cstore> RustdocVisitor<'a, 'tcx, 'rcx, 'cstore> {
|
||||
}
|
||||
|
||||
// convert each exported_macro into a doc item
|
||||
fn visit_local_macro(&self, def: &hir::MacroDef) -> Macro {
|
||||
fn visit_local_macro(
|
||||
&self,
|
||||
def: &hir::MacroDef,
|
||||
renamed: Option<ast::Name>
|
||||
) -> Macro {
|
||||
debug!("visit_local_macro: {}", def.name);
|
||||
let tts = def.body.trees().collect::<Vec<_>>();
|
||||
// Extract the spans of all matchers. They represent the "interface" of the macro.
|
||||
@ -602,7 +610,7 @@ impl<'a, 'tcx, 'rcx, 'cstore> RustdocVisitor<'a, 'tcx, 'rcx, 'cstore> {
|
||||
Macro {
|
||||
def_id: self.cx.tcx.hir.local_def_id(def.id),
|
||||
attrs: def.attrs.clone(),
|
||||
name: def.name,
|
||||
name: renamed.unwrap_or(def.name),
|
||||
whence: def.span,
|
||||
matchers,
|
||||
stab: self.stability(def.id),
|
||||
|
28
src/test/rustdoc/inline_local/macro_by_example.rs
Normal file
28
src/test/rustdoc/inline_local/macro_by_example.rs
Normal file
@ -0,0 +1,28 @@
|
||||
// Copyright 2018 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.
|
||||
|
||||
|
||||
/// docs for foo
|
||||
#[deprecated(since = "1.2.3", note = "text")]
|
||||
#[macro_export]
|
||||
macro_rules! foo {
|
||||
($($tt:tt)*) => {}
|
||||
}
|
||||
|
||||
// @has macro_by_example/macros/index.html
|
||||
pub mod macros {
|
||||
// @!has - 'pub use foo as bar;'
|
||||
// @has macro_by_example/macros/macro.bar.html
|
||||
// @has - '//*[@class="docblock"]' 'docs for foo'
|
||||
// @has - '//*[@class="stab deprecated"]' 'Deprecated since 1.2.3: text'
|
||||
// @has - '//a/@href' 'macro_by_example.rs.html#15-17'
|
||||
#[doc(inline)]
|
||||
pub use foo as bar;
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user