Skip to main content

Module api_reference_generator

Module api_reference_generator 

Source
Expand description

Rich API-reference types for the trait graph visualization subsystem.

crate::api_data_structures defines a deliberately simple TraitInfo shape (description/path/methods: Vec<MethodInfo> as plain strings) that backs the modularized API reference generator (api_analyzers/api_formatters/api_generator_config/…).

The trait graph visualization system (crate::trait_explorer::graph_visualization) needs a richer shape that carries structured documentation, visibility, source location, and feature-flag metadata for each trait, associated type, and method so that it can render meaningful graphs (node coloring by stability, tooltips with signatures, filtering by feature flag, etc.). This module provides that richer shape.

The two TraitInfo shapes are intentionally independent types: this module does not modify or replace crate::api_data_structures::TraitInfo, which remains in use by the already-enabled modularized API reference system.

Re-exports§

pub use crate::api_data_structures::Visibility;

Structs§

AssociatedType
An associated type declared by a trait.
MethodInfo
A method declared by a trait.
TraitInfo
Rich description of a Rust trait definition.