Add Junie/Gemini generated XML doc headers to half of the ViewModels.#3251
Merged
mergify[bot] merged 5 commits intoBornToBeRoot:mainfrom Dec 8, 2025
Merged
Add Junie/Gemini generated XML doc headers to half of the ViewModels.#3251mergify[bot] merged 5 commits intoBornToBeRoot:mainfrom
mergify[bot] merged 5 commits intoBornToBeRoot:mainfrom
Conversation
Signed-off-by: Manuel Ullmann <manuel.ullmann@rediecon.com>
Signed-off-by: Manuel Ullmann <manuel.ullmann@rediecon.com>
Owner
|
@labre-rdc thanks again, i will review it and merge it. Some docs are better than no docs :) |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds AI-generated XML documentation comments to approximately half of the ViewModels in the project, using Junie/Gemini 3. The documentation includes summary tags for classes, properties, methods, and parameters to improve code readability and IntelliSense support.
Key Changes:
- Added XML doc comments (
<summary>,<param>,<returns>) to properties, methods, and constructors across ~40 ViewModel files - Added class-level documentation describing the purpose of each ViewModel
- Updated changelog to reflect the addition of AI-generated documentation
Reviewed changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Website/docs/changelog/next-release.md | Added changelog entry documenting the AI-generated XML documentation |
| Source/NETworkManager/ViewModels/*.cs | Added comprehensive XML documentation comments to properties, methods, constructors, and classes across multiple ViewModel files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
Guessed that. Thanks for the consideration. :) |
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.
Changes proposed in this pull request
The results of Gemini are okay and consider the context of the code. While they might contain mistakes, they could be better than the lack of such documentation. However, if you dislike AI generated documentation, feel free to reject this and/or #3250. I was just toying with the functionality.
Related issue(s)
To-Do
Contributing
By submitting this pull request, I confirm the following: