Skip to content

Conversation

@labre-rdc
Copy link
Contributor

@labre-rdc labre-rdc commented Nov 29, 2025

Changes proposed in this pull request

  • This adds Junie/Gemini generated XML comment headers to half of the ViewModels plus 3 extra files from a prompt before I realized, how tedious the generation is and that I have to force batch processing in the prompt. This did cost 20 points of my AI quota, so consider them donated.

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)

  • None.

To-Do

Contributing

By submitting this pull request, I confirm the following:

@BornToBeRoot
Copy link
Owner

@labre-rdc thanks again, i will review it and merge it. Some docs are better than no docs :)

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@BornToBeRoot BornToBeRoot added this to the next-release milestone Nov 30, 2025
@labre-rdc
Copy link
Contributor Author

@labre-rdc thanks again, i will review it and merge it. Some docs are better than no docs :)

Guessed that. Thanks for the consideration. :)

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