Skip to content

chore: add XML documentation for public APIs#74

Merged
georgidhristov merged 1 commit into
mainfrom
docs/add-public-api-xml-comments
May 23, 2026
Merged

chore: add XML documentation for public APIs#74
georgidhristov merged 1 commit into
mainfrom
docs/add-public-api-xml-comments

Conversation

@georgidhristov
Copy link
Copy Markdown
Collaborator

Description

Adds XML documentation comments for the main public DebugProbe APIs to improve IntelliSense and package usability for consumers.

Also suppresses CS1591 warnings globally to avoid requiring documentation for every public member.

Changes

  • Added XML docs for:
    • AddDebugProbe
    • UseDebugProbe
    • DebugProbeMiddleware
    • DebugProbeOptions
    • DebugEntryStore
  • Enabled cleaner public API IntelliSense support
  • Suppressed CS1591 warnings via project configuration

@georgidhristov georgidhristov merged commit bce70ef into main May 23, 2026
1 check passed
@georgidhristov georgidhristov deleted the docs/add-public-api-xml-comments branch May 23, 2026 15:44
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