Struct ModularApiReferenceGenerator 

pub struct ModularApiReferenceGenerator { /* private fields */ }

Main API reference generator with comprehensive formatting capabilities

Implementations

impl ApiReferenceGenerator

pub fn new(config: GeneratorConfig) -> ApiReferenceGenerator

Create a new API reference generator with the given configuration

pub fn generate_from_crate( &mut self, crate_name: &str, ) -> Result<ApiReference, SklearsError>

Generate API reference from a Rust crate

pub fn generate_from_files( &mut self, source_files: Vec<PathBuf>, ) -> Result<ApiReference, SklearsError>

Generate API reference from source files

pub fn format_output( &self, api_ref: &ApiReference, ) -> Result<String, SklearsError>

Format API reference to the configured output format

pub fn format_as( &self, api_ref: &ApiReference, format: OutputFormat, ) -> Result<String, SklearsError>

Format API reference to a specific output format

pub fn formatter(&self) -> &DocumentFormatter

Get the document formatter

pub fn formatter_mut(&mut self) -> &mut DocumentFormatter

Get a mutable reference to the document formatter

Trait Implementations

impl Debug for ApiReferenceGenerator

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

Formats the value using the given formatter.

impl Default for ApiReferenceGenerator

fn default() -> ApiReferenceGenerator

Returns the “default value” for a type.