Skip to content

Add XML documentation to all public APIs#9

Merged
jzills merged 1 commit into
developfrom
docs/xml-documentation
Jun 9, 2026
Merged

Add XML documentation to all public APIs#9
jzills merged 1 commit into
developfrom
docs/xml-documentation

Conversation

@jzills

@jzills jzills commented Jun 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • Added and improved XML documentation comments (<summary>, <param>, <returns>, <exception>, <typeparam>) across all public types and members in the src/ directory
  • Fixed inaccurate <summary> text (wrong cref class names, copy-pasted descriptions from unrelated types, blank summaries)
  • Replaced redundant <remarks> that repeated the summary with <exception> tags where applicable (InvalidOperationException on lock timeout paths)
  • Clarified units and semantics on expiration fields (AbsoluteExpiration as Unix ms, TTL as Cosmos DB seconds, etc.)

Test plan

  • dotnet build src/ produces 0 warnings and 0 errors
  • IntelliSense tooltips in IDE show accurate, complete descriptions for all changed types

@jzills jzills enabled auto-merge (squash) June 9, 2026 01:45
@jzills jzills merged commit afe3296 into develop Jun 9, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant