feat: complete XML documentation in PD Core #1378
Open
+76
−17
Conversation
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR completes XML documentation across PD Core by adding missing XML documentation comments and commenting out XML docs for already-commented code blocks. The changes focus on improving code documentation for maintainability.
Changes:
- Added XML documentation for class declarations, properties, constructors, and methods in logging and web request handler components
- Commented out XML documentation that was describing commented-out code
- Fixed indentation for some existing XML comments
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| src/PepperDash.Core/Web/WebApiServer.cs | Commented out XML documentation for commented-out properties |
| src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestHandler.cs | Added XML documentation for the EnableCors field |
| src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs | Added class-level and EnableCors field XML documentation |
| src/PepperDash.Core/Logging/DebugWebsocketSink.cs | Added XML documentation for properties, constructors, methods, and extension class |
| src/PepperDash.Core/Logging/DebugExtensions.cs | Added class-level XML documentation |
| src/PepperDash.Core/Logging/DebugErrorLogSink.cs | Added XML documentation for constructor |
| src/PepperDash.Core/Logging/DebugCrestronLoggerSink.cs | Added XML documentation for constructor |
| src/PepperDash.Core/Logging/DebugConsoleSink.cs | Added XML documentation for constructor and extension class |
| src/PepperDash.Core/Device.cs | Fixed XML comment indentation and commented out docs for commented code |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs
Outdated
Show resolved
Hide resolved
src/PepperDash.Core/Web/RequestHandlers/WebApiBaseRequestAsyncHandler.cs
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Updated xml comments that were missing or malformed.