Skip to content
This repository has been archived by the owner on May 29, 2024. It is now read-only.

Commit

Permalink
Update docs using dotnet/java-interop@d64087cf (#29)
Browse files Browse the repository at this point in the history
Fixes: dotnet/java-interop#933
Context: dotnet/java-interop#931
Context: dotnet/java-interop#932

Changes: dotnet/java-interop@087684a...d64087c

Changes: dotnet/android@aea70ca...05dd813

Changes of note:

  * Includes a bunch of fixes for method overloads.

  * Documentation URLs have been updated to *better* match what the
    Android doc link should be.
    *Note*: these are still not all *correct*; See dotnet/java-interop#931
    and dotnet/java-interop#932.

No new documentation warnings or suggestions have been introduced:

    Total Build Warnings | 1124
    Total Build Suggestions | 902
  • Loading branch information
pjcollins authored Dec 15, 2021
1 parent b408444 commit a7e9149
Show file tree
Hide file tree
Showing 1,264 changed files with 22,940 additions and 20,157 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,8 @@
<Parameter Name="handler" Type="Android.OS.Handler" />
</Parameters>
<Docs>
<param name="handler">To be added.</param>
<param name="callback">the callback to add, must be non-null</param>
<param name="handler">To be added.</param>
<summary>Registers the provided <c>AccessibilityButtonCallback</c> for interaction and state
changes callbacks related to the accessibility button.</summary>
<remarks>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2332,13 +2332,15 @@
<Parameter Name="displayId" Type="System.Int32" />
</Parameters>
<Docs>
<param name="displayId">To be added.</param>
<summary>Returns the controller for the accessibility button within the system's navigation area.</summary>
<param name="displayId">The logic display id, use <c>Display#DEFAULT_DISPLAY</c> for default
display.</param>
<summary>Returns the controller of specified logical display for the accessibility button within the
system's navigation area.</summary>
<returns>the accessibility button controller for this <c>AccessibilityService</c></returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityService#getAccessibilityButtonController()" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityService.getAccessibilityButtonController()</code>.</a>
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityService#getAccessibilityButtonController(int)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityService.getAccessibilityButtonController(int)</code>.</a>
</format>
</para>
<para>
Expand Down Expand Up @@ -3173,15 +3175,14 @@
<Parameter Name="gestureEvent" Type="Android.AccessibilityServices.AccessibilityGestureEvent" />
</Parameters>
<Docs>
<param name="gestureEvent">To be added.</param>
<param name="gestureId">The unique id of the performed gesture.</param>
<summary>Called by <c>#onGesture(AccessibilityGestureEvent)</c> when the user performs a specific
gesture on the default display.</summary>
<param name="gestureEvent">The information of gesture.</param>
<summary>Called by the system when the user performs a specific gesture on the
specific touch screen.</summary>
<returns>Whether the gesture was handled.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityService#onGesture(int)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityService.onGesture(int)</code>.</a>
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityService#onGesture(android.accessibilityservice.AccessibilityGestureEvent)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityService.onGesture(android.accessibilityservice.AccessibilityGestureEvent)</code>.</a>
</format>
</para>
<para>
Expand Down
97 changes: 57 additions & 40 deletions docs/Mono.Android/en/Android.Accounts/AccountManager.xml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accounts/AccountManagerFuture#getResult()" title="Reference documentation">Java documentation for <code>android.accounts.AccountManagerFuture.getResult()</code>.</a>
<a href="https://developer.android.com/reference/android/accounts/AccountManagerFuture#getResult(long,%20java.util.concurrent.TimeUnit)" title="Reference documentation">Java documentation for <code>android.accounts.AccountManagerFuture.getResult(long, java.util.concurrent.TimeUnit)</code>.</a>
</format>
</para>
<para>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mono.Android/en/Android.Animation/AnimatorSet.xml
Original file line number Diff line number Diff line change
Expand Up @@ -366,7 +366,7 @@
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/AnimatorSet#playSequentially(android.animation.Animator)" title="Reference documentation">Java documentation for <code>android.animation.AnimatorSet.playSequentially(android.animation.Animator)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/AnimatorSet#playSequentially(java.util.List)" title="Reference documentation">Java documentation for <code>android.animation.AnimatorSet.playSequentially(java.util.List)</code>.</a>
</format>
</para>
<para>
Expand Down Expand Up @@ -451,7 +451,7 @@
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/AnimatorSet#playTogether(android.animation.Animator)" title="Reference documentation">Java documentation for <code>android.animation.AnimatorSet.playTogether(android.animation.Animator)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/AnimatorSet#playTogether(java.util.Collection)" title="Reference documentation">Java documentation for <code>android.animation.AnimatorSet.playTogether(java.util.Collection)</code>.</a>
</format>
</para>
<para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@
<Parameter Name="reuseArray" Type="System.Single[]" />
</Parameters>
<Docs>
<param name="reuseArray">To be added.</param>
<summary>Create a FloatArrayEvaluator that does not reuse the animated value.</summary>
<param name="reuseArray">The array to modify and return from &lt;code&gt;evaluate&lt;/code&gt;.</param>
<summary>Create a FloatArrayEvaluator that reuses &lt;code&gt;reuseArray&lt;/code&gt; for every evaluate() call.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/FloatArrayEvaluator#FloatArrayEvaluator()" title="Reference documentation">Java documentation for <code>android.animation.FloatArrayEvaluator.FloatArrayEvaluator()</code>.</a>
<a href="https://developer.android.com/reference/android/animation/FloatArrayEvaluator#FloatArrayEvaluator(float[])" title="Reference documentation">Java documentation for <code>android.animation.FloatArrayEvaluator.FloatArrayEvaluator(float[])</code>.</a>
</format>
</para>
<para>
Expand Down
6 changes: 3 additions & 3 deletions docs/Mono.Android/en/Android.Animation/IntArrayEvaluator.xml
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@
<Parameter Name="reuseArray" Type="System.Int32[]" />
</Parameters>
<Docs>
<param name="reuseArray">To be added.</param>
<summary>Create an IntArrayEvaluator that does not reuse the animated value.</summary>
<param name="reuseArray">The array to modify and return from &lt;code&gt;evaluate&lt;/code&gt;.</param>
<summary>Create an IntArrayEvaluator that reuses &lt;code&gt;reuseArray&lt;/code&gt; for every evaluate() call.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/IntArrayEvaluator#IntArrayEvaluator()" title="Reference documentation">Java documentation for <code>android.animation.IntArrayEvaluator.IntArrayEvaluator()</code>.</a>
<a href="https://developer.android.com/reference/android/animation/IntArrayEvaluator#IntArrayEvaluator(int[])" title="Reference documentation">Java documentation for <code>android.animation.IntArrayEvaluator.IntArrayEvaluator(int[])</code>.</a>
</format>
</para>
<para>
Expand Down
36 changes: 16 additions & 20 deletions docs/Mono.Android/en/Android.Animation/Keyframe.xml
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,7 @@
</ReturnValue>
<Docs>
<summary>Gets the optional interpolator for this Keyframe. -or- Sets the optional interpolator for this Keyframe.</summary>
<value>The optional interpolator for this Keyframe.</value>
<value>The optional interpolator for this Keyframe.</value>
<returns>The optional interpolator for this Keyframe.</returns>
<remarks>
<para>Property getter documentation:</para>
<para>
Expand Down Expand Up @@ -361,18 +360,17 @@
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<param name="value">The value that the object will animate to as the animation time approaches
the time in this keyframe, and the the value animated from as the time passes the time in
this keyframe.
</param>
<param name="fraction">The time, expressed as a value between 0 and 1, representing the fraction
of time elapsed of the overall animation duration.</param>
<summary>Constructs a Keyframe object with the given time.</summary>
<param name="value">The value that the object will animate to as the animation time approaches
the time in this keyframe, and the value animated from as the time passes the time in
this keyframe.</param>
<summary>Constructs a Keyframe object with the given time and value.</summary>
<returns>To be added.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/Keyframe#ofFloat(float)" title="Reference documentation">Java documentation for <code>android.animation.Keyframe.ofFloat(float)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/Keyframe#ofFloat(float,%20float)" title="Reference documentation">Java documentation for <code>android.animation.Keyframe.ofFloat(float, float)</code>.</a>
</format>
</para>
<para>
Expand Down Expand Up @@ -450,18 +448,17 @@
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<param name="value">The value that the object will animate to as the animation time approaches
the time in this keyframe, and the the value animated from as the time passes the time in
this keyframe.
</param>
<param name="fraction">The time, expressed as a value between 0 and 1, representing the fraction
of time elapsed of the overall animation duration.</param>
<summary>Constructs a Keyframe object with the given time.</summary>
<param name="value">The value that the object will animate to as the animation time approaches
the time in this keyframe, and the value animated from as the time passes the time in
this keyframe.</param>
<summary>Constructs a Keyframe object with the given time and value.</summary>
<returns>To be added.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/Keyframe#ofInt(float)" title="Reference documentation">Java documentation for <code>android.animation.Keyframe.ofInt(float)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/Keyframe#ofInt(float,%20int)" title="Reference documentation">Java documentation for <code>android.animation.Keyframe.ofInt(float, int)</code>.</a>
</format>
</para>
<para>
Expand Down Expand Up @@ -539,18 +536,17 @@
<Parameter Name="value" Type="Java.Lang.Object" />
</Parameters>
<Docs>
<param name="value">The value that the object will animate to as the animation time approaches
the time in this keyframe, and the the value animated from as the time passes the time in
this keyframe.
</param>
<param name="fraction">The time, expressed as a value between 0 and 1, representing the fraction
of time elapsed of the overall animation duration.</param>
<summary>Constructs a Keyframe object with the given time.</summary>
<param name="value">The value that the object will animate to as the animation time approaches
the time in this keyframe, and the value animated from as the time passes the time in
this keyframe.</param>
<summary>Constructs a Keyframe object with the given time and value.</summary>
<returns>To be added.</returns>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/Keyframe#ofObject(float)" title="Reference documentation">Java documentation for <code>android.animation.Keyframe.ofObject(float)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/Keyframe#ofObject(float,%20java.lang.Object)" title="Reference documentation">Java documentation for <code>android.animation.Keyframe.ofObject(float, java.lang.Object)</code>.</a>
</format>
</para>
<para>
Expand Down
24 changes: 10 additions & 14 deletions docs/Mono.Android/en/Android.Animation/LayoutTransition.xml
Original file line number Diff line number Diff line change
Expand Up @@ -833,14 +833,13 @@
<param name="parent">The parent ViewGroup of the View being hidden.</param>
<param name="child">The View being hidden.</param>
<param name="newVisibility">The new visibility value of the child View, either
<see cref="F:Android.Views.ViewStates.Gone" tool="ReplaceLinkValue" /> or <see cref="F:Android.Views.ViewStates.Invisible" tool="ReplaceLinkValue" />.
</param>
<c>View#GONE</c> or <c>View#INVISIBLE</c>.</param>
<summary>This method is called by ViewGroup when a child view is about to be hidden in
container.</summary>
container.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/LayoutTransition#hideChild(android.view.ViewGroup,%20android.view.View)" title="Reference documentation">Java documentation for <code>android.animation.LayoutTransition.hideChild(android.view.ViewGroup, android.view.View)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/LayoutTransition#hideChild(android.view.ViewGroup,%20android.view.View,%20int)" title="Reference documentation">Java documentation for <code>android.animation.LayoutTransition.hideChild(android.view.ViewGroup, android.view.View, int)</code>.</a>
</format>
</para>
<para>
Expand Down Expand Up @@ -1207,15 +1206,13 @@
<Parameter Name="duration" Type="System.Int64" />
</Parameters>
<Docs>
<param name="transitionType">One of <c>#CHANGE_APPEARING</c>, <c>#CHANGE_DISAPPEARING</c>,
<c>#CHANGING</c>, <c>#APPEARING</c>, or <c>#DISAPPEARING</c>, which determines
the animation whose duration is being set.</param>
<param name="duration">The length of time, in milliseconds, that the specified animation should run.</param>
<summary>Sets the duration on one of the animation objects used by this transition.</summary>
<param name="duration">The length of time, in milliseconds, that the transition animations
should last.</param>
<summary>Sets the duration to be used by all animations of this transition object.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/LayoutTransition#setDuration(int,%20long)" title="Reference documentation">Java documentation for <code>android.animation.LayoutTransition.setDuration(int, long)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/LayoutTransition#setDuration(long)" title="Reference documentation">Java documentation for <code>android.animation.LayoutTransition.setDuration(long)</code>.</a>
</format>
</para>
<para>
Expand Down Expand Up @@ -1517,14 +1514,13 @@
<param name="parent">The ViewGroup in which the View is being made visible.</param>
<param name="child">The View being made visible.</param>
<param name="oldVisibility">The previous visibility value of the child View, either
<see cref="F:Android.Views.ViewStates.Gone" tool="ReplaceLinkValue" /> or <see cref="F:Android.Views.ViewStates.Invisible" tool="ReplaceLinkValue" />.
</param>
<c>View#GONE</c> or <c>View#INVISIBLE</c>.</param>
<summary>This method is called by ViewGroup when a child view is about to be made visible in the
container.</summary>
container.</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/animation/LayoutTransition#showChild(android.view.ViewGroup,%20android.view.View)" title="Reference documentation">Java documentation for <code>android.animation.LayoutTransition.showChild(android.view.ViewGroup, android.view.View)</code>.</a>
<a href="https://developer.android.com/reference/android/animation/LayoutTransition#showChild(android.view.ViewGroup,%20android.view.View,%20int)" title="Reference documentation">Java documentation for <code>android.animation.LayoutTransition.showChild(android.view.ViewGroup, android.view.View, int)</code>.</a>
</format>
</para>
<para>
Expand Down
Loading

0 comments on commit a7e9149

Please sign in to comment.