bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

docs: Edit rustc_middle::middle::privacy

Browse source 
Add descriptions of `AccessLevel` and `AccessLevels`.

Add missing punctuation.
This commit is contained in:
pierwill 2020-12-21 20:00:18 -08:00
parent 11c94a1977
commit 80aa551d66
1 changed files with 6 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

10
compiler/rustc_middle/src/middle/privacy.rs
View file

@ -8,7 +8,9 @@ use rustc_macros::HashStable;
use std::fmt; use std::fmt;
use std::hash::Hash; use std::hash::Hash;
// Accessibility levels, sorted in ascending order /// Represents the levels of accessibility an item can have.
///
/// The variants are sorted in ascending order of accessibility.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, HashStable)] #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, HashStable)]
pub enum AccessLevel { pub enum AccessLevel {
/// Superset of `AccessLevel::Reachable` used to mark impl Trait items. /// Superset of `AccessLevel::Reachable` used to mark impl Trait items.
@ -18,13 +20,13 @@ pub enum AccessLevel {
/// public, then type `T` is reachable. Its values can be obtained by other crates /// public, then type `T` is reachable. Its values can be obtained by other crates
/// even if the type itself is not nameable. /// even if the type itself is not nameable.
Reachable, Reachable,
/// Public items + items accessible to other crates with help of `pub use` re-exports /// Public items + items accessible to other crates with the help of `pub use` re-exports.
Exported, Exported,
/// Items accessible to other crates directly, without help of re-exports /// Items accessible to other crates directly, without the help of re-exports.
Public, Public,
} }
// Accessibility levels for reachable HIR nodes /// Holds a map of accessibility levels for reachable HIR nodes.
#[derive(Clone)] #[derive(Clone)]
pub struct AccessLevels<Id = HirId> { pub struct AccessLevels<Id = HirId> {
pub map: FxHashMap<Id, AccessLevel>, pub map: FxHashMap<Id, AccessLevel>,