Skip to content

Commit

Permalink
Omit underscore constants from rustdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
dtolnay committed Jan 4, 2020
1 parent cd8377d commit 097126e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
26 changes: 15 additions & 11 deletions src/librustdoc/visit_ast.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use rustc::ty::TyCtxt;
use rustc::util::nodemap::{FxHashMap, FxHashSet};
use rustc_span::hygiene::MacroKind;
use rustc_span::source_map::Spanned;
use rustc_span::symbol::sym;
use rustc_span::symbol::{kw, sym};
use rustc_span::{self, Span};
use syntax::ast;

Expand Down Expand Up @@ -513,16 +513,20 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
om.statics.push(s);
}
hir::ItemKind::Const(type_, expr) => {
let s = Constant {
type_,
expr,
id: item.hir_id,
name: ident.name,
attrs: &item.attrs,
whence: item.span,
vis: &item.vis,
};
om.constants.push(s);
// Underscore constants do not correspond to a nameable item and
// so are never useful in documentation.
if ident.name != kw::Underscore {
let s = Constant {
type_,
expr,
id: item.hir_id,
name: ident.name,
attrs: &item.attrs,
whence: item.span,
vis: &item.vis,
};
om.constants.push(s);
}
}
hir::ItemKind::Trait(is_auto, unsafety, ref generics, ref bounds, ref item_ids) => {
let items = item_ids.iter().map(|ti| self.cx.tcx.hir().trait_item(ti.id)).collect();
Expand Down
7 changes: 7 additions & 0 deletions src/test/rustdoc/const-underscore.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// compile-flags: --document-private-items

// @!has const_underscore/constant._.html
const _: () = {
#[no_mangle]
extern "C" fn implementation_detail() {}
};

0 comments on commit 097126e

Please sign in to comment.