Add more documentation

Author: DaChelimo

PennMobile/src/main/java/com/pennapps/labs/pennmobile/dining/fragments/components/AnimatedDropDown.kt

@@ -1,3 +1,14 @@
+/**
+ * @file AnimatedDropDown.kt
+ * @brief Provides a generic, stateless, animated dropdown component.
+ *
+ * This file contains the `AnimatedPushDropdown` composable, a reusable UI component
+ * designed to display a title and expandable content. The expansion and collapse are
+ * animated, and the arrow icon rotates to indicate the current state.
+ *
+ * As a stateless component, it hoists its `expanded` state and relies on event callbacks,
+ * making it highly reusable throughout the application.
+ */
 package com.pennapps.labs.pennmobile.dining.fragments.components
 
 import androidx.compose.animation.AnimatedVisibility
@@ -28,6 +39,19 @@ import androidx.compose.ui.draw.rotate
 import androidx.compose.ui.unit.dp
 
 
+/**
+ * A generic, animated dropdown card component.
+ *
+ * This composable displays a title row that, when clicked, expands or collapses to reveal
+ * the content area. The transition is animated, and a dropdown arrow icon rotates to
+ * reflect the current state.
+ *
+ * @param expanded State representing whether the dropdown is currently expanded.
+ * @param toggleExpandedMode Event lambda invoked when the title row is clicked.
+ * @param title The composable content to display in the header row of the dropdown.
+ * @param content The composable content to display in the expandable area.
+ * @param modifier The [Modifier] to be applied to the Card container.
+ */
 @Composable
 fun AnimatedPushDropdown(
     expanded: Boolean,
@@ -94,5 +118,4 @@ fun AnimatedPushDropdown(
             ) { content() }
         }
     }
-}
-
+}

PennMobile/src/main/java/com/pennapps/labs/pennmobile/dining/fragments/components/DiningHallCard.kt

@@ -1,3 +1,12 @@
+/**
+ * @file DiningHallCard.kt
+ * @brief Renders a stateless card component for a single dining hall.
+ *
+ * This file contains the `DiningHallCard` composable, a UI component that displays
+ * key information about a dining hall, such as its image, name, open status, hours,
+ * and whether it is a user favorite.
+ *
+ */
 package com.pennapps.labs.pennmobile.dining.fragments.components
 
 import androidx.compose.foundation.Image
@@ -48,6 +57,15 @@ import com.pennapps.labs.pennmobile.dining.classes.Venue
 import org.joda.time.Instant
 import org.joda.time.Interval
 
+/**
+ * A card component that displays information about a single dining hall.
+ *
+ * @param diningHall State representing the [DiningHall] data to display.
+ * @param isFavourite State representing whether this dining hall is marked as a favorite.
+ * @param toggleFavourite Event lambda invoked when the user taps the favorite icon.
+ * @param openDiningHallMenu Event lambda invoked when the user taps on the card.
+ * @param modifier The [Modifier] to be applied to the Card container.
+ */
 @OptIn(ExperimentalMaterial3Api::class)
 @Composable
 fun DiningHallCard(
@@ -57,7 +75,7 @@ fun DiningHallCard(
     openDiningHallMenu: (DiningHall) -> Unit,
     modifier: Modifier = Modifier,
 ) {
-    val cardHeight = 110.dp
+    val cardHeight = 130.dp
 
     Card(
         modifier = modifier.requiredHeight(cardHeight),
@@ -81,14 +99,7 @@ fun DiningHallCard(
                     Modifier
                         .fillMaxHeight()
                         .aspectRatio(4 / 3f)
-                        .clip(
-                            RoundedCornerShape(
-                                topStart = 0.dp,
-                                bottomStart = 0.dp,
-                                topEnd = 6.dp,
-                                bottomEnd = 8.dp
-                            )
-                        ),
+                        .clip(RoundedCornerShape(6.dp)),
                 contentScale = ContentScale.Crop,
             )
 
@@ -120,8 +131,7 @@ fun DiningHallCard(
                                 } else {
                                     AppColors.LabelRed.copy(alpha = 0.9f)
                                 },
-                            )
-                            .padding(vertical = 1.dp, horizontal = 6.dp),
+                            ).padding(vertical = 1.dp, horizontal = 6.dp),
                     fontSize = 13.sp,
                     fontFamily = GilroyFontFamily,
                 )
@@ -165,6 +175,12 @@ fun DiningHallCard(
     }
 }
 
+/**
+ * Provides a preview of the [DiningHallCard] component for development purposes.
+ *
+ * This composable is annotated with `@Preview` and sets up the [DiningHallCard] with
+ * sample data to be rendered in Android Studio's preview pane, for both light and dark themes.
+ */
 @Preview(name = "Light Mode", showBackground = true)
 @Preview(
     name = "Dark Mode",
@@ -194,4 +210,4 @@ private fun PreviewDiningHallCard() {
         toggleFavourite = { },
         openDiningHallMenu = {}
     )
-}
+}

PennMobile/src/main/java/com/pennapps/labs/pennmobile/dining/fragments/components/SortDropdown.kt

@@ -1,3 +1,14 @@
+/**
+ * @file SortDropdown.kt
+ * @brief Renders a stateless dropdown menu component for selecting a sort order.
+ *
+ * This file contains the `SortDropdown` composable, a UI component that allows users
+ * to view the current sort option and expand a list to select a new one. It is designed
+ * to be stateless, receiving its state and event handlers from a parent ViewModel.
+ *
+ * It utilizes the generic `AnimatedPushDropdown` to manage its animation and layout.
+ * This file also includes preview functions for both light and dark modes.
+ */
 package com.pennapps.labs.pennmobile.dining.fragments.components
 
 import androidx.compose.foundation.clickable
@@ -24,6 +35,19 @@ import com.pennapps.labs.pennmobile.compose.presentation.theme.GilroyFontFamily
 import com.pennapps.labs.pennmobile.compose.presentation.theme.googleSansFontFamily
 import com.pennapps.labs.pennmobile.dining.classes.DiningHallSortOrder
 
+/**
+ * A dropdown component that displays sorting options for the dining hall list.
+ *
+ * It displays the currently selected sort order and, when tapped, expands to show a list of
+ * available sorting options.
+ *
+ * @param sortMenuExpanded State representing whether the dropdown is currently expanded.
+ * @param toggleExpandedMode Event lambda to be invoked when the user taps to expand or collapse the dropdown.
+ * @param currentSortOption State representing the currently selected [DiningHallSortOrder].
+ * @param sortOptions The list of all available [DiningHallSortOrder] options to display.
+ * @param changeSortOption Event lambda to be invoked when the user selects a new sort option.
+ * @param modifier The [Modifier] to be applied to this component.
+ */
 @Composable
 fun SortDropdown(
     sortMenuExpanded: Boolean,
@@ -87,7 +111,12 @@ fun SortDropdown(
     )
 }
 
-
+/**
+ * Provides a preview of the [SortDropdown] component for development purposes.
+ *
+ * This composable is annotated with `@Preview` and sets up the [SortDropdown] with
+ * sample state to be rendered in Android Studio's preview pane.
+ */
 @Preview(name = "Light Mode", showBackground = true)
 @Preview(
     name = "Dark Mode",
@@ -111,5 +140,4 @@ private fun PreviewSortDropdown() =
                 changeSortOption = { sortOption = it },
             )
         }
-    }
-
+    }