From 54d20e8e0db1d02660147a182763b332a6efbd29 Mon Sep 17 00:00:00 2001
From: Tom Longhurst <30480171+thomhurst@users.noreply.github.com>
Date: Thu, 1 Jan 2026 23:10:56 +0000
Subject: [PATCH] docs: Add XML documentation to IYaml interface (#1511)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---
 src/ModularPipelines/Context/IYaml.cs | 31 ++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/src/ModularPipelines/Context/IYaml.cs b/src/ModularPipelines/Context/IYaml.cs
index e710eb15bd..9aedfff63f 100644
--- a/src/ModularPipelines/Context/IYaml.cs
+++ b/src/ModularPipelines/Context/IYaml.cs
@@ -3,13 +3,42 @@
 
 namespace ModularPipelines.Context;
 
+/// <summary>
+/// Provides YAML serialization and deserialization functionality.
+/// </summary>
 public interface IYaml
 {
+    /// <summary>
+    /// Serializes an object to YAML string using the default camel case naming convention.
+    /// </summary>
+    /// <typeparam name="T">The type of object to serialize.</typeparam>
+    /// <param name="input">The object to serialize.</param>
+    /// <returns>The YAML string representation of the object.</returns>
     string ToYaml<T>(T input) => ToYaml(input, CamelCaseNamingConvention.Instance);
 
+    /// <summary>
+    /// Serializes an object to YAML string using the specified naming convention.
+    /// </summary>
+    /// <typeparam name="T">The type of object to serialize.</typeparam>
+    /// <param name="input">The object to serialize.</param>
+    /// <param name="namingConvention">The naming convention to use for property names.</param>
+    /// <returns>The YAML string representation of the object.</returns>
     string ToYaml<T>(T input, INamingConvention namingConvention);
 
+    /// <summary>
+    /// Deserializes a YAML string to an object using the default camel case naming convention.
+    /// </summary>
+    /// <typeparam name="T">The type to deserialize to.</typeparam>
+    /// <param name="input">The YAML string to deserialize.</param>
+    /// <returns>The deserialized object.</returns>
     T FromYaml<T>(string input) => FromYaml<T>(input, CamelCaseNamingConvention.Instance);
 
+    /// <summary>
+    /// Deserializes a YAML string to an object using the specified naming convention.
+    /// </summary>
+    /// <typeparam name="T">The type to deserialize to.</typeparam>
+    /// <param name="input">The YAML string to deserialize.</param>
+    /// <param name="namingConvention">The naming convention to use for property names.</param>
+    /// <returns>The deserialized object.</returns>
     T FromYaml<T>(string input, INamingConvention namingConvention);
-}
\ No newline at end of file
+}