Rust Programming By Example

Hiding items from the documentation

Sometimes, we intentionally do not want to have a public item show up in the documentation. In this case, we can use the #[doc(hidden)] attribute:

#[doc(hidden)]
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum TransferType {
    Ascii,
    Image,
    Unknown,
}

For instance, this can be useful for something that is used by a macro of the crate but is not intended to be used directly by the user.