Struct DocPackage 

pub struct DocPackage {
    pub name: String,
    pub modules: BTreeMap<String, DocModule>,
    pub export_map: BTreeMap<String, String>,
    pub config: DocGenConfig,
}

Root documentation package structure

Fields

name: String

modules: BTreeMap<String, DocModule>

export_map: BTreeMap<String, String>

Maps item FQN to the public module where it’s exported

config: DocGenConfig

Documentation generation configuration

Implementations

impl DocPackage

pub fn normalize(&mut self)

Normalize all Vec fields for deterministic JSON output

Trait Implementations

impl Clone for DocPackage

fn clone(&self) -> DocPackage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocPackage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocPackage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocPackage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.