mod executable_directive

module executable_directive

Structs and Unions

struct ExecutableDirective(CrateDirective)

Struct to hold data required for documenting an executable.

The data and processing required is pretty much the same as that for a crate. Only the output directive is different. Hence, this is a newtype around the CrateDirective.

Variables

const DIRECTIVE_NAME: &'static str

Functions

fn filter_items(&mut self, max_visibility: &DirectiveVisibility) -> Vec<Directive>

fn new(source_code_file: &SourceCodeFile) -> ExecutableDirective

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

fn text(self, format: &Format, max_visibility: &DirectiveVisibility) -> Vec<String>

Generate the text for the executable’s documentation file.

Traits implemented

impl RstDirective for ExecutableDirective

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

impl MdDirective for ExecutableDirective

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

fn fence_size(&self) -> usize