Raine-gay/royal_road_archiver
1
0
Fork 0
mirror of https://github.com/Raine-gay/royal_road_archiver.git synced 2024-11-14 11:28:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated some documentation comments.

Browse source
This commit is contained in:
NA 2024-01-24 15:05:09 +00:00
parent efdf3c3ca6
commit 778b1adf6a
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/library.rs
View file

@ -3,6 +3,7 @@ use std::path::PathBuf;
use clap::Args; use clap::Args;
use url::Url; use url::Url;
/// struct that corresponds to arguments for Audiobook generation.
#[derive(Args, Debug)] #[derive(Args, Debug)]
pub struct AudiobookArgs { pub struct AudiobookArgs {
/// Disable the generation of chapter titles in the audio file. Useful to avoid chapter titles appearing twice. /// Disable the generation of chapter titles in the audio file. Useful to avoid chapter titles appearing twice.
@ -14,6 +15,7 @@ pub struct AudiobookArgs {
pub split_novel_by_chapters: bool, pub split_novel_by_chapters: bool,
} }
/// struct that corresponds to arguments for Epub generation.
#[derive(Args, Debug)] #[derive(Args, Debug)]
pub struct EpubArgs { pub struct EpubArgs {
/// Disable the inclusion of images. /// Disable the inclusion of images.
@ -22,11 +24,13 @@ pub struct EpubArgs {
pub no_images: bool, pub no_images: bool,
} }
/// struct that corresponds to arguments for Html generation.
#[derive(Args, Debug)] #[derive(Args, Debug)]
pub struct HtmlArgs { pub struct HtmlArgs {
} }
/// struct that corresponds to arguments for Markdown generation.
#[derive(Args, Debug)] #[derive(Args, Debug)]
pub struct MarkdownArgs { pub struct MarkdownArgs {
/// Disable the generation of chapter titles. Useful to avoid chapter titles appearing twice. /// Disable the generation of chapter titles. Useful to avoid chapter titles appearing twice.