Skip to content

Commit

Permalink
copy some docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdageek committed Sep 12, 2024
1 parent f2844ae commit a36919b
Showing 1 changed file with 14 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit a36919b

Please sign in to comment.