Struct CoverageAnalysis

Source

pub struct CoverageAnalysis {
    pub total_public_items: usize,
    pub documented_items: usize,
    pub coverage_percentage: f64,
    pub undocumented_by_category: HashMap<ItemCategory, Vec<UndocumentedItem>>,
    pub quality_by_module: HashMap<String, f64>,
}

Expand description

Documentation coverage analysis

Fields§

§total_public_items: usize

Total public items

§documented_items: usize

Documented public items

§coverage_percentage: f64

Coverage percentage

§undocumented_by_category: HashMap<ItemCategory, Vec<UndocumentedItem>>

Undocumented items by category

§quality_by_module: HashMap<String, f64>

Documentation quality scores by module

Trait Implementations§

Source §

impl Debug for CoverageAnalysis

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for CoverageAnalysis

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl UnwindSafe for CoverageAnalysis

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §