Document Settings Preferences result types - #578
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the generated XML documentation for the Android.Service.Settings.Preferences namespace by replacing “To be added.” placeholders with descriptive summaries/remarks for several result/value/sensitivity enums and by documenting SettingsPreferenceService.OnBind behavior.
Changes:
- Adds summaries/remarks (including Android reference links + AOSP/CC BY attribution) for five enum types:
GetValueResultType,MetadataResultType,SetValueResultType,SettingsPreferenceMetadataType, andSettingsPreferenceValueType. - Documents
SettingsPreferenceService.OnBind(Intent)parameter and return semantics.
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 |
|---|---|
| docs/xml/Android.Service.Settings.Preferences/GetValueResultType.xml | Adds enum/member documentation for get-value results. |
| docs/xml/Android.Service.Settings.Preferences/MetadataResultType.xml | Adds enum/member documentation for metadata request results. |
| docs/xml/Android.Service.Settings.Preferences/SetValueResultType.xml | Adds enum/member documentation for set-value results. |
| docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceMetadataType.xml | Adds enum/member documentation for preference write-sensitivity. |
| docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceService.xml | Documents OnBind parameter/return behavior. |
| docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml | Adds enum/member documentation for preference value types. |
Suppressed comments (4)
docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml:82
- The summary references a C# member named
GetDoubleValue, butSettingsPreferenceValueexposes this as theDoubleValueproperty. The current text points to an API that doesn't exist in the binding.
<summary>The value is a double. Access it through <c>GetDoubleValue</c>.</summary>
docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml:110
- The summary references a C# member named
GetIntValue, butSettingsPreferenceValueexposes this as theIntValueproperty. Please update the doc to refer to the actual binding surface area.
<summary>The value is an integer. Access it through <c>GetIntValue</c>.</summary>
docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml:138
- The summary references a C# member named
GetLongValue, butSettingsPreferenceValueexposes this as theLongValueproperty. As written, this directs readers to a method that isn't present.
<summary>The value is a long integer. Access it through <c>GetLongValue</c>.</summary>
docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml:166
- The summary references a C# member named
GetStringValue, butSettingsPreferenceValueexposes this as theStringValueproperty. This should match the actual API name in the binding.
<summary>The value is a string. Access it through <c>GetStringValue</c>.</summary>
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Summary
SettingsPreferenceService.OnBindparameters and return behavior.Sources
Validation
git diff --check.To be added.placeholders in each of the five changed enum files.Refs #184