scirs2_interpolate::documentation_enhancement

Struct DocumentationAnalysisResult

pub struct DocumentationAnalysisResult {
    pub item_name: String,
    pub item_type: DocumentationItemType,
    pub coverage_score: f32,
    pub quality_assessment: QualityAssessment,
    pub issues: Vec<DocumentationIssue>,
    pub recommendations: Vec<String>,
    pub examples_status: ExamplesStatus,
}

Expand description

Result of documentation analysis for a specific item

Fields§

§item_name: String

Item name (function, type, module, etc.)

§item_type: DocumentationItemType

Item type

§coverage_score: f32

Documentation coverage score

§quality_assessment: QualityAssessment

Documentation quality assessment

§issues: Vec<DocumentationIssue>

Issues found

§recommendations: Vec<String>

Recommendations for improvement

§examples_status: ExamplesStatus

Examples present and working

Trait Implementations§

Source §

impl Clone for DocumentationAnalysisResult

Source §

fn clone(&self) -> DocumentationAnalysisResult

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for DocumentationAnalysisResult

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for DocumentationAnalysisResult

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> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. 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 §