Struct DocumentationGenerator 

pub struct DocumentationGenerator { /* private fields */ }

Documentation generator for API operations

Implementations

impl DocumentationGenerator

pub const fn new(specs: BTreeMap<String, CachedSpec>) -> Self

Create a new documentation generator

pub fn generate_command_help( &self, api_name: &str, tag: &str, operation_id: &str, ) -> Result<String, Error>

Generate comprehensive help for a specific command Generate command help documentation

Errors

Returns an error if the API or operation is not found

pub fn generate_api_overview(&self, api_name: &str) -> Result<String, Error>

Generate API overview with statistics

Errors

Returns an error if the API is not found

pub fn generate_interactive_menu(&self) -> String

Generate interactive help menu