Skip to content

documentation: missing XML docs on core public APIs #4885

@thomhurst

Description

@thomhurst

Description

Several core public types lack XML documentation:

AbstractExecutableTest.cs (Lines 10-44)

public required string TestId { get; init; }  // No summary
public TestMetadata Metadata { get; init; } = null!;  // No summary
public required object?[] Arguments { get; init; }  // No summary

Other affected files

  • TUnit.Core/Attributes/BaseTestAttribute.cs — many public properties without docs
  • Multiple public methods/properties across TUnit.Assertions
  • AbstractDynamicTest.cs — no docs

IntelliSense shows no helpful information for these types. Some types like AsyncEvent<T> have excellent documentation, showing the standard isn't applied consistently.

Suggested Fix

Add /// <summary> XML documentation blocks to all public members on core types.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions