Add missing XML comments to clear CS1591 build warnings - #1002
Merged
Conversation
Adds XML documentation to publicly visible members in uSync.BackOffice that were triggering CS1591 warnings during the build, using <inheritdoc /> for members that override a documented base member and written summaries elsewhere. No behavioural changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This was referenced Aug 18, 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
1 participant
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.
What
Adds XML documentation to publicly visible members in uSync.BackOffice that were producing
CS1591(Missing XML comment for publicly visible type or member) warnings during the build.Why
The build was emitting 48
CS1591warnings (24 unique members). This clears all of them so the documentation-generation warnings no longer add noise to the build output.How
<inheritdoc />for members that override an already-documented base member.<summary>docs for base/virtual/abstract members and types that had nothing to inherit from.Files touched
SyncHandlers/SyncHandlerRoot.cs— base virtual members (DeserializeItemToAction,GetChangesAsync,IsItemCurrentAsync,GetNameFromFileOrNode) and the nestedSyncChangeInfoclass + properties.SyncHandlers/Handlers/PublishableContentHandlerBase.cs— class,ContainerType, constructor,GetRootItems,ProcessItem.SyncHandlers/Handlers/ElementHandler.cs— class, constructor, and members (mix of<inheritdoc />and summaries).SyncHandlers/Handlers/ContentHandler.cs—GetRootItems(<inheritdoc />).HealthChecks/SyncFolderIntegrityChecks.cs— parameterless constructor.Notes for reviewers
CS1591count confirmed at 0 after a cleanReleaserebuild (Build succeeded).CS0618(obsolete API usage) and oneCS8632warning remain and were intentionally left out of scope.🤖 Generated with Claude Code