Skip to content

Document Android text classifier APIs #438

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

Document Android text classifier APIs #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f16386
Document text classifier APIs
jonathanpeppers Aug 14, 2026
d7d4c58
Fix text classifier documentation extraction
jonathanpeppers Aug 14, 2026
bc7fca4
Correct string parameter documentation
jonathanpeppers Aug 14, 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
37 changes: 31 additions & 6 deletions docs/xml/Android.Views.TextClassifiers/ApplyStatusCode.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -40,7 +40,12 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The specified text does not match the text used to generate the links.</summary>
<remarks>
<para>The specified text does not match the text used to generate the links.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#STATUS_DIFFERENT_TEXT" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.STATUS_DIFFERENT_TEXT</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>
</Member>
<Member MemberName="LinksApplied">
Expand Down Expand Up @@ -68,7 +73,12 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Links were successfully applied to the text.</summary>
<remarks>
<para>Links were successfully applied to the text.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#STATUS_LINKS_APPLIED" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.STATUS_LINKS_APPLIED</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>
</Member>
<Member MemberName="NoLinksApplied">
Expand Down Expand Up @@ -96,7 +106,12 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>No links applied to text.</summary>
<remarks>
<para>No links applied to text. The links were filtered out.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#STATUS_NO_LINKS_APPLIED" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.STATUS_NO_LINKS_APPLIED</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>
</Member>
<Member MemberName="NoLinksFound">
Expand Down Expand Up @@ -124,7 +139,12 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>No links exist to apply to text.</summary>
<remarks>
<para>No links exist to apply to text. Links count is zero.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#STATUS_NO_LINKS_FOUND" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.STATUS_NO_LINKS_FOUND</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>
</Member>
<Member MemberName="UnsupportedCharacter">
Expand Down Expand Up @@ -152,7 +172,12 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The specified text contains unsupported characters.</summary>
<remarks>
<para>The specified text contains unsupported characters.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#STATUS_UNSUPPORTED_CHARACTER" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.STATUS_UNSUPPORTED_CHARACTER</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>
</Member>
</Members>
Expand Down
16 changes: 13 additions & 3 deletions docs/xml/Android.Views.TextClassifiers/ApplyStrategy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -40,7 +40,12 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Do not replace ClickableSpans that exist where the TextLinkSpan needs to be applied to.</summary>
<remarks>
<para>Do not replace ClickableSpans that exist where the TextLinkSpan needs to be applied to. Do not apply the TextLinkSpan.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#APPLY_STRATEGY_IGNORE" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.APPLY_STRATEGY_IGNORE</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>
</Member>
<Member MemberName="Replace">
Expand Down Expand Up @@ -68,7 +73,12 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Replace any ClickableSpans that exist where the TextLinkSpan needs to be applied to.</summary>
<remarks>
<para>Replace any ClickableSpans that exist where the TextLinkSpan needs to be applied to.</para>
<para><format type="text/html"><a href="https://developer.android.com/reference/android/view/textclassifier/TextLinks#APPLY_STRATEGY_REPLACE" title="Reference documentation">Android reference for <code>android.view.textclassifier.TextLinks.APPLY_STRATEGY_REPLACE</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>
</Member>
</Members>
Expand Down
Loading