Skip to content

Add XML documentation for Android.Icu.Text #652

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 10 commits into
base: main
Choose a base branch
from
Open

Add XML documentation for Android.Icu.Text #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0a7a2c3
Add Android.Icu.Text XML documentation
jonathanpeppers Aug 18, 2026
22ece7a
Fix imported ICU documentation artifacts
jonathanpeppers Aug 19, 2026
8a20af9
Repair ICU importer documentation artifacts
jonathanpeppers Aug 19, 2026
0a64439
Merge main into ICU documentation updates
jonathanpeppers Aug 19, 2026
2545a56
Fix importer remarks cleanup self-test
jonathanpeppers Aug 19, 2026
f244c52
Reject standalone ICU source annotations
jonathanpeppers Aug 19, 2026
c4e407c
Preserve importer code example prose
jonathanpeppers Aug 19, 2026
b2b8a88
Repair ICU importer examples and summaries
jonathanpeppers Aug 20, 2026
9cf3b3d
Preserve nested ICU documentation code
jonathanpeppers Aug 20, 2026
d5accca
Preserve ordered Android documentation blocks
jonathanpeppers Aug 20, 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
8 changes: 2 additions & 6 deletions docs/xml/Android.Icu.Text/AlphabeticIndex+Bucket+LabelType.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,9 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>Type of the label</summary>
<remarks>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex$Bucket$LabelType" title="Reference documentation">Android platform documentation</a>
</format>
</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket.LabelType" title="Reference documentation">Android reference for <code>android.icu.text.AlphabeticIndex.Bucket.LabelType</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down
8 changes: 5 additions & 3 deletions docs/xml/Android.Icu.Text/AlphabeticIndex+Bucket.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Is a normal, underflow, overflow, or inflow bucket</summary>
<returns>is an underflow, overflow, or inflow bucket</returns>
<remarks>
<para>Is a normal, underflow, overflow, or inflow bucket</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex.Bucket#getLabelType()" title="Reference documentation">Android reference for <code>android.icu.text.AlphabeticIndex.Bucket.getLabelType</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down Expand Up @@ -161,7 +163,7 @@
<Parameters />
<Docs>
<summary>Iterator over the records in the bucket</summary>
<returns>To be added.</returns>
<returns>an Iterator.</returns>
<remarks>
<para>Iterator over the records in the bucket</para>
<para>
Expand Down
14 changes: 8 additions & 6 deletions docs/xml/Android.Icu.Text/AlphabeticIndex+ImmutableIndex.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,10 +136,12 @@
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="index">bucket number</param>
<summary>Returns the index-th bucket.</summary>
<returns>the index-th bucket</returns>
<remarks>
<para>Returns the index-th bucket. Returns null if the index is out of range.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#getBucket(int)" title="Reference documentation">Android reference for <code>android.icu.text.AlphabeticIndex.ImmutableIndex.getBucket</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down Expand Up @@ -272,10 +274,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added.</returns>
<summary>Returns an iterator over elements of type T.</summary>
<returns>an Iterator.</returns>
<remarks>
<para>To be added</para>
<para>Returns an iterator over elements of type T.</para>
<para>
<format type="text/html">
<a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex.ImmutableIndex#iterator()" title="Reference documentation">Java documentation for <code>android.icu.text.AlphabeticIndex.ImmutableIndex.iterator()</code>.</a>
Expand Down
22 changes: 14 additions & 8 deletions docs/xml/Android.Icu.Text/AlphabeticIndex.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,10 +355,12 @@
</Parameter>
</Parameters>
<Docs>
<param name="additions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="additions">additional characters to add to the index, such as those in Swedish.</param>
<summary>Add more index characters (aside from what are in the locale)</summary>
<returns>this, for chaining</returns>
<remarks>
<para>Add more index characters (aside from what are in the locale)</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex#addLabels(android.icu.util.ULocale[])" title="Reference documentation">Android reference for <code>android.icu.text.AlphabeticIndex.addLabels</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down Expand Up @@ -401,10 +403,12 @@
</Parameter>
</Parameters>
<Docs>
<param name="additions">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<param name="additions">additional characters to add to the index, such as those in Swedish.</param>
<summary>Add more index characters (aside from what are in the locale)</summary>
<returns>this, for chaining</returns>
<remarks>
<para>Add more index characters (aside from what are in the locale)</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex#addLabels(java.util.Locale[])" title="Reference documentation">Android reference for <code>android.icu.text.AlphabeticIndex.addLabels</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down Expand Up @@ -614,9 +618,11 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<summary>Builds an immutable, thread-safe version of this instance, without data records.</summary>
<returns>an immutable index instance</returns>
<remarks>
<para>Builds an immutable, thread-safe version of this instance, without data records.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/icu/text/AlphabeticIndex#buildImmutableIndex()" title="Reference documentation">Android reference for <code>android.icu.text.AlphabeticIndex.buildImmutableIndex</code>.</a></format></para>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
</Docs>
Expand Down
Loading