mod executable_directive

module executable_directive

Implementation of the rust:executable directive.

Structs and Unions

struct ExecutableDirective

Struct to hold data required for documenting an executable.

name: String

The name of the executable.

options: Vec<DirectiveOption>

The options for the executable directive.

content: Vec<String>

The docstring for the executable’s main file.

items: Vec<Directive>

The items within the executable.

Impls

impl ExecutableDirective

const DIRECTIVE_NAME: &'static str

fn new(name: &str, ast: &File) -> ExecutableDirective

Create a new ExecutableDirective for the executable from the source file.

The generated documentation produces a rust:executable directive.

Args:

exe_name:

The name of the executable.

ast:

Reference to syn::File struct from parsing the executable’s main file.

impl MdDirective for ExecutableDirective

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

fn fence_size(&self) -> usize

impl RstDirective for ExecutableDirective

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