From 98f122ee4a3a8b9083fa1bc00ba306e447fb3c9f Mon Sep 17 00:00:00 2001
From: Adam McNeilly <amcneilly331@gmail.com>
Date: Sun, 1 Dec 2024 16:07:47 -0500
Subject: [PATCH] Adding docs.

---
 .../pocketleague/shared/app/feature/feed/FeedScreen.kt        | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/shared/app/src/commonMain/kotlin/com/adammcneilly/pocketleague/shared/app/feature/feed/FeedScreen.kt b/shared/app/src/commonMain/kotlin/com/adammcneilly/pocketleague/shared/app/feature/feed/FeedScreen.kt
index df675583..1ccfe3f9 100644
--- a/shared/app/src/commonMain/kotlin/com/adammcneilly/pocketleague/shared/app/feature/feed/FeedScreen.kt
+++ b/shared/app/src/commonMain/kotlin/com/adammcneilly/pocketleague/shared/app/feature/feed/FeedScreen.kt
@@ -5,6 +5,10 @@ import androidx.compose.runtime.collectAsState
 import androidx.compose.ui.Modifier
 import org.koin.compose.viewmodel.koinViewModel
 
+/**
+ * Top level container for the Feed screen inside the application. This is a stateful
+ * wrapper around [FeedContent].
+ */
 @Composable
 fun FeedScreen(
     modifier: Modifier = Modifier,