mod enum_directive

module enum_directive

Implementation of the rust:enum directive

Structs and Unions

EnumDirective

Struct to hold data for documenting an enum

name: String

The full Rust path of the enum, used as the name of the directive.

options: Vec < DirectiveOption >

The directive options to use.

content: Vec < String >

The docstring for the enum.

variants: Vec < StructDirective >

The variants within the enum.

Impls

impl EnumDirective

const DIRECTIVE_NAME: & 'static str

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

Create a new Directive::Enum from a syn::ItemEnum

Args:

parent_path:

The full path of the module the enum is in.

item:

The syn::ItemEnum to parse.

Returns:

A new Directive::Enum, which contains the parsed EnumDirective in it.

impl MdDirective for EnumDirective

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

fn fence_size (& self) -> usize

impl RstDirective for EnumDirective

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