From 34ebab3d63b8e44b5648eb54bb8ba8b7faa954a3 Mon Sep 17 00:00:00 2001 From: JMARyA Date: Thu, 7 Mar 2024 16:44:54 +0100 Subject: [PATCH] docs --- src/config.rs | 2 ++ src/youtube/mod.rs | 1 + 2 files changed, 3 insertions(+) diff --git a/src/config.rs b/src/config.rs index 0e3edb4..818df0e 100644 --- a/src/config.rs +++ b/src/config.rs @@ -2,12 +2,14 @@ use std::path::PathBuf; use serde::{Deserialize, Serialize}; +/// General settings for hoard #[derive(Debug, Clone, Serialize, Deserialize)] pub struct HoardConfig { // Top level data download directory pub data_dir: PathBuf, } +/// Top level global config #[derive(Debug, Clone, Serialize, Deserialize)] pub struct GlobalConfig { // Hoard Configuration diff --git a/src/youtube/mod.rs b/src/youtube/mod.rs index 0c20673..53accaa 100644 --- a/src/youtube/mod.rs +++ b/src/youtube/mod.rs @@ -9,6 +9,7 @@ use serde::{Deserialize, Serialize}; use crate::{ensure_dir_exists, Module}; +/// Configuration for the YouTube Module #[derive(Debug, Clone, Serialize, Deserialize)] pub struct YouTubeConfig { // Interval in minutes between checks