Skip to content

Add docs for Android.Views.DisplayHash #431

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

Open
jonathanpeppers wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add docs for Android.Views.DisplayHash #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 9 additions & 2 deletions docs/xml/Android.Views.DisplayHash/DisplayHash+InterfaceConsts.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,15 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides constants inherited from the Android Parcelable interface.</summary>
<remarks>
<para>These constants are defined by the Android Parcelable interface.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/Parcelable" title="Reference documentation">Java documentation for <code>android.os.Parcelable</code>.</a>
</format>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="ContentsFileDescriptor">
Expand Down
47 changes: 30 additions & 17 deletions docs/xml/Android.Views.DisplayHash/DisplayHash.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,16 @@
<ReturnType>Android.OS.IParcelableCreator</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Provides the Parcelable creator that generates <see cref="T:Android.Views.DisplayHash.DisplayHash" /> instances from a <see cref="T:Android.OS.Parcel" />.</summary>
<value>The Parcelable creator for <see cref="T:Android.Views.DisplayHash.DisplayHash" /> instances.</value>
<remarks>
<para>Provides the Parcelable creator that generates <see cref="T:Android.Views.DisplayHash.DisplayHash" /> instances from a <see cref="T:Android.OS.Parcel" />.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/Parcelable" title="Reference documentation">Java documentation for <code>android.os.Parcelable</code>.</a>
</format>
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DescribeContents">
Expand Down Expand Up @@ -112,8 +119,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Describes the special objects in this Parcelable object's marshaled representation.</summary>
<returns>A bitmask identifying the special object types marshaled by this Parcelable object instance.</returns>
<remarks>
<para>
<format type="text/html">
Expand Down Expand Up @@ -155,9 +162,11 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Provides the JNI peer metadata for this type.</summary>
<value>The JNI peer metadata for this type.</value>
<remarks>
<para>Provides the JNI peer metadata for this type.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand All @@ -184,9 +193,11 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:System.IntPtr" /> which contains the <c>java.lang.Class</c> JNI value corresponding to this type.</value>
<remarks>
<para>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdType">
Expand All @@ -213,9 +224,11 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:System.Type" /> which provides the declaring type.</value>
<remarks>
<para>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteToParcel">
Expand Down Expand Up @@ -256,9 +269,9 @@
</Parameter>
</Parameters>
<Docs>
<param name="dest">To be added.</param>
<param name="flags">To be added.</param>
<summary>To be added.</summary>
<param name="dest">The Parcel in which to write this object.</param>
<param name="flags">Additional flags that control how the object is written. May be <c>0</c> or <c>ParcelableWriteReturnValue</c>.</param>
<summary>Flattens this object into a Parcel.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down
23 changes: 15 additions & 8 deletions docs/xml/Android.Views.DisplayHash/DisplayHashErrorCode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,15 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Specifies errors reported when a display hash cannot be generated.</summary>
<remarks>
<para>Specifies errors reported by <c>DisplayHashResultCallback#onDisplayHashError(int)</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/displayhash/DisplayHashResultCallback" title="Reference documentation">Java documentation for <code>android.view.displayhash.DisplayHashResultCallback</code>.</a>
</format>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="InvalidBounds">
Expand Down Expand Up @@ -40,7 +47,7 @@
</ReturnValue>
<MemberValue>-2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The bounds used when requesting the hash were invalid or empty.</summary>
</Docs>
</Member>
<Member MemberName="InvalidHashAlgorithm">
Expand Down Expand Up @@ -68,7 +75,7 @@
</ReturnValue>
<MemberValue>-5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The hash algorithm sent to generate the hash was invalid.</summary>
</Docs>
</Member>
<Member MemberName="MissingWindow">
Expand Down Expand Up @@ -96,7 +103,7 @@
</ReturnValue>
<MemberValue>-3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The window for the view that requested the hash is no longer available.</summary>
</Docs>
</Member>
<Member MemberName="NotVisibleOnScreen">
Expand Down Expand Up @@ -124,7 +131,7 @@
</ReturnValue>
<MemberValue>-4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The view that requested the hash is not visible on screen.</summary>
</Docs>
</Member>
<Member MemberName="TooManyRequests">
Expand Down Expand Up @@ -152,7 +159,7 @@
</ReturnValue>
<MemberValue>-6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The caller requested display hash generation too frequently.</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
Expand Down Expand Up @@ -180,7 +187,7 @@
</ReturnValue>
<MemberValue>-1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An unknown error occurred.</summary>
</Docs>
</Member>
</Members>
Expand Down
24 changes: 15 additions & 9 deletions docs/xml/Android.Views.DisplayHash/DisplayHashManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,11 @@
<ReturnType>Java.Interop.JniPeerMembers</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Provides the JNI peer metadata for this type.</summary>
<value>The JNI peer metadata for this type.</value>
<remarks>
<para>Provides the JNI peer metadata for this type.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SupportedHashAlgorithms">
Expand Down Expand Up @@ -138,9 +140,11 @@
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:System.IntPtr" /> which contains the <c>java.lang.Class</c> JNI value corresponding to this type.</value>
<remarks>
<para>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThresholdType">
Expand All @@ -167,9 +171,11 @@
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</summary>
<value>A <see cref="T:System.Type" /> which provides the declaring type.</value>
<remarks>
<para>This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="VerifyDisplayHash">
Expand Down
11 changes: 9 additions & 2 deletions docs/xml/Android.Views.DisplayHash/DisplayHashResultCallback.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,15 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Receives the result of a display hash generation request.</summary>
<remarks>
<para>Receives either the display hash generated by <c>View#generateDisplayHash(String, Rect, Executor, DisplayHashResultCallback)</c> or an error when generation fails.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/view/displayhash/DisplayHashResultCallback" title="Reference documentation">Java documentation for <code>android.view.displayhash.DisplayHashResultCallback</code>.</a>
</format>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="DisplayHashErrorInvalidBounds">
Expand Down
11 changes: 9 additions & 2 deletions docs/xml/Android.Views.DisplayHash/VerifiedDisplayHash+InterfaceConsts.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,15 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Provides constants inherited from the Android Parcelable interface.</summary>
<remarks>
<para>These constants are defined by the Android Parcelable interface.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/os/Parcelable" title="Reference documentation">Java documentation for <code>android.os.Parcelable</code>.</a>
</format>
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="ContentsFileDescriptor">
Expand Down
Loading