Skip to content

Rewrite XML doc comments for consistency across the solution#150

Merged
petesramek merged 1 commit intodevelop/1.0from
copilot/develop-10-rewrite-xml-comments
Apr 3, 2026
Merged

Rewrite XML doc comments for consistency across the solution#150
petesramek merged 1 commit intodevelop/1.0from
copilot/develop-10-rewrite-xml-comments

Conversation

Copy link
Copy Markdown

Copilot AI commented Apr 3, 2026

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 abbreviated Decode(polyline, CancellationToken) overload to full form including OperationCanceledException; added <param>/<exception> to ValidateFormat; added full docs to abstract GetReadOnlyMemory and CreateCoordinate; simplified private helper summaries to single sentences
  • AbstractPolylineEncoder — 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."; simplified WithPrecision summary
  • PolylineEncoding — Removed stale <paramref name="rounding"/> (no such parameter on Normalize); fixed <see cref="GetCharCount"/><see cref="GetRequiredBufferSize"/>
  • PolylineEncoderExtensions — Added missing copyright header; added <typeparam> docs; updated method summaries/returns to reference TCoordinate/TPolyline rather than concrete types; added <exception> for null coordinates
  • PolylineDecoderExtensions — Added <exception cref="ArgumentNullException"> for null polyline on string and char[] overloads
  • CoordinateDelta — Removed blank lines between closing doc tags and method declarations; moved second <summary> sentence to <remarks>
  • Defaults — Added missing <summary> on Coordinate nested class; fixed typo "vakues""values"; added missing trailing period

@petesramek petesramek merged commit 7d7ab01 into develop/1.0 Apr 3, 2026
8 of 9 checks passed
@petesramek petesramek deleted the copilot/develop-10-rewrite-xml-comments branch April 3, 2026 13:46
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.

2 participants