[ADD/#201] 공통 컴포넌트 문서화

core/src/main/java/com/terning/core/designsystem/component/dialog/TerningBasicDialog.kt

@@ -21,6 +21,14 @@ import com.terning.core.designsystem.theme.Grey300
 import com.terning.core.designsystem.theme.White
 import com.terning.core.extension.noRippleClickable
 
+/**
+ * 앱에서 사용하는 다이얼로그의 기본 프레임입니다.
+ *
+ * @param onDismissRequest 사용자가 다이얼로그를 닫을 때 호출되는 콜백입니다.
+ * @param properties 다이얼로그의 속성입니다.
+ * @param content 다이얼로그의 내용을 구성하는 컴포저블 컨텐츠입니다.
+ */
+
 @Composable
 fun TerningBasicDialog(
     onDismissRequest: () -> Unit,

core/src/main/java/com/terning/core/designsystem/component/item/InternItem.kt

@@ -1,7 +1,6 @@
 package com.terning.core.designsystem.component.item
 
 import androidx.compose.foundation.Image
-import androidx.compose.foundation.background
 import androidx.compose.foundation.layout.Box
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.IntrinsicSize
@@ -30,13 +29,24 @@ import androidx.compose.ui.unit.dp
 import coil.compose.AsyncImage
 import coil.request.ImageRequest
 import com.terning.core.R
-import com.terning.core.designsystem.theme.Grey300
 import com.terning.core.designsystem.theme.Grey400
 import com.terning.core.designsystem.theme.TerningMain
 import com.terning.core.designsystem.theme.TerningPointTheme
 import com.terning.core.designsystem.theme.TerningTheme
 import com.terning.core.extension.noRippleClickable
 
+/**
+ * 홈, 달력, 검색 화면에서 공고를 나타낼 때 사용되는 뷰입니다.
+ *
+ * @param imageUrl 공고 이미지 URL입니다.
+ * @param title 공고 제목입니다.
+ * @param dateDeadline 공고 기한입니다.
+ * @param workingPeriod 공고 근무 기간입니다.
+ * @param isScraped 스크랩 여부입니다.
+ * @param modifier 수정자입니다.
+ * @param scrapId 공고 아이디입니다.
+ * @param onScrapButtonClicked 스크랩 버튼 클릭 시 호출되는 콜백입니다.
+ */
 
 @Composable
 fun InternItem(

core/src/main/java/com/terning/core/designsystem/component/item/ScrapBox.kt

@@ -22,11 +22,15 @@ import com.terning.core.designsystem.theme.TerningPointTheme
 import com.terning.core.designsystem.theme.White
 
 /**
- * ScrapBox is made for easy customization of scrap box used in Calendar & Home Screen
+ * 홈과 달력 화면에서 스크랩된 공고 목록을 표시하기 위해 사용하는 컴포넌트입니다.
  *
- * [modifier] must be assigned for assigning size of the box and padding
- * [elevation] must be set greater than zero for shadow effect, mainly used in Calendar
- * [borderWidth] must be set greater than zero for border effect, mainly used in Home
+ * @param cornerRadius 코너 둥근 정도입니다.
+ * @param scrapColor 좌측 공간의 색상입니다.
+ * @param modifier 수정자입니다.
+ * @param elevation 그림자입니다.
+ * @param borderWidth 테두리 두께입니다.
+ * @param borderColor 테두리 색상입니다.
+ * @param content 컴포저블 내용입니다.
  */
 
 @Composable

core/src/main/java/com/terning/core/designsystem/component/item/TerningLottieAnimation.kt

@@ -9,6 +9,14 @@ import com.airbnb.lottie.compose.LottieAnimation
 import com.airbnb.lottie.compose.LottieCompositionSpec
 import com.airbnb.lottie.compose.rememberLottieComposition
 
+/**
+ * 로티애니메이션을 표시하기 위한 컴포넌트입니다.
+ *
+ * @param jsonString 로티애니메이션의 JSON 문자열로, assets 폴더에 있는 JSON 파일의 이름입니다.
+ * @param modifier 수정자입니다.
+ * @param iterations 반복 횟수입니다. 기본값은 1회입니다.
+ */
+
 @Composable
 fun TerningLottieAnimation(
     jsonString: String,

core/src/main/java/com/terning/core/designsystem/component/topappbar/CalendarTopAppBar.kt

@@ -26,14 +26,25 @@ import com.terning.core.extension.noRippleClickable
 import java.time.LocalDate
 import java.time.YearMonth
 
+/**
+ * 달력의 상단바를 표시하기 위한 컴포넌트입니다.
+ *
+ * @param date 현재 표시되는 연월입니다.
+ * @param isWeekExpanded 주간 달력 뷰가 확장되었는지 여부입니다.
+ * @param isListExpanded 목록 뷰가 확장되었는지 여부입니다.
+ * @param onListButtonClicked 목록 버튼을 클릭했을 때 호출되는 콜백입니다.
+ * @param onMonthNavigationButtonClicked 연월을 변경하는 버튼을 클릭했을 때 호출되는 콜백입니다.
+ * @param modifier 수정자입니다.
+ */
+
 @Composable
 fun CalendarTopAppBar(
-    modifier: Modifier = Modifier,
     date: YearMonth,
     isWeekExpanded: Boolean,
     isListExpanded: Boolean,
     onListButtonClicked: () -> Unit,
     onMonthNavigationButtonClicked: (Int) -> Unit,
+    modifier: Modifier = Modifier
 ) {
     Box(
         modifier = modifier