GenerateDocumentation

Trait GenerateDocumentation 

Source
pub trait GenerateDocumentation<TY> {
    // Required method
    fn generate_documentation(
        &self,
        config: &DocumentationConfig,
        resolver: &TypeResolver,
    ) -> Result<TypedMarkdownDocumentation<TY>, DocumentationGenerationError>;
}

Required Methods§

Implementations on Foreign Types§

Source§

impl GenerateDocumentation<Component> for Component

Source§

impl GenerateDocumentation<ComponentTypeIds> for ComponentTypeIds

Source§

fn generate_documentation( &self, config: &DocumentationConfig, resolver: &TypeResolver, ) -> Result<TypedMarkdownDocumentation<ComponentTypeIds>, DocumentationGenerationError>

Source§

impl GenerateDocumentation<EntityType> for EntityType

Source§

impl GenerateDocumentation<Extension> for Extension

Source§

impl GenerateDocumentation<Extensions> for Extensions

Source§

impl GenerateDocumentation<FlowType> for FlowType

Source§

impl GenerateDocumentation<PropertyType> for PropertyType

Source§

impl GenerateDocumentation<PropertyTypes> for PropertyTypes

Source§

fn generate_documentation( &self, config: &DocumentationConfig, _resolver: &TypeResolver, ) -> Result<TypedMarkdownDocumentation<PropertyTypes>, DocumentationGenerationError>

Source§

impl GenerateDocumentation<RelationType> for RelationType

Implementors§