mod type_directive

module type_directive

Implementation of the rust:type directive

Macros

macro type_from_item

DRY macro to create TypeDirective from various syn structs.

Structs and Unions

struct TypeDirective

Struct to hold the data for documenting type definitions.

name: String

The Rust path of the type.

ident: String

The identifier of the type.

options: Vec<DirectiveOption>

The options of the directive.

content: Vec<String>

The content of the directive.

Implementations

impl TypeDirective

Variables

const DIRECTIVE_NAME: &'static str

Functions

fn change_parent(&mut self, new_parent: &str)

Change the parent module of the type.

fn directive_visibility(&self) -> &DirectiveVisibility

Return the visibility of this directive.

fn from_extern(parent_path: &str, item: &ForeignItemType) -> Directive

Create a type directive from a foreign type definition.

fn from_impl_item(parent_path: &str, item: &ImplItemType, inherited_visibility: &Option<&Visibility>) -> Directive

Create a type directive from a type definition within an impl block.

fn from_item(parent_path: &str, item: &ItemType) -> Directive

Create a type directive from a type definition.

fn from_trait_item(parent_path: &str, item: &TraitItemType, inherited_visibility: &Option<&Visibility>) -> Directive

Create a type directive from a type definition within a trait definition.

Traits implemented

impl RstDirective for TypeDirective

Functions

fn get_rst_text(self, level: usize, max_visibility: &DirectiveVisibility) -> Vec<String>

impl MdDirective for TypeDirective

Functions

fn get_md_text(self, fence_size: usize, max_visibility: &DirectiveVisibility) -> Vec<String>