chore: XML comments fixes #951
Merged
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
Inspired by appium#733.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves XML documentation comments across multiple driver and interface files by standardizing parameter descriptions and adding proper cross-references to enum types.
- Adds missing parameter descriptions for previously undocumented method parameters
- Standardizes capitalization and punctuation in parameter documentation
- Includes proper XML cross-references using
<see cref="">tags for enum types
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| IOSStartScreenRecordingOptions.cs | Updated parameter documentation for video recording methods with proper descriptions and enum references |
| IOSDriver.cs | Standardized parameter descriptions for constructor and clipboard methods with consistent capitalization |
| ScreenOrientationExtensions.cs | Added proper parameter documentation for screen orientation methods |
| INetworkActions.cs | Enhanced parameter documentation for GSM and SMS simulation methods |
| IMultiAction.cs | Added missing parameter description for touch action method |
| AndroidDriver.cs | Updated parameter documentation for clipboard and app state methods to match iOS driver |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
KazuCocoa
approved these changes
Aug 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Inspired by #733.
List of changes
XML fixes in:
Types of changes
What types of changes are you proposing/introducing to the .NET client?
Put an
xin the boxes that applyDocumentation
This can be done by navigating to the documentation section on http://appium.io selecting the appropriate command/endpoint and clicking the 'Edit this doc' link to update the C# example
Integration tests
Details
Please provide more details about changes if necessary. You can provide code samples showing how they work and possible use cases if there are new features. Also, you can create gists with pasted C# code samples or put them here using markdown.
About markdown please read Mastering markdown and Writing on GitHub