bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Add some docs to rustdoc::clean::inline and def_id functions

Browse source 
Co-authored-by: Joshua Nelson <joshua@yottadb.com>
This commit is contained in:
Lzu Tao 2020-09-16 09:15:51 +00:00
parent d890e64dff
commit 63e72348d1
2 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
compiler/rustc_span/src/def_id.rs
View file

@ -159,6 +159,7 @@ impl DefId {
DefId { krate: LOCAL_CRATE, index } DefId { krate: LOCAL_CRATE, index }
} }
/// Returns whether the item is defined in the crate currently being compiled.
#[inline] #[inline]
pub fn is_local(self) -> bool { pub fn is_local(self) -> bool {
self.krate == LOCAL_CRATE self.krate == LOCAL_CRATE

3
src/librustdoc/clean/inline.rs
View file

@ -290,10 +290,12 @@ pub fn build_ty(cx: &DocContext<'_>, did: DefId) -> Option<clean::Type> {
} }
} }
/// Builds all inherent implementations of an ADT (struct/union/enum) or Trait item/path/reexport.
pub fn build_impls(cx: &DocContext<'_>, did: DefId, attrs: Option<Attrs<'_>>) -> Vec<clean::Item> { pub fn build_impls(cx: &DocContext<'_>, did: DefId, attrs: Option<Attrs<'_>>) -> Vec<clean::Item> {
let tcx = cx.tcx; let tcx = cx.tcx;
let mut impls = Vec::new(); let mut impls = Vec::new();
// for each implementation of an item represented by `did`, build the clean::Item for that impl
for &did in tcx.inherent_impls(did).iter() { for &did in tcx.inherent_impls(did).iter() {
build_impl(cx, did, attrs, &mut impls); build_impl(cx, did, attrs, &mut impls);
} }
@ -320,6 +322,7 @@ fn merge_attrs(
merged_attrs.clean(cx) merged_attrs.clean(cx)
} }
/// Builds a specific implementation of a type. The `did` could be a type method or trait method.
pub fn build_impl( pub fn build_impl(
cx: &DocContext<'_>, cx: &DocContext<'_>,
did: DefId, did: DefId,