Trait GenerateDocs

pub trait GenerateDocs {
    type Error;

    // Required method
    fn generate_docs<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
}

Required Associated Types

type Error

Required Methods

fn generate_docs<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Implementations on Foreign Types

impl<P, H: CrateHandleInterface<P>> GenerateDocs for Workspace<P, H>

where for<'async_trait> P: From<PathBuf> + AsRef<Path> + Send + Sync + 'async_trait,

fn generate_docs<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), WorkspaceError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generates the documentation for the entire workspace by running cargo doc.

type Error = WorkspaceError

Implementors