Skip to content

Started documenting the code in app module. - #166

Merged
Gurupreet merged 1 commit into
Gurupreet:masterfrom
param-param:docu/sample_documentation
Jun 22, 2025
Merged

Gurupreet merged 1 commit into
Gurupreet:masterfrom
param-param:docu/sample_documentation

Conversation

@param-param

Copy link
Copy Markdown
Contributor

I have started documenting the code. Please review it once for any modifications or improvements in the style of documentation, so that I can take care of those things in the further process of documenting.

@Gurupreet
Gurupreet requested a review from Copilot June 22, 2025 14:12

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 pull request introduces extensive documentation across many composable functions and classes in the app, clarifying their roles and usage. Key changes include:

  • Added KDoc comments to activities, composables, and utility functions.
  • Improved inline code documentation for UI components and navigation.
  • Expanded documentation for previews and helper functions to facilitate future maintenance.

Reviewed Changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated no comments.

Show a summary per file
File Description
TemplatesActivity.kt Added documentation for activity properties and the newIntent function.
TemplateScreen.kt Documented composable functions and the templates list.
WidgetScreen.kt Added comments to outline screen scaffold and preview.
UICards.kt Documented UI card components and demo sections.
Toggles.kt Enhanced documentation for toggle components and interactions.
Texts.kt Documented text demonstration functions and previews.
TextInputs.kt Added documentation for various text input examples.
SwipeButton.kt Documented swipe button behavior and its state enum.
Snackbars.kt Documented snackbar usage and preview functions.
Loaders.kt Documented progress indicator composable functions.
Layouts.kt Added detailed documentation for layout and alignment composables.
Chips.kt Documented custom chip components and helper functions.
AppBars.kt Added documentation for various app and navigation bar demos.
AllButtons.kt Updated documentation for button customization examples.
HorizontalListItem.kt Documented the horizontal list item and its preview.
GridListItem.kt Added documentation for grid list items and previews.
HomeScreen.kt Enhanced documentation for the home screen, its components, and interactions.
MainActivity.kt Documented main activity and base view composables.
BottomNavType.kt Added documentation for bottom navigation enumeration.
App.kt Documented the custom Application class and global state initialization.
Comments suppressed due to low confidence (2)

app/src/main/java/com/guru/composecookbook/ui/learnwidgets/Layouts.kt:234

  • The function name 'TypeOfBoxs' appears ambiguous; consider renaming it to 'TypeOfBoxes' to improve clarity.
fun TypeOfBoxs() {

app/src/main/java/com/guru/composecookbook/ui/home/HomeScreen.kt:335

  • The identifier 'seconderyText' appears to be misspelled; please correct it to 'secondaryText'.
    //TODO pass theme to following screens

@Gurupreet
Gurupreet merged commit 400185f into Gurupreet:master Jun 22, 2025
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