Skip to content

Document Android.Text.Format constants - #488

Open
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-xml-docs-android-text-format
Open

Document Android.Text.Format constants#488
jonathanpeppers wants to merge 2 commits into
mainfrom
jonathanpeppers-xml-docs-android-text-format

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Summary

  • Document TimeFormatValues selectors and DayOfWeek values from the AOSP Time API surface.
  • Complete the Android reference parameter and return documentation for DateFormat.GetDateFormatOrder.

Refs #199

Sources

Validation

  • Parsed all three edited XML files with PowerShell.
  • Confirmed CRLF line endings and a clean git diff --check.

Refs #199

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves API reference documentation in the Android.Text.Format namespace by replacing placeholder text with concrete descriptions for TimeFormatValues, DayOfWeek, and DateFormat.GetDateFormatOrder, aligning the docs more closely with the underlying Android/AOSP surface.

Changes:

  • Documented TimeFormatValues field-selector constants with specific summaries.
  • Documented DayOfWeek enum values with day-name summaries and updated the type summary.
  • Completed the context parameter and return documentation for DateFormat.GetDateFormatOrder.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/xml/Android.Text.Format/TimeFormatValues.xml Replaces “To be added” placeholders with descriptions for the field selector enum used by Time.GetActualMaximum.
docs/xml/Android.Text.Format/DayOfWeek.xml Documents weekday enum values and updates the type summary for DayOfWeek.
docs/xml/Android.Text.Format/DateFormat.xml Adds parameter/return docs for GetDateFormatOrder(Context).

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/xml/Android.Text.Format/DateFormat.xml Outdated
Comment thread docs/xml/Android.Text.Format/DayOfWeek.xml Outdated
Refs #199

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@jonathanpeppers

Copy link
Copy Markdown
Member Author

@dalexsoto review

@dalexsoto dalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two public API descriptions are incorrect:

  • docs/xml/Android.Text.Format/DayOfWeek.xml: the type summary says every value is a day of the week, but MondayBeforeJulianEpoch is the Julian day number 2440585. Please generalize the summary.
  • docs/xml/Android.Text.Format/TimeFormatValues.xml: the type summary and WeekNum description imply WeekNum works with Time.GetActualMaximum, but AOSP throws RuntimeException("WEEK_NUM not implemented") for that value. Please document it as unsupported and qualify the type summary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants