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

Commit

Permalink
Import documentation for API-34 (#52)
Browse files Browse the repository at this point in the history 
Update `Mono.Android.dll` documentation, importing the Google-provided
API-34 Javadoc documentation.

Adds side by side support for "Xamarin.Android 13" and ".NET Android 34"
versioned documentation.

Docs were updated with:
dotnet/android@df08bb3

Additional remarks content has been enabled via:
dotnet/android@07dc60b

Co-authored-by: VSC-Service-Account <[email protected]>
Co-authored-by: David Britch <[email protected]>
  • Loading branch information
@pjcollins @VSC-Service-Account @davidbritch
3 people authored Nov 28, 2023
1 parent 2d3e40a commit 3f64bdd
Show file tree
Hide file tree
Showing 9,088 changed files with 845,453 additions and 87,347 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
4 changes: 1 addition & 3 deletions .openpublishing.publish.config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
"build_source_folder": "docs/Mono.Android/en",
"build_output_subfolder": "XamarinAndroidAPI",
"locale": "en-us",
"monikers": [
"xamarin-android-sdk-13"
],
"monikers": [],
"moniker_ranges": [],
"open_to_public_contributors": false,
"type_mapping": {
Expand Down
23 changes: 23 additions & 0 deletions ...droid.AccessibilityServices/AccessibilityButtonController+AccessibilityButtonCallback.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,17 @@
<AttributeName Language="C#">[Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback", ApiSince=26, DoNotGenerateAcw=true)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback", ApiSince=26, DoNotGenerateAcw=true)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Callback for interaction with and changes to state of the accessibility button
within the system's navigation area.</summary>
<remarks>
<para>Callback for interaction with and changes to state of the accessibility button
within the system's navigation area.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController.AccessibilityButtonCallback" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.AccessibilityButtonCallback</code>.</a>
Expand Down Expand Up @@ -48,6 +54,10 @@
<AttributeName Language="C#">[Android.Runtime.Register(".ctor", "()V", "", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register(".ctor", "()V", "", ApiSince=26)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
Expand Down Expand Up @@ -126,6 +136,10 @@
<AttributeName Language="C#">[Android.Runtime.Register("onAvailabilityChanged", "(Landroid/accessibilityservice/AccessibilityButtonController;Z)V", "GetOnAvailabilityChanged_Landroid_accessibilityservice_AccessibilityButtonController_ZHandler", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("onAvailabilityChanged", "(Landroid/accessibilityservice/AccessibilityButtonController;Z)V", "GetOnAvailabilityChanged_Landroid_accessibilityservice_AccessibilityButtonController_ZHandler", ApiSince=26)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -142,6 +156,10 @@
<summary>Called when the availability of the accessibility button in the system's
navigation area has changed.</summary>
<remarks>
<para>Called when the availability of the accessibility button in the system's
navigation area has changed. The accessibility button may become unavailable
because the device shopped showing the button, the button was assigned to another
service, or for other reasons.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController.AccessibilityButtonCallback#onAvailabilityChanged(android.accessibilityservice.AccessibilityButtonController,%20boolean)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.AccessibilityButtonCallback.onAvailabilityChanged(android.accessibilityservice.AccessibilityButtonController, boolean)</code>.</a>
Expand Down Expand Up @@ -170,6 +188,10 @@
<AttributeName Language="C#">[Android.Runtime.Register("onClicked", "(Landroid/accessibilityservice/AccessibilityButtonController;)V", "GetOnClicked_Landroid_accessibilityservice_AccessibilityButtonController_Handler", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("onClicked", "(Landroid/accessibilityservice/AccessibilityButtonController;)V", "GetOnClicked_Landroid_accessibilityservice_AccessibilityButtonController_Handler", ApiSince=26)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand All @@ -181,6 +203,7 @@
<param name="controller">the controller used to register for this callback</param>
<summary>Called when the accessibility button in the system's navigation area is clicked.</summary>
<remarks>
<para>Called when the accessibility button in the system's navigation area is clicked.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController.AccessibilityButtonCallback#onClicked(android.accessibilityservice.AccessibilityButtonController)" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.AccessibilityButtonCallback.onClicked(android.accessibilityservice.AccessibilityButtonController)</code>.</a>
Expand Down
42 changes: 42 additions & 0 deletions docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityButtonController.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,31 @@
<AttributeName Language="C#">[Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController", ApiSince=26, DoNotGenerateAcw=true)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("android/accessibilityservice/AccessibilityButtonController", ApiSince=26, DoNotGenerateAcw=true)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Controller for the accessibility button within the system's navigation area</summary>
<remarks>
<para>Controller for the accessibility button within the system's navigation area</para>
<para>This class may be used to query the accessibility button's state and register
callbacks for interactions with and state changes to the accessibility button when
<c>AccessibilityServiceInfo#FLAG_REQUEST_ACCESSIBILITY_BUTTON</c> is set.</para>
<para>&lt;strong&gt;Note:&lt;/strong&gt; This class and
<c>AccessibilityServiceInfo#FLAG_REQUEST_ACCESSIBILITY_BUTTON</c> should not be used as
the sole means for offering functionality to users via an <c>AccessibilityService</c>.
Some device implementations may choose not to provide a software-rendered system
navigation area, making this affordance permanently unavailable.</para>
<para>&lt;strong&gt;Note:&lt;/strong&gt; On device implementations where the accessibility button is
supported, it may not be available at all times, such as when a foreground application uses
<c>android.view.View#SYSTEM_UI_FLAG_HIDE_NAVIGATION</c>. A user may also choose to assign
this button to another accessibility service or feature. In each of these cases, a
registered <c>AccessibilityButtonCallback</c>'s
<c>AccessibilityButtonCallback#onAvailabilityChanged(AccessibilityButtonController, boolean)</c>
method will be invoked to provide notifications of changes in the accessibility button's
availability to the registering service.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController</code>.</a>
Expand All @@ -44,6 +65,10 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: Android.Runtime.Register("isAccessibilityButtonAvailable", "()Z", "", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;get: Android.Runtime.Register("isAccessibilityButtonAvailable", "()Z", "", ApiSince=26)&gt;]</AttributeName>
Expand All @@ -59,6 +84,11 @@
<c>true</c> if the accessibility button in the system's navigation area is
available to the calling service, <c>false</c> otherwise</value>
<remarks>
<para>Retrieves whether the accessibility button in the system's navigation area is
available to the calling service.</para>
<para>&lt;strong&gt;Note:&lt;/strong&gt; If the service is not yet connected (e.g.
<c>AccessibilityService#onServiceConnected()</c> has not yet been called) or the
service has been disconnected, this method will have no effect and return <c>false</c>.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/accessibilityservice/AccessibilityButtonController#isAccessibilityButtonAvailable()" title="Reference documentation">Java documentation for <code>android.accessibilityservice.AccessibilityButtonController.isAccessibilityButtonAvailable()</code>.</a>
Expand Down Expand Up @@ -118,6 +148,10 @@
<AttributeName Language="C#">[Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand Down Expand Up @@ -158,6 +192,10 @@
<AttributeName Language="C#">[Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;Landroid/os/Handler;)V", "", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("registerAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;Landroid/os/Handler;)V", "", ApiSince=26)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand Down Expand Up @@ -262,6 +300,10 @@
<AttributeName Language="C#">[Android.Runtime.Register("unregisterAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)]</AttributeName>
<AttributeName Language="F#">[&lt;Android.Runtime.Register("unregisterAccessibilityButtonCallback", "(Landroid/accessibilityservice/AccessibilityButtonController$AccessibilityButtonCallback;)V", "", ApiSince=26)&gt;]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Versioning.SupportedOSPlatform("android26.0")]</AttributeName>
<AttributeName Language="F#">[&lt;System.Runtime.Versioning.SupportedOSPlatform("android26.0")&gt;]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
Expand Down
Loading

0 comments on commit 3f64bdd

Please sign in to comment.