mod crate_directive

module crate_directive

Structs and Unions

struct CrateDirective

Struct to hold data required for documenting a crate.

name: String

The name of the crate.

options: Vec<DirectiveOption>

The options for the crate directive.

content: Vec<String>

The docstring for the crate’s lib.rs file.

file_directives: FileDirectives

The directives within the crate’s document file.

Variables

const DIRECTIVE_NAME: &'static str

Functions

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

Filter out items that will not be documented due to visibility restrictions.

The function goes through all modules and identifies items that will not be documented due to the configured visibility. As part of the filtering, it will also identify any re-exports that should be inlined.

Returns:

A vec of directives that will not be documented.

fn identify_impl_parents(&mut self)

fn new(source_code_file: &SourceCodeFile) -> Self

Create a new CrateDirective for the crate from the source file.

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

Generate the text for the crate’s documentation file.

Traits implemented

impl RstDirective for CrateDirective

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

impl MdDirective for CrateDirective

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

fn fence_size(&self) -> usize