From a36919b5a613e58ed6e2f934c727e3bd4749f492 Mon Sep 17 00:00:00 2001
From: Aleksey Kliger <alklig@microsoft.com>
Date: Wed, 11 Sep 2024 16:49:46 -0400
Subject: [PATCH] copy some docstrings

---
 .../ITarget.cs                                     | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/ITarget.cs b/src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/ITarget.cs
index be637d3d60590..2e01945d1fb23 100644
--- a/src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/ITarget.cs
+++ b/src/native/managed/cdacreader/Microsoft.Diagnostics.DataContractReader.Abstractions/ITarget.cs
@@ -8,12 +8,26 @@
 
 namespace Microsoft.Diagnostics.DataContractReader;
 
+/// <summary>
+/// Representation of the target under inspection
+/// </summary>
+/// <remarks>
+/// This class provides APIs used by contracts for reading from the target and getting type and globals
+/// information based on the target's contract descriptor. Like the contracts themselves in cdacreader,
+/// these are throwing APIs. Any callers at the boundaries (for example, unmanaged entry points, COM)
+/// should handle any exceptions.
+/// </remarks>
 internal interface ITarget
 {
     int PointerSize { get; }
 
     TargetPointer ReadGlobalPointer(string global);
 
+    /// <summary>
+    /// Read a pointer from the target in target endianness
+    /// </summary>
+    /// <param name="address">Address to start reading from</param>
+    /// <returns>Pointer read from the target</returns>}
     TargetPointer ReadPointer(ulong address);
     public TargetCodePointer ReadCodePointer(ulong address);