From b5810a24b2defb5c4a92ed2ee0f71be18d2eeb4c Mon Sep 17 00:00:00 2001
From: "Christoph J. Scherr" <Christoph.Scherr@newtec.de>
Date: Mon, 4 Mar 2024 17:08:05 +0100
Subject: [PATCH] doc comments for app structs

---
 clock-tui/src/app.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/clock-tui/src/app.rs b/clock-tui/src/app.rs
index a168e05..56a68a5 100644
--- a/clock-tui/src/app.rs
+++ b/clock-tui/src/app.rs
@@ -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>,