Update documentation for numerous IXCLRData* DAC interfaces, methods, and related structures / enumerations #41675
Conversation
…dule interfaces and structures
…iced cut & paste errors
|
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. |
There was a problem hiding this comment.
These files at least need to be added to the TOC so they're not orphaned - that file is here. Ideally they'd also be added to the overview pages such as https://github.com/dotnet/docs/blob/main/docs/framework/unmanaged-api/debugging/debugging-structures.md for structures.
There are also some warnings to address here - LMK if you need help with them.
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
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.