Kdocs for ui/uistateadapter/capture

[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 improving the maintainability and readability of the ui/uistateadapter/capture module by introducing detailed Kdoc comments for functions responsible for translating camera settings and states into UI-specific representations. The added documentation clarifies the purpose, parameters, and return values of these critical functions, making it easier for developers to understand and work with the codebase. Additionally, an unused PreviewMode enum has been removed, contributing to a cleaner project structure.

Highlights

• Documentation Enhancement: Added comprehensive Kdoc documentation to numerous from and updateFrom functions across various *UiStateAdapter.kt files within the ui/uistateadapter/capture module. This significantly improves the clarity and understanding of these UI state adaptation functions.
• Code Cleanup: Removed the PreviewMode.kt file, which contained an unused enum, thereby streamlining the codebase and removing obsolete components.

🧠 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/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/AspectRatioUiStateAdapter.kt
  • Added Kdoc to AspectRatioUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/AudioUiStateAdapter.kt
  • Added Kdoc to AudioUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/CaptureButtonUiStateAdapter.kt
  • Added Kdoc to CaptureButtonUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/CaptureModeUiStateAdapter.kt
  • Added Kdoc to CaptureModeToggleUiState.Companion.from function.
  • Added Kdoc to CaptureModeUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/ConcurrentCameraUiStateAdapter.kt
  • Added Kdoc to ConcurrentCameraUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/DebugUiStateAdapter.kt
  • Added Kdoc to DebugUiState.Enabled.Open.Companion.from function.
  • Added Kdoc to DebugUiState.Enabled.Closed.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/ElapsedTimeUiStateAdapter.kt
  • Added Kdoc to ElapsedTimeUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/FlashModeUiStateAdapter.kt
  • Added Kdoc to FlashModeUiState.Companion.from function.
  • Added Kdoc to FlashModeUiState.updateFrom function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/FlipLensUiStateAdapter.kt
  • Added Kdoc to FlipLensUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/FocusMeteringUiStateAdapter.kt
  • Added Kdoc to FocusMeteringUiState.updateFrom function.
  • Added Kdoc to FocusMeteringUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/HdrUiStateAdapter.kt
  • Added Kdoc to HdrUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/ImageWellUiStateAdapter.kt
  • Added Kdoc to ImageWellUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/PreviewMode.kt
  • Removed file.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/StabilizationUiStateAdapter.kt
  • Added Kdoc to StabilizationUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/StreamConfigsUiStateAdapter.kt
  • Added Kdoc to StreamConfigUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/ZoomControlUiStateAdapter.kt
  • Added Kdoc to ZoomControlUiState.Companion.from function.
• ui/uistateadapter/capture/src/main/java/com/google/jetpackcamera/ui/uistateadapter/capture/ZoomUiStateAdapter.kt
  • Added Kdoc to ZoomUiState.Companion.from function.

Activity

• No specific activity (comments, reviews, etc.) has been recorded for 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 valuable KDoc documentation across numerous UI state adapter files, which greatly improves code clarity and maintainability. The new documentation is comprehensive and aligns well with the project's guidelines. I've suggested a few minor corrections to fix typos and inaccuracies in the new comments to ensure they are as precise as possible.