pub struct DocumentationReport {
pub readiness: DocumentationReadiness,
pub coverage_percentage: f32,
pub total_items: usize,
pub well_documented_items: usize,
pub poorly_documented_items: usize,
pub critical_issues: Vec<DocumentationIssue>,
pub analysis_results: Vec<DocumentationAnalysisResult>,
pub user_guides: Vec<UserGuide>,
pub tutorials: Vec<Tutorial>,
pub example_validations: Vec<ExampleValidation>,
pub recommendations: Vec<String>,
pub config: DocumentationConfig,
}Expand description
Complete documentation enhancement report
Fields§
§readiness: DocumentationReadinessOverall documentation readiness
coverage_percentage: f32Documentation coverage percentage
total_items: usizeTotal items analyzed
well_documented_items: usizeWell-documented items
poorly_documented_items: usizePoorly documented items
critical_issues: Vec<DocumentationIssue>Critical documentation issues
analysis_results: Vec<DocumentationAnalysisResult>Detailed analysis results
user_guides: Vec<UserGuide>Generated user guides
tutorials: Vec<Tutorial>Created tutorials
example_validations: Vec<ExampleValidation>Example validation results
recommendations: Vec<String>Recommendations for improvement
config: DocumentationConfigConfiguration used
Trait Implementations§
Source§impl Clone for DocumentationReport
impl Clone for DocumentationReport
Source§fn clone(&self) -> DocumentationReport
fn clone(&self) -> DocumentationReport
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DocumentationReport
impl Debug for DocumentationReport
Auto Trait Implementations§
impl Freeze for DocumentationReport
impl RefUnwindSafe for DocumentationReport
impl Send for DocumentationReport
impl Sync for DocumentationReport
impl Unpin for DocumentationReport
impl UnwindSafe for DocumentationReport
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.