Rewrite XML doc comments for consistency across the solution#150
Merged
petesramek merged 1 commit intodevelop/1.0from Apr 3, 2026
Merged
Rewrite XML doc comments for consistency across the solution#150petesramek merged 1 commit intodevelop/1.0from
petesramek merged 1 commit intodevelop/1.0from
Conversation
Agent-Logs-Url: https://github.com/petesramek/polyline-algorithm-csharp/sessions/9a8e453b-a0ad-4668-a907-436b1337bb29 Co-authored-by: petesramek <2333452+petesramek@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
petesramek
April 3, 2026 13:44
View session
petesramek
approved these changes
Apr 3, 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
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.
XML comments were inconsistent: abbreviated inline param/exception docs mixed with full expanded blocks, missing
<typeparam>on generic types, empty<exception>tags, broken<see cref>and<paramref>references, a missing copyright header, and a typo.Changes
AbstractPolylineDecoder— Added<typeparam>docs; expanded the abbreviatedDecode(polyline, CancellationToken)overload to full form includingOperationCanceledException; added<param>/<exception>toValidateFormat; added full docs to abstractGetReadOnlyMemoryandCreateCoordinate; simplified private helper summaries to single sentencesAbstractPolylineEncoder— Added<typeparam>docs; removed incorrect<exception cref="InternalBufferOverflowException"/>(wrong type); added description to empty<exception cref="InvalidOperationException"/>PolylineEncodingOptionsBuilder— Standardized all three builder<returns>to"The current PolylineEncodingOptionsBuilder instance for method chaining."; simplifiedWithPrecisionsummaryPolylineEncoding— Removed stale<paramref name="rounding"/>(no such parameter onNormalize); fixed<see cref="GetCharCount"/>→<see cref="GetRequiredBufferSize"/>PolylineEncoderExtensions— Added missing copyright header; added<typeparam>docs; updated method summaries/returns to referenceTCoordinate/TPolylinerather than concrete types; added<exception>for nullcoordinatesPolylineDecoderExtensions— Added<exception cref="ArgumentNullException">for nullpolylineonstringandchar[]overloadsCoordinateDelta— Removed blank lines between closing doc tags and method declarations; moved second<summary>sentence to<remarks>Defaults— Added missing<summary>onCoordinatenested class; fixed typo"vakues"→"values"; added missing trailing period