Struct docgen::DocgenOptions

source ·
pub struct DocgenOptions {
Show 13 fields pub section_level_start: usize, pub include_private_fun: bool, pub include_specs: bool, pub specs_inlined: bool, pub include_impl: bool, pub toc_depth: usize, pub collapsed_sections: bool, pub output_directory: String, pub doc_path: Vec<String>, pub root_doc_templates: Vec<String>, pub references_file: Option<String>, pub include_dep_diagrams: bool, pub include_call_diagrams: bool,
}
Expand description

Options passed into the documentation generator.

Fields§

§section_level_start: usize

The level where we start sectioning. Often markdown sections are rendered with unnecessary large section fonts, setting this value high reduces the size.

§include_private_fun: bool

Whether to include private functions in the generated docs.

§include_specs: bool

Whether to include specifications in the generated docs.

§specs_inlined: bool

Whether to put specifications in the same section as a declaration or put them all into an independent section.

§include_impl: bool

Whether to include Move implementations.

§toc_depth: usize

Max depth to which sections are displayed in table-of-contents.

§collapsed_sections: bool

Whether to use collapsed sections (

) for impl and specs

§output_directory: String

In which directory to store output.

§doc_path: Vec<String>

In which directories to look for references.

§root_doc_templates: Vec<String>

A list of paths to files containing templates for root documents for the generated documentation.

A root document is a markdown file which contains placeholders for generated documentation content. It is also processed following the same rules than documentation comments in Move, including creation of cross-references and Move code highlighting.

A placeholder is a single line starting with a markdown quotation marker of the following form:

> {{move-include NAME_OF_MODULE_OR_SCRIPT}}
> {{move-toc}}
> {{move-index}}

These lines will be replaced by the generated content of the module or script, or a table of contents, respectively.

For a module or script which is included in the root document, no separate file is generated. References between the included and the standalone module/script content work transparently.

§references_file: Option<String>

An optional file containing reference definitions. The content of this file will be added to each generated markdown doc.

§include_dep_diagrams: bool

Whether to include dependency diagrams in the generated docs.

§include_call_diagrams: bool

Whether to include call diagrams in the generated docs.

Trait Implementations§

source§

impl Clone for DocgenOptions

source§

fn clone(&self) -> DocgenOptions

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for DocgenOptions

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for DocgenOptions

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<'de> Deserialize<'de> for DocgenOptionswhere DocgenOptions: Default,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Serialize for DocgenOptions

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,