Skip to content

Document Settings Preferences result types - #578

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-settings-preferences
Open

Document Settings Preferences result types#578
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-document-settings-preferences

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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, and SettingsPreferenceValueType.
  • 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, but SettingsPreferenceValue exposes this as the DoubleValue property. 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, but SettingsPreferenceValue exposes this as the IntValue property. 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, but SettingsPreferenceValue exposes this as the LongValue property. 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, but SettingsPreferenceValue exposes this as the StringValue property. 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.

Comment thread docs/xml/Android.Service.Settings.Preferences/SettingsPreferenceValueType.xml Outdated
Comment thread docs/xml/Android.Service.Settings.Preferences/GetValueResultType.xml Outdated
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers
jonathanpeppers requested review from dalexsoto and removed request for dalexsoto August 15, 2026 16:54
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