Skip to content

Document inspector API contracts #625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanpeppers merged 2 commits into from
Aug 18, 2026
+8 −8
Merged

Document inspector API contracts #625

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bbc1c21
Document inspector API contracts
jonathanpeppers Aug 17, 2026
8271c38
Address inspector docs review
jonathanpeppers Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/xml/Android.Views.Inspectors/IntFlagMapping.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,10 +106,10 @@
<Docs>
<param name="mask">The bit mask to compare to and with a value</param>
<param name="target">The target value to compare the masked value with</param>
<param name="name">The name of the flag to include if enabled</param>
<summary>Add a mutually exclusive flag to the map.</summary>
<param name="name">The non-null name of the flag to include if enabled</param>
<summary>Adds a mutually exclusive flag to the map.</summary>
<remarks>
<para>Add a mutually exclusive flag to the map.</para>
<para>Adds a mutually exclusive flag to the map.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/inspector/IntFlagMapping#add(int,%20int,%20java.lang.String)" title="Reference documentation">Java documentation for <code>android.view.inspector.IntFlagMapping.add(int, int, java.lang.String)</code>.</a>
Expand Down Expand Up @@ -151,10 +151,10 @@
</Parameters>
<Docs>
<param name="value">The value of the property</param>
<summary>Get a set of the names of enabled flags for a given property value.</summary>
<returns>The names of the enabled flags, empty if no flags enabled</returns>
<summary>Gets a set of the names of enabled flags for a given property value.</summary>
<returns>The non-null names of the enabled flags, or an empty set if no flags are enabled.</returns>
<remarks>
<para>Get a set of the names of enabled flags for a given property value.</para>
<para>Gets a set of the names of enabled flags for a given property value.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/inspector/IntFlagMapping#get(int)" title="Reference documentation">Java documentation for <code>android.view.inspector.IntFlagMapping.get(int)</code>.</a>
Expand Down
4 changes: 2 additions & 2 deletions docs/xml/Android.Views.Inspectors/WindowInspector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@
<ReturnType>System.Collections.Generic.IList&lt;Android.Views.View&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the window views attached to the current process.</summary>
<value>the list of all window views attached to the current process</value>
<summary>Gets the list of all window views attached to the current process.</summary>
<value>The non-null list of all window views attached to the current process.</value>
<remarks>
<para>
<format type="text/html">
Expand Down