`mod executable_directive`

module executable_directive

Implementation of the rust: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.

Implementations

impl ExecutableDirective

Variables

const DIRECTIVE_NAME: &'static str

Functions

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

fn new(rc: &RuntimeConfiguration, source_code_file: &SourceCodeFile) -> ExecutableDirective: Create a new ExecutableDirective for the executable from the source file.

Traits implemented

impl RstDirective for ExecutableDirective

Functions

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

impl MdDirective for ExecutableDirective

Functions

fn fence_size(&self) -> usize

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

impl FileTopLevelDirective for ExecutableDirective

Functions

fn get_doc_file(&self) -> &Path

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

mod executable_directive

`mod executable_directive`