docs icon indicating copy to clipboard operation
docs copied to clipboard

Update documentation for numerous IXCLRData* DAC interfaces, methods, and related structures / enumerations

Open wmessmer-msft opened this issue 1 year ago • 1 comments

Summary

Adds new documentation for various IXCLRData* DAC interfaces, methods, and related structures / enumerations. Such includes new method documentation for various methods on IXCLRDataProcess, IXCLRDataModule, IXCLRDataMethodInstance, and XCLRDataMethodDefinition. It also includes new interface descriptions and related method definitions for various parts of IXCLRDataTask, IXCLRDataFrame, IXCLRDataValue, IXCLRDataStackWalk, IXCLRDataTypeInstance, IXCLRDataTypeDefinition, IXCLRDataExceptionState, and the various revisions of IXCLRDataExceptionNotification. Related enumerations and structures to any newly documented interfaces and methods are also added.

All of this follows the style of the existing IXCLRData* documentation including the warning note that callers should prefer the much better supported DBI (ICorDebug) interfaces.


Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/framework/unmanaged-api/debugging/clrdatadetailedframetype-enumeration.md CLRDataDetailedFrameType Enumeration
docs/framework/unmanaged-api/debugging/clrdatafieldflag-enumeration.md "CLRDataFieldFlag Enumeration"
docs/framework/unmanaged-api/debugging/clrdatavalueflag-enumeration.md CLRDataValueFlag Enumeration
docs/framework/unmanaged-api/debugging/debugging-enumerations.md docs/framework/unmanaged-api/debugging/debugging-enumerations
docs/framework/unmanaged-api/debugging/debugging-interfaces.md Debugging Interfaces
docs/framework/unmanaged-api/debugging/debugging-structures.md "Debugging Structures"
docs/framework/unmanaged-api/debugging/gcevtargs-structure.md GcEvtArgs Structure
docs/framework/unmanaged-api/debugging/ixclrdataexceptionstate-issamestate-method.md IXCLRDataExceptionState::IsSameState Method
docs/framework/unmanaged-api/debugging/ixclrdataexceptionstate-issamestate2-method.md docs/framework/unmanaged-api/debugging/ixclrdataexceptionstate-issamestate2-method
docs/framework/unmanaged-api/debugging/ixclrdataexceptionstate-request-method.md IXCLRDataExceptionState::Request Method
docs/framework/unmanaged-api/debugging/ixclrdataframe-getargumentbyindex-method.md "IXCLRDataFrame::GetArgumentByIndex Method"
docs/framework/unmanaged-api/debugging/ixclrdataframe-getlocalvariablebyindex-method.md IXCLRDataFrame::GetLocalVariableByIndex Method
docs/framework/unmanaged-api/debugging/ixclrdatamethoddefinition-interface.md docs/framework/unmanaged-api/debugging/ixclrdatamethoddefinition-interface
docs/framework/unmanaged-api/debugging/ixclrdatamethoddefinition-request-method.md IXCLRDataMethodDefinition::Request Method
docs/framework/unmanaged-api/debugging/ixclrdatamethodinstance-getaddressrangesbyiloffset-method.md IXCLRDataMethodInstance::GetAddressRangesByILOffset Method
docs/framework/unmanaged-api/debugging/ixclrdatamethodinstance-interface.md "IXCLRDataMethodInstance Interface"
docs/framework/unmanaged-api/debugging/ixclrdatamethodinstance-request-method.md IXCLRDataMethodInstance::Request Method
docs/framework/unmanaged-api/debugging/ixclrdatamodule-interface.md docs/framework/unmanaged-api/debugging/ixclrdatamodule-interface
docs/framework/unmanaged-api/debugging/ixclrdatamodule-startenummethodinstancesbyname-method.md IXCLRDataModule::StartEnumMethodInstancesByName Method
docs/framework/unmanaged-api/debugging/ixclrdataprocess-followstub-method.md "IXCLRDataProcess::FollowStub Method"
docs/framework/unmanaged-api/debugging/ixclrdataprocess-followstub2-method.md IXCLRDataProcess::FollowStub2 Method
docs/framework/unmanaged-api/debugging/ixclrdataprocess-interface.md docs/framework/unmanaged-api/debugging/ixclrdataprocess-interface
docs/framework/unmanaged-api/debugging/ixclrdataprocess-request-method.md IXCLRDataProcess::Request Method
docs/framework/unmanaged-api/debugging/ixclrdataprocess-setcodenotifications-method.md IXCLRDataProcess::SetCodeNotifications Method
docs/framework/unmanaged-api/debugging/ixclrdatastackwalk-request-method.md "IXCLRDataStackWalk::Request Method"
docs/framework/unmanaged-api/debugging/ixclrdatatypeinstance-getstaticfieldbyindex-method.md IXCLRDataTypeInstance::GetStaticFieldByIndex Method
docs/framework/unmanaged-api/debugging/ixclrdatavalue-enumfield-method.md docs/framework/unmanaged-api/debugging/ixclrdatavalue-enumfield-method
docs/framework/unmanaged-api/debugging/ixclrdatavalue-getarrayproperties-method.md IXCLRDataValue::GetArrayProperties Method
docs/framework/unmanaged-api/debugging/ixclrdatavalue-request-method.md "IXCLRDataValue::Request Method"
docs/framework/unmanaged-api/debugging/ixclrdatavalue-startenumfieldsbyname-method.md IXCLRDataValue::StartEnumFieldsByName Method

[!NOTE] This table shows preview links for the 30 files with the most changes. For preview links for other files in this PR, select OpenPublishing.Build Details within checks.

wmessmer-msft avatar Jul 08 '24 23:07 wmessmer-msft

Just a heads up @dotnet/docs, these are old debugging APIs that were originally defined for .NET Framework but have long been private. In the past we made a few selected APIs public to aid debugging tools but now we are adding a bunch more to assist some diagnostic tooling partners that wanted to call them. We expect extremely few people to use these APIs (<10 in the world?). Given the very narrow audience that would ever look at these pages and that we expect those folks to already have area expertise we are trying to keep effort on the docs minimal. While we do care about having a basic doc available I expect time spent on editorial improvements will have very low payoff given the tiny audience.

noahfalk avatar Jul 09 '24 08:07 noahfalk