Enum rhai_autodocs::options::SectionFormat
source · pub enum SectionFormat {
Rust,
Tabs,
}
Expand description
Options to format the display of sections marked with the #
tag in markdown.
Variants§
Rust
Display sections the same as Rust doc comments, using the default markdown titles.
Tabs
Display sections using tabs that wraps all underlying documentation in them.
NOTE: SectionFormat::fmt_sections
is called after [remove_test_code
],
so checking for code blocks and #
line start is not required because it
was supposed to be removed.
Trait Implementations§
source§impl Default for SectionFormat
impl Default for SectionFormat
source§fn default() -> SectionFormat
fn default() -> SectionFormat
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl RefUnwindSafe for SectionFormat
impl Send for SectionFormat
impl Sync for SectionFormat
impl Unpin for SectionFormat
impl UnwindSafe for SectionFormat
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more