Skip to content

Document Android.Text.Format constants #488

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

Document Android.Text.Format constants #488

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
510d0ab
Document Android text format constants
jonathanpeppers Aug 14, 2026
b33b164
Address text format documentation review
jonathanpeppers Aug 14, 2026
bc0950f
Clarify text format constant limitations
jonathanpeppers Aug 15, 2026
031473f
Document unsupported time week selector
jonathanpeppers Aug 15, 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
4 changes: 2 additions & 2 deletions docs/xml/Android.Text.Format/DateFormat.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -652,9 +652,9 @@
<Parameter Name="context" Type="Android.Content.Context" />
</Parameters>
<Docs>
<param name="context">To be added.</param>
<param name="context">the application context</param>
<summary>Gets the current date format stored as a char array.</summary>
<returns>To be added.</returns>
<returns>A three-element array containing the day, month, and year format characters in the user's preferred order.</returns>
<remarks>
<para>Gets the current date format stored as a char array. Returns a 3 element
array containing the day (<c>'d'</c>), month (<c>'M'</c>), and year (<c>'y'</c>))
Expand Down
16 changes: 8 additions & 8 deletions docs/xml/Android.Text.Format/DayOfWeek.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Enumerates values returned by several types and taken as a parameter of the <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='F:Android Text Style TtsSpan+DateBuilder SetWeekday';scope=Xamarin" title="F:Android.Text.Style.TtsSpan+DateBuilder.SetWeekday">F:Android.Text.Style.TtsSpan+DateBuilder.SetWeekday</a></format> member.</summary>
<summary>Enumerates constants used by <see cref="T:Android.Text.Format.Time" /> and passed to <see cref="M:Android.Text.Style.TtsSpan.DateBuilder.SetWeekday(Android.Text.Format.DayOfWeek)" />.</summary>
<remarks>
<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>
Expand All @@ -38,7 +38,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Friday.</summary>
<remarks>
<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>
Expand All @@ -65,7 +65,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Monday.</summary>
<remarks>
<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>
Expand Down Expand Up @@ -120,7 +120,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Saturday.</summary>
<remarks>
<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>
Expand All @@ -147,7 +147,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Sunday.</summary>
<remarks>
<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>
Expand All @@ -174,7 +174,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Thursday.</summary>
<remarks>
<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>
Expand All @@ -201,7 +201,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Tuesday.</summary>
<remarks>
<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>
Expand All @@ -228,7 +228,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Wednesday.</summary>
<remarks>
<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>
Expand Down
20 changes: 10 additions & 10 deletions docs/xml/Android.Text.Format/TimeFormatValues.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Enumerates values returned by several methods of <see cref="T:Android.Text.Format.TimeFormatValues" /> and taken as a parameter of the <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='F:Android Text Format Time GetActualMaximum';scope=Xamarin" title="F:Android.Text.Format.Time.GetActualMaximum">F:Android.Text.Format.Time.GetActualMaximum</a></format> member.</summary>
<summary>Enumerates symbolic constants for accessing fields of <see cref="T:Android.Text.Format.Time" /> with <see cref="M:Android.Text.Format.Time.GetActualMaximum(Android.Text.Format.TimeFormatValues)" />, except <see cref="F:Android.Text.Format.TimeFormatValues.WeekNum" />, which causes that method to throw <c>RuntimeException</c>.</summary>
<remarks>
<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>
Expand All @@ -38,7 +38,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the hour field.</summary>
<remarks>
<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>
Expand All @@ -65,7 +65,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the minute field.</summary>
<remarks>
<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>
Expand All @@ -92,7 +92,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the month field.</summary>
<remarks>
<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>
Expand All @@ -119,7 +119,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the day-of-month field.</summary>
<remarks>
<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>
Expand All @@ -146,7 +146,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the second field.</summary>
<remarks>
<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>
Expand All @@ -173,7 +173,7 @@
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the day-of-week field.</summary>
<remarks>
<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>
Expand All @@ -200,7 +200,7 @@
</ReturnValue>
<MemberValue>9</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the week-number field. Passing this value to <see cref="M:Android.Text.Format.Time.GetActualMaximum(Android.Text.Format.TimeFormatValues)" /> throws <c>RuntimeException</c>.</summary>
<remarks>
<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>
Expand All @@ -227,7 +227,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the year field.</summary>
<remarks>
<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>
Expand All @@ -254,7 +254,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary ToolPath="Untrimmed" tool="FirstSentenceInJavadocToMdoc">To be added.</summary>
<summary>Symbolic constant for accessing the day-of-year field.</summary>
<remarks>
<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>
Expand Down