Skip to content

Add XML docs to all publicly exposed extensions#2

Merged
Tyrrrz merged 3 commits intoprimefrom
copilot/add-xml-docs-to-extensions
Apr 12, 2026
Merged

Add XML docs to all publicly exposed extensions#2
Tyrrrz merged 3 commits intoprimefrom
copilot/add-xml-docs-to-extensions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 12, 2026

Adds /// <summary> XML documentation to every public method and property across all extension files and Disposable.

  • EnumerableExtensionsToSingletonEnumerable, WhereNotNull (reference + value type), WhereNotNullOrEmpty, WhereNotNullOrWhiteSpace, FirstOrNull, LastOrNull, ElementAtOrNull
  • AsyncEnumerableExtensionsTakeAsync, SelectManyAsync, ToListAsync, GetAwaiter
  • ComparableExtensionsClamp, Min, Max
  • ExceptionExtensionsGetSelfAndDescendants
  • FunctionalExtensionsPipe, NullIf, NullIfDefault, NullIfEmpty, NullIfWhiteSpace
  • PathExtensionsGetInvalidFileNameChars, GetInvalidPathChars, EscapeFileName
  • StreamExtensions — three CopyToAsync overloads
  • StringExtensionsSubstringUntil, SubstringUntilLast, SubstringAfter, SubstringAfterLast, Truncate, SeparateWords, ToKebabCase, ToSnakeCase
  • StringBuilderExtensionsAppendIfNotEmpty, Trim
  • TextReaderExtensionsReadLinesAsync
  • AggregateExceptionExtensionsTryGetSingle
  • Disposable — class-level summary, Dispose, Null, Create, Merge

Copy link
Copy Markdown
Owner

@Tyrrrz Tyrrrz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

}

/// <summary>
/// Projects each element of the async sequence to an <see cref="IEnumerable{T}"/>
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Projects each element of the async sequence to an <see cref="IEnumerable{T}"/>
/// Projects each element of the async sequence to an <see cref="IEnumerable{T}" />

Always leave a space before />

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 9e94ffc — added a space before /> in all self-closing XML doc tags across all files.

@Tyrrrz Tyrrrz marked this pull request as ready for review April 12, 2026 11:36
Copilot AI review requested due to automatic review settings April 12, 2026 11:36
Agent-Logs-Url: https://github.com/Tyrrrz/PowerKit/sessions/ad2a6f68-313c-436f-a9b0-afd0e92a1fe4

Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds XML <summary> documentation (and a few <inheritdoc /> usages) to extension methods and the Disposable utility to improve IntelliSense and generated API docs consistency across PowerKit.

Changes:

  • Added <summary> XML docs to extension methods across the PowerKit.Extensions set.
  • Added class/member XML docs to Disposable, including docs for Null, Create, and Merge.
  • Standardized brief behavioral descriptions for string/stream/path/sequence helpers.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
PowerKit/Extensions/TextReaderExtensions.cs Adds XML summary for ReadLinesAsync.
PowerKit/Extensions/StringExtensions.cs Adds XML summaries for substring helpers, truncation, word separation, and casing helpers.
PowerKit/Extensions/StringBuilderExtensions.cs Adds XML summaries for AppendIfNotEmpty and Trim.
PowerKit/Extensions/StreamExtensions.cs Adds XML summaries for CopyToAsync overloads (autoflush/progress variants).
PowerKit/Extensions/PathExtensions.cs Adds XML summaries for invalid char helpers and EscapeFileName.
PowerKit/Extensions/FunctionalExtensions.cs Adds XML summaries for Pipe and NullIf* helpers.
PowerKit/Extensions/ExceptionExtensions.cs Adds XML summary for GetSelfAndDescendants.
PowerKit/Extensions/EnumerableExtensions.cs Adds XML summaries for singleton wrapping, filtering, and *OrNull helpers.
PowerKit/Extensions/ComparableExtensions.cs Adds XML summaries for Clamp, Min, Max.
PowerKit/Extensions/AsyncEnumerableExtensions.cs Adds XML summaries for async sequence helpers (TakeAsync, SelectManyAsync, ToListAsync, GetAwaiter).
PowerKit/Extensions/AggregateExceptionExtensions.cs Adds XML summary for TryGetSingle.
PowerKit/Disposable.cs Adds XML docs for the type and core factory/composition members.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread PowerKit/Extensions/AsyncEnumerableExtensions.cs Outdated
Comment thread PowerKit/Extensions/StringExtensions.cs
Copilot AI requested a review from Tyrrrz April 12, 2026 11:40
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants