Add Kdocs to ui/[uistate & uistateadapter]/postcapture classes

[davidjiagoogle]

as titled

[gemini-code-assist]

Summary of Changes

Hello @davidjiagoogle, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the codebase's clarity and maintainability by introducing Kdoc documentation to several UI state and UI state adapter classes within the post-capture feature. The additions provide detailed explanations for each state and function, making it easier for developers to understand and work with the UI logic.

Highlights

• Documentation for UI State Classes: Comprehensive Kdoc documentation has been added to the DeleteButtonUiState, MediaViewerUiState, PostCaptureUiState, and ShareButtonUiState sealed interfaces, along with their nested objects and data classes, to clearly define their purpose and usage.
• Documentation for UI State Adapter Functions: Kdoc documentation has been added to the from extension functions within DeleteButtonUiStateAdapter, MediaViewerUiStateAdapter, and ShareButtonUiStateAdapter to explain how UI states are derived from media descriptors and other relevant data.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• ui/uistate/postcapture/src/main/java/com/google/jetpackcamera/ui/uistate/postcapture/DeleteButtonUiState.kt
  • Added Kdoc for the DeleteButtonUiState sealed interface.
  • Added Kdoc for the Ready object.
  • Added Kdoc for the Unavailable object.
• ui/uistate/postcapture/src/main/java/com/google/jetpackcamera/ui/uistate/postcapture/MediaViewerUiState.kt
  • Added Kdoc for the MediaViewerUiState sealed interface.
  • Added Kdoc for the Loading object.
  • Added Kdoc for the Error object.
  • Added Kdoc for the Content sealed interface.
  • Added Kdoc for the Video sealed interface.
  • Added Kdoc for the Video.Loading data class.
  • Added Kdoc for the Video.Ready data class.
  • Added Kdoc for the Image data class.
• ui/uistate/postcapture/src/main/java/com/google/jetpackcamera/ui/uistate/postcapture/PostCaptureUiState.kt
  • Added Kdoc for the PostCaptureUiState sealed interface.
  • Added Kdoc for the Loading object.
  • Added Kdoc for the Ready data class, including parameter descriptions.
• ui/uistate/postcapture/src/main/java/com/google/jetpackcamera/ui/uistate/postcapture/ShareButtonUiState.kt
  • Added Kdoc for the ShareButtonUiState sealed interface.
  • Added Kdoc for the Ready object.
  • Added Kdoc for the Unavailable object.
• ui/uistateadapter/postcapture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/postcapture/DeleteButtonUiStateAdapter.kt
  • Added Kdoc for the from extension function, explaining its parameters and return value.
• ui/uistateadapter/postcapture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/postcapture/MediaViewerUiStateAdapter.kt
  • Added Kdoc for the from extension function, detailing its purpose, parameters, and return value.
• ui/uistateadapter/postcapture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/postcapture/ShareButtonUiStateAdapter.kt
  • Added Kdoc for the from extension function, describing its functionality and return conditions.

Activity

• No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds KDoc documentation to several UI state and UI state adapter classes in the post-capture feature. The added documentation is clear and helpful for understanding the purpose of these classes. I've made one suggestion to improve the precision of a @return tag to better reflect the underlying logic.