doc comments for app structs

This commit is contained in:
Christoph J. Scherr 2024-03-04 17:08:05 +01:00
parent cae72977e6
commit b5810a24b2
Signed by: cscherrNT
GPG key ID: 8E2B45BC51A27EA7

View file

@ -22,6 +22,9 @@ use self::modes::Timer;
pub mod modes;
/// This application does not only offer a clock, but also a few other modes. This enum allows to
/// specify on the command line, which mode should be used and what additional options it should
/// receive.
#[derive(Debug, Subcommand)]
pub enum Mode {
/// The clock mode displays the current time, the default mode.
@ -98,6 +101,7 @@ pub enum Mode {
#[derive(clap::Parser)]
#[clap(name = "tclock", about = "A clock app in terminal", long_about = None)]
/// Represents the TUI Application that can be
pub struct App {
#[clap(subcommand)]
pub mode: Option<Mode>,