Merged
docs: add XML documentation to core public APIs#4942
Conversation
Add comprehensive XML doc comments (summary, param, returns, remarks, examples) to the most important public APIs in TUnit.Core that users interact with directly through IntelliSense: - Hook attributes: [Before], [After], [BeforeEvery], [AfterEvery], HookAttribute - Data source attributes: [MethodDataSource], [ClassDataSource], [MatrixDataSource], [Arguments] - Test metadata: [Explicit], [ExecutionPriority], SharedType enum - Infrastructure: TUnitAttribute, BaseTestAttribute, [ClassConstructor], [DynamicTestBuilder] - Core types: TestContext (class + key properties), TestDetails, TestResult, TestState, HookType - Interface: IDataSourceAttribute Closes #4885
thomhurst
temporarily deployed
to
Pull Requests
February 19, 2026 04:05 — with 
GitHub Actions
Inactive
thomhurst
temporarily deployed
to
Pull Requests
February 19, 2026 04:05 — with
GitHub Actions
Inactive
thomhurst
temporarily deployed
to
Pull Requests
February 19, 2026 04:05 — with
GitHub Actions
Inactive
Contributor
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. This is a well-executed documentation PR. The XML doc comments are accurate, well-structured, and cover the right APIs. A few highlights:
The PR correctly replaced placeholder comments like |
This was referenced Feb 22, 2026
Closed
This was referenced Mar 27, 2026
This was referenced Apr 4, 2026
This was referenced Apr 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/// <summary>,<param>,<returns>,<remarks>,<example>) to the most important public APIs inTUnit.Corethat users interact with directly through IntelliSenseWhat was documented
Hook attributes:
[Before],[After],[BeforeEvery],[AfterEvery],HookAttributebase classData source attributes:
[MethodDataSource](both generic and non-generic),[ClassDataSource](both generic and non-generic),[MatrixDataSource],[Arguments](both generic and non-generic),IDataSourceAttributeinterfaceTest metadata:
[Explicit],[ExecutionPriority],SharedTypeenumInfrastructure:
TUnitAttribute,BaseTestAttribute,[ClassConstructor](both generic and non-generic),[DynamicTestBuilder]Core types:
TestContext(class-level docs + all key public properties:Current,Id,Execution,Output,Metadata,Parallelism,Dependencies,StateBag,Events,Isolation,Configuration,OutputDirectory,WorkingDirectory,ClassContext,Lock,GetById),TestDetails,TestResult(all properties),TestState(all enum values),HookTypeTest plan
dotnet build TUnit.Core/TUnit.Core.csprojpasses with 0 warnings and 0 errorsCloses #4885