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

Commit 59c78f8

Browse files
pjcollinspjcollins
authored
Update docs using dotnet/java-interop@7716ae53 (#33)
Updates API docs against: * dotnet/android@bb2f920 * dotnet/java-interop@51c3dae Notable generator improvements include: * dotnet/java-interop@4cbc07a * dotnet/java-interop@13def0e * dotnet/java-interop@32635fd
1 parent 5c4bf28 commit 59c78f8

File tree

216 files changed

+1225
-1469
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

216 files changed

+1225
-1469
lines changed

‎docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityGestureEvent.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
</ReturnValue>
108108
<Parameters />
109109
<Docs>
110-
<summary>[TODO: @inheritDoc]</summary>
110+
<summary>To be added</summary>
111111
<returns>To be added.</returns>
112112
<remarks>
113113
<para>

‎docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityServiceInfo.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,7 @@
690690
</ReturnValue>
691691
<Parameters />
692692
<Docs>
693-
<summary>[TODO: @inheritDoc]</summary>
693+
<summary>To be added</summary>
694694
<returns>To be added.</returns>
695695
<remarks>
696696
<para>

‎docs/Mono.Android/en/Android.Animation/AnimatorListenerAdapter.xml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@
160160
<Docs>
161161
<param name="animation">The animation which was canceled.
162162
</param>
163-
<summary>[TODO: @inheritDoc]</summary>
163+
<summary>To be added</summary>
164164
<remarks>
165165
<para>
166166
<format type="text/html">
@@ -204,7 +204,7 @@
204204
<Docs>
205205
<param name="animation">The animation which reached its end.
206206
</param>
207-
<summary>[TODO: @inheritDoc]</summary>
207+
<summary>To be added</summary>
208208
<remarks>
209209
<para>
210210
<format type="text/html">
@@ -247,7 +247,7 @@
247247
</Parameters>
248248
<Docs>
249249
<param name="animation">The animaton being paused.</param>
250-
<summary>[TODO: @inheritDoc]</summary>
250+
<summary>To be added</summary>
251251
<remarks>
252252
<para>
253253
<format type="text/html">
@@ -290,7 +290,7 @@
290290
<Docs>
291291
<param name="animation">The animation which was repeated.
292292
</param>
293-
<summary>[TODO: @inheritDoc]</summary>
293+
<summary>To be added</summary>
294294
<remarks>
295295
<para>
296296
<format type="text/html">
@@ -333,7 +333,7 @@
333333
</Parameters>
334334
<Docs>
335335
<param name="animation">The animation being resumed.</param>
336-
<summary>[TODO: @inheritDoc]</summary>
336+
<summary>To be added</summary>
337337
<remarks>
338338
<para>
339339
<format type="text/html">
@@ -376,7 +376,7 @@
376376
<Docs>
377377
<param name="animation">The started animation.
378378
</param>
379-
<summary>[TODO: @inheritDoc]</summary>
379+
<summary>To be added</summary>
380380
<remarks>
381381
<para>
382382
<format type="text/html">

‎docs/Mono.Android/en/Android.Animation/Keyframe.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@
237237
</ReturnValue>
238238
<Docs>
239239
<summary>Gets the optional interpolator for this Keyframe. -or- Sets the optional interpolator for this Keyframe.</summary>
240-
<returns>The optional interpolator for this Keyframe.</returns>
240+
<value>The optional interpolator for this Keyframe.</value>
241241
<remarks>
242242
<para>Property getter documentation:</para>
243243
<para>

‎docs/Mono.Android/en/Android.App.Backup/BackupAgent.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -519,8 +519,7 @@
519519
file descriptor pointing to a full snapshot of the
520520
application's data. The application should consume every
521521
entity represented in this data stream.</param>
522-
<param name="appVersionCode">The value of the &lt;a
523-
href="[TODO: @docRoot]guide/topics/manifest/manifest-element.html#vcode"&gt;<c>android:versionCode</c>&lt;/a&gt; manifest attribute,
522+
<param name="appVersionCode">The value of the <see href="https://developer.android.com/guide/topics/manifest/manifest-element.html#vcode"><c>android:versionCode</c></see> manifest attribute,
524523
from the application that backed up this particular data set. This
525524
makes it possible for an application's agent to distinguish among any
526525
possible older data versions when asked to perform the restore

‎docs/Mono.Android/en/Android.App/Activity.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4628,7 +4628,7 @@
46284628
<Docs>
46294629
<param name="featureId">The panel that the menu is in.</param>
46304630
<param name="menu">The menu that is opened.</param>
4631-
<summary>[TODO: @inheritDoc]</summary>
4631+
<summary>To be added</summary>
46324632
<returns>The default implementation returns true.</returns>
46334633
<remarks>
46344634
<para>

‎docs/Mono.Android/en/Android.App/ActivityManager.xml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1435,7 +1435,11 @@
14351435
<ReturnType>System.String</ReturnType>
14361436
</ReturnValue>
14371437
<Docs>
1438-
<summary>&lt;a href="[TODO: @docRoot]guide/topics/manifest/meta-data-element.</summary>
1438+
<summary>
1439+
<see href="https://developer.android.com/guide/topics/manifest/meta-data-element.html">
1440+
<c>&lt;meta-data&gt;</c>
1441+
</see> name for a 'home' Activity that declares a package that is to be
1442+
uninstalled in lieu of the declaring one.</summary>
14391443
<remarks>
14401444
<para>
14411445
<format type="text/html">

‎docs/Mono.Android/en/Android.App/Dialog.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1138,7 +1138,7 @@
11381138
<Docs>
11391139
<param name="mode">The mode that was just finished.
11401140
</param>
1141-
<summary>[TODO: @inheritDoc]
1141+
<summary>To be added
11421142

11431143
Note that if you override this method you should always call through
11441144
to the superclass implementation by calling super.</summary>
@@ -1185,7 +1185,7 @@
11851185
<Docs>
11861186
<param name="mode">The new mode that has just been started.
11871187
</param>
1188-
<summary>[TODO: @inheritDoc]
1188+
<summary>To be added
11891189

11901190
Note that if you override this method you should always call through
11911191
to the superclass implementation by calling super.</summary>

‎docs/Mono.Android/en/Android.App/Presentation.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@
127127
<c>android.view.WindowManager.InvalidDisplayException</c> when invoking <c>#show()</c>.</param>
128128
<param name="display">The display to which the presentation should be attached.</param>
129129
<param name="theme">A style resource describing the theme to use for the window.
130-
See &lt;a href="[TODO: @docRoot]guide/topics/resources/available-resources.html#stylesandthemes"&gt;
131-
Style and Theme Resources&lt;/a&gt; for more information about defining and using
130+
See <see href="https://developer.android.com/guide/topics/resources/available-resources.html#stylesandthemes">
131+
Style and Theme Resources</see> for more information about defining and using
132132
styles. This theme is applied on top of the current theme in
133133
&lt;var&gt;outerContext&lt;/var&gt;. If 0, the default presentation theme will be used.</param>
134134
<summary>Creates a new presentation that is attached to the specified display

‎docs/Mono.Android/en/Android.Bluetooth/BluetoothA2dp.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@
167167
<ReturnType>System.Collections.Generic.IList&lt;Android.Bluetooth.BluetoothDevice&gt;</ReturnType>
168168
</ReturnValue>
169169
<Docs>
170-
<summary>[TODO: @inheritDoc]</summary>
170+
<summary>To be added</summary>
171171
<value>To be added.</value>
172172
<remarks>
173173
<para>
@@ -243,7 +243,7 @@
243243
</Parameters>
244244
<Docs>
245245
<param name="device">Remote bluetooth device.</param>
246-
<summary>[TODO: @inheritDoc]</summary>
246+
<summary>To be added</summary>
247247
<returns>To be added.</returns>
248248
<remarks>
249249
<para>
@@ -300,7 +300,7 @@
300300
<param name="states">Array of states. States can be one of
301301
<see cref="F:Android.Bluetooth.ProfileState.Connected" tool="ReplaceLinkValue" />, <see cref="F:Android.Bluetooth.ProfileState.Connecting" tool="ReplaceLinkValue" />,
302302
<see cref="F:Android.Bluetooth.ProfileState.Disconnected" tool="ReplaceLinkValue" />, <see cref="F:Android.Bluetooth.ProfileState.Disconnecting" tool="ReplaceLinkValue" />,</param>
303-
<summary>[TODO: @inheritDoc]</summary>
303+
<summary>To be added</summary>
304304
<returns>To be added.</returns>
305305
<remarks>
306306
<para>

‎docs/Mono.Android/en/Android.Bluetooth/BluetoothHeadset.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@
452452
<ReturnType>System.Collections.Generic.IList&lt;Android.Bluetooth.BluetoothDevice&gt;</ReturnType>
453453
</ReturnValue>
454454
<Docs>
455-
<summary>[TODO: @inheritDoc]</summary>
455+
<summary>To be added</summary>
456456
<value>To be added.</value>
457457
<remarks>
458458
<para>
@@ -627,7 +627,7 @@
627627
</Parameters>
628628
<Docs>
629629
<param name="device">Remote bluetooth device.</param>
630-
<summary>[TODO: @inheritDoc]</summary>
630+
<summary>To be added</summary>
631631
<returns>To be added.</returns>
632632
<remarks>
633633
<para>
@@ -684,7 +684,7 @@
684684
<param name="states">Array of states. States can be one of
685685
<see cref="F:Android.Bluetooth.ProfileState.Connected" tool="ReplaceLinkValue" />, <see cref="F:Android.Bluetooth.ProfileState.Connecting" tool="ReplaceLinkValue" />,
686686
<see cref="F:Android.Bluetooth.ProfileState.Disconnected" tool="ReplaceLinkValue" />, <see cref="F:Android.Bluetooth.ProfileState.Disconnecting" tool="ReplaceLinkValue" />,</param>
687-
<summary>[TODO: @inheritDoc]</summary>
687+
<summary>To be added</summary>
688688
<returns>To be added.</returns>
689689
<remarks>
690690
<para>

‎docs/Mono.Android/en/Android.Bluetooth/BluetoothHearingAid.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
<ReturnType>System.Collections.Generic.IList&lt;Android.Bluetooth.BluetoothDevice&gt;</ReturnType>
119119
</ReturnValue>
120120
<Docs>
121-
<summary>[TODO: @inheritDoc]</summary>
121+
<summary>To be added</summary>
122122
<value>To be added.</value>
123123
<remarks>
124124
<para>
@@ -165,7 +165,7 @@
165165
</Parameters>
166166
<Docs>
167167
<param name="device">To be added.</param>
168-
<summary>[TODO: @inheritDoc]</summary>
168+
<summary>To be added</summary>
169169
<returns>To be added.</returns>
170170
<remarks>
171171
<para>
@@ -219,7 +219,7 @@
219219
</Parameters>
220220
<Docs>
221221
<param name="states">To be added.</param>
222-
<summary>[TODO: @inheritDoc]</summary>
222+
<summary>To be added</summary>
223223
<returns>To be added.</returns>
224224
<remarks>
225225
<para>

‎docs/Mono.Android/en/Android.Bluetooth/BluetoothHidDevice.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
<ReturnType>System.Collections.Generic.IList&lt;Android.Bluetooth.BluetoothDevice&gt;</ReturnType>
162162
</ReturnValue>
163163
<Docs>
164-
<summary>[TODO: @inheritDoc]</summary>
164+
<summary>To be added</summary>
165165
<value>To be added.</value>
166166
<remarks>
167167
<para>
@@ -498,7 +498,7 @@
498498
</Parameters>
499499
<Docs>
500500
<param name="device">To be added.</param>
501-
<summary>[TODO: @inheritDoc]</summary>
501+
<summary>To be added</summary>
502502
<returns>To be added.</returns>
503503
<remarks>
504504
<para>
@@ -552,7 +552,7 @@
552552
</Parameters>
553553
<Docs>
554554
<param name="states">To be added.</param>
555-
<summary>[TODO: @inheritDoc]</summary>
555+
<summary>To be added</summary>
556556
<returns>To be added.</returns>
557557
<remarks>
558558
<para>

‎docs/Mono.Android/en/Android.Bluetooth/BluetoothHidDeviceAppSdpSettings.xml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,10 @@
6262
<param name="name">Name of this Bluetooth HID device. Maximum length is 50 bytes.</param>
6363
<param name="description">Description for this Bluetooth HID device. Maximum length is 50 bytes.</param>
6464
<param name="provider">Provider of this Bluetooth HID device. Maximum length is 50 bytes.</param>
65-
<param name="subclass">Subclass of this Bluetooth HID device. See &lt;a
66-
href="www.usb.org/developers/hidpage/HID1_11.pdf"&gt;
67-
www.usb.org/developers/hidpage/HID1_11.pdf Section 4.2&lt;/a&gt;</param>
68-
<param name="descriptors">Descriptors of this Bluetooth HID device. See &lt;a
69-
href="www.usb.org/developers/hidpage/HID1_11.pdf"&gt;
70-
www.usb.org/developers/hidpage/HID1_11.pdf Chapter 6&lt;/a&gt; Maximum length is 2048 bytes.</param>
65+
<param name="subclass">Subclass of this Bluetooth HID device. See <see href="www.usb.org/developers/hidpage/HID1_11.pdf">
66+
www.usb.org/developers/hidpage/HID1_11.pdf Section 4.2</see></param>
67+
<param name="descriptors">Descriptors of this Bluetooth HID device. See <see href="www.usb.org/developers/hidpage/HID1_11.pdf">
68+
www.usb.org/developers/hidpage/HID1_11.pdf Chapter 6</see> Maximum length is 2048 bytes.</param>
7169
<summary>Create a BluetoothHidDeviceAppSdpSettings object for the Bluetooth SDP record.</summary>
7270
<remarks>
7371
<para>

‎docs/Mono.Android/en/Android.Bluetooth/BluetoothLeAudio.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@
149149
<ReturnType>System.Collections.Generic.IList&lt;Android.Bluetooth.BluetoothDevice&gt;</ReturnType>
150150
</ReturnValue>
151151
<Docs>
152-
<summary>[TODO: @inheritDoc]</summary>
152+
<summary>To be added</summary>
153153
<value>To be added.</value>
154154
<remarks>
155155
<para>
@@ -196,7 +196,7 @@
196196
</Parameters>
197197
<Docs>
198198
<param name="device">To be added.</param>
199-
<summary>[TODO: @inheritDoc]</summary>
199+
<summary>To be added</summary>
200200
<returns>To be added.</returns>
201201
<remarks>
202202
<para>
@@ -250,7 +250,7 @@
250250
</Parameters>
251251
<Docs>
252252
<param name="states">To be added.</param>
253-
<summary>[TODO: @inheritDoc]</summary>
253+
<summary>To be added</summary>
254254
<returns>To be added.</returns>
255255
<remarks>
256256
<para>

‎docs/Mono.Android/en/Android.Companion/CompanionDeviceManager.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
<Docs>
2121
<summary>System level service for managing companion devices
2222

23-
See &lt;a href="[TODO: @docRoot]guide/topics/connectivity/companion-device-pairing"&gt;this guide&lt;/a&gt;
23+
See <see href="https://developer.android.com/guide/topics/connectivity/companion-device-pairing">this guide</see>
2424
for a usage example.</summary>
2525
<remarks>
2626
<para>

‎docs/Mono.Android/en/Android.Content.PM/PackageManager.xml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1148,7 +1148,7 @@
11481148
<summary>Feature for <c>#getSystemAvailableFeatures</c> and
11491149
<c>#hasSystemFeature</c>: The device includes at least one form of audio
11501150
output, as defined in the Android Compatibility Definition Document (CDD)
1151-
&lt;a href="https://source.</summary>
1151+
<see href="https://source.android.com/compatibility/android-cdd#7_8_audio">section 7.8 Audio</see>.</summary>
11521152
<remarks>
11531153
<para>
11541154
<format type="text/html">
@@ -3450,7 +3450,8 @@
34503450
<Docs>
34513451
<summary>Feature for <c>#getSystemAvailableFeatures</c> and
34523452
<c>#hasSystemFeature</c>: The device supports the OpenGL ES
3453-
&lt;a href="http://www.</summary>
3453+
<see href="http://www.khronos.org/registry/gles/extensions/ANDROID/ANDROID_extension_pack_es31a.txt">
3454+
Android Extension Pack</see>.</summary>
34543455
<remarks>
34553456
<para>
34563457
<format type="text/html">
@@ -4518,7 +4519,8 @@
45184519
<summary>Feature for <c>#getSystemAvailableFeatures</c>, <c>#hasSystemFeature(String)</c>, and
45194520
<c>#hasSystemFeature(String, int)</c>: If this feature is supported, the device implements
45204521
the Android Keystore backed by a dedicated secure processor referred to as
4521-
&lt;a href="https://source.</summary>
4522+
<see href="https://source.android.com/security/best-practices/hardware#strongbox-keymaster">
4523+
StrongBox</see>.</summary>
45224524
<remarks>
45234525
<para>
45244526
<format type="text/html">

‎docs/Mono.Android/en/Android.Content.PM/ShortcutManager.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,8 +1061,8 @@
10611061
Use <c>android.app.PendingIntent#getIntentSender()</c> to create an <c>IntentSender</c>.
10621062
To avoid background execution limits, use an unexported, manifest-declared receiver.
10631063
For more details, see
1064-
&lt;a href="/guide/topics/ui/shortcuts/creating-shortcuts.html#pinned"&gt;
1065-
Creating pinned shortcuts&lt;/a&gt;.</param>
1064+
"/guide/topics/ui/shortcuts/creating-shortcuts.html#pinned"&gt;
1065+
Creating pinned shortcuts.</param>
10661066
<summary>Request to create a pinned shortcut.</summary>
10671067
<returns>
10681068
<c>TRUE</c> if the launcher supports this feature. Note the API will return without

0 commit comments

Comments
 (0)