Struct DocumentationGenerator 

pub struct DocumentationGenerator {
    pub readme_config: ReadmeConfig,
    pub sections: HashMap<String, DocumentationSection>,
    pub api_docs: HashMap<String, ApiDocumentation>,
}

Documentation Generator

Fields

readme_config: ReadmeConfig

README configuration

sections: HashMap<String, DocumentationSection>

Documentation sections

api_docs: HashMap<String, ApiDocumentation>

API documentation

Implementations

impl DocumentationGenerator

pub fn new(config: ReadmeConfig) -> Self

Create a new documentation generator

pub fn generate_readme(&self) -> Result<String>

Generate README from project structure

pub fn extract_api_documentation( &mut self, code: &str, ) -> Result<Vec<ApiDocumentation>>

Extract API documentation from code

pub fn synchronize_documentation( &self, old_code: &str, new_code: &str, ) -> Result<SyncResult>

Synchronize documentation with code changes

pub fn calculate_coverage(&self, code: &str) -> Result<DocumentationCoverage>

Calculate documentation coverage

pub fn add_section( &mut self, key: impl Into<String>, section: DocumentationSection, )

Add a documentation section

pub fn add_api_documentation( &mut self, key: impl Into<String>, api_doc: ApiDocumentation, )

Add API documentation

pub fn get_sorted_sections(&self) -> Vec<&DocumentationSection>

Get all sections sorted by order

Trait Implementations

impl Clone for DocumentationGenerator

fn clone(&self) -> DocumentationGenerator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentationGenerator

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

Formats the value using the given formatter.