From 14798d3f5000a80044e27a8e0c80b62cbb0f0c49 Mon Sep 17 00:00:00 2001
From: Yuya Nishihara <yuya@tcha.org>
Date: Sun, 24 Nov 2024 16:40:18 +0900
Subject: [PATCH] config: add doc comment to AnnotatedValue

---
 cli/src/config.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/cli/src/config.rs b/cli/src/config.rs
index 938cb5c806..c00c2d7a14 100644
--- a/cli/src/config.rs
+++ b/cli/src/config.rs
@@ -87,11 +87,16 @@ pub enum ConfigEnvError {
     ConfigCreateError(#[from] std::io::Error),
 }
 
+/// Configuration variable with its source information.
 #[derive(Clone, Debug, PartialEq)]
 pub struct AnnotatedValue {
+    /// Dotted name path to the configuration variable.
     pub path: ConfigNamePathBuf,
+    /// Configuration value.
     pub value: config::Value,
+    /// Source of the configuration value.
     pub source: ConfigSource,
+    /// True if this value is overridden in higher precedence layers.
     pub is_overridden: bool,
 }