pub struct DocGenerator { /* private fields */ }Expand description
Documentation generator
Implementations§
Source§impl DocGenerator
impl DocGenerator
pub fn new(config: DocConfig) -> Self
pub fn with_python_source(self, source: String) -> Self
Sourcepub fn generate_docs(&self, module: &HirModule) -> String
pub fn generate_docs(&self, module: &HirModule) -> String
Generate documentation for a HIR module
Source§impl DocGenerator
impl DocGenerator
Sourcepub fn generate_api_reference(&self, module: &HirModule) -> String
pub fn generate_api_reference(&self, module: &HirModule) -> String
Generate API reference documentation
Sourcepub fn generate_usage_guide(&self, module: &HirModule) -> String
pub fn generate_usage_guide(&self, module: &HirModule) -> String
Generate usage guide with examples
Auto Trait Implementations§
impl Freeze for DocGenerator
impl RefUnwindSafe for DocGenerator
impl Send for DocGenerator
impl Sync for DocGenerator
impl Unpin for DocGenerator
impl UnwindSafe for DocGenerator
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
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more