Struct DocumentationStandards 

pub struct DocumentationStandards {
    pub require_public_docs: bool,
    pub require_private_docs: bool,
    pub require_examples: bool,
    pub min_doc_length: usize,
}

Documentation requirements

Fields

require_public_docs: bool

Require documentation for all public items

require_private_docs: bool

Require documentation for private items

require_examples: bool

Require examples in documentation

min_doc_length: usize

Minimum documentation length (words)

Trait Implementations

impl Clone for DocumentationStandards

fn clone(&self) -> DocumentationStandards

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentationStandards

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentationStandards

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentationStandards

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.