From ac0197ad6a7c0bf76a0e7112106090b5e9393c60 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Mon, 12 Aug 2024 23:59:19 +0900
Subject: [PATCH 01/12] [FEAT/#175] add Dokka library

---
 build.gradle.kts          | 1 +
 gradle/libs.versions.toml | 6 +++++-
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/build.gradle.kts b/build.gradle.kts
index c5adb7afd..0e4b0d2f0 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -9,6 +9,7 @@ plugins {
     alias(libs.plugins.android.test) apply false
     alias(libs.plugins.ksp) apply false
     alias(libs.plugins.kotlin.parcelize) apply false
+    alias(libs.plugins.dokka) apply false
 }
 
 buildscript {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
index fcdb0aac4..68c90d89e 100644
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@@ -90,6 +90,9 @@ processPhoenix = "2.0.0"
 ## Web
 browser = "1.4.0"
 
+## dokka
+dokka = "1.6.10"
+
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "androidxCore" }
 androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "androidxAppCompat" }
@@ -182,4 +185,5 @@ kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", versi
 hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }
 android-test = { id = "com.android.test", version.ref = "androidGradlePlugin" }
 ksp = {id = "com.google.devtools.ksp", version.ref = "ksp"}
-kotlin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlinParcelize" }
\ No newline at end of file
+kotlin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlinParcelize" }
+dokka = {id = "org.jetbrains.dokka", version.ref = "dokka"}
\ No newline at end of file

From 8f92a62e0b702bf0c141753341c518d3c915b90d Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Tue, 13 Aug 2024 00:12:28 +0900
Subject: [PATCH 02/12] [ADD/#175] add Dokka library

---
 app/build.gradle.kts  | 1 -
 core/build.gradle.kts | 9 +++++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/app/build.gradle.kts b/app/build.gradle.kts
index c8d5fa787..4f7c37a0e 100644
--- a/app/build.gradle.kts
+++ b/app/build.gradle.kts
@@ -116,5 +116,4 @@ dependencies {
 
     // KakaoDependencies
     implementation(libs.kakao.user)
-
 }
diff --git a/core/build.gradle.kts b/core/build.gradle.kts
index 869ba3374..0a8f86153 100644
--- a/core/build.gradle.kts
+++ b/core/build.gradle.kts
@@ -1,6 +1,7 @@
 plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.kotlin.android)
+    alias(libs.plugins.dokka)
 }
 
 android {
@@ -40,6 +41,14 @@ android {
     }
 }
 
+tasks.dokkaHtml.configure {
+    dokkaSourceSets {
+        named("main") {
+            noAndroidSdkLink.set(false)
+        }
+    }
+}
+
 dependencies {
     // Kotlin
     implementation(libs.kotlin)

From ecdacf4e65ef809a66bc9c7dc20f130a1bb19268 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Tue, 13 Aug 2024 00:14:12 +0900
Subject: [PATCH 03/12] =?UTF-8?q?[ADD/#175]=20=EC=BB=B4=ED=8F=AC=EB=84=8C?=
 =?UTF-8?q?=ED=8A=B8=20=EC=9E=84=EC=8B=9C=20=EC=A3=BC=EC=84=9D=20=EC=B6=94?=
 =?UTF-8?q?=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../core/designsystem/component/button/TerningBasicButton.kt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt b/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt
index cc4f86985..f8343416e 100644
--- a/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt
+++ b/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt
@@ -30,6 +30,11 @@ import com.terning.core.designsystem.theme.TerningTheme
 import com.terning.core.designsystem.theme.White
 import com.terning.core.util.NoRippleTheme
 
+/**
+ * 기본 버튼 입니다.
+ *
+ * @param shape 버튼의 모양 설정
+ */
 @Composable
 fun TerningBasicButton(
     shape: Shape,

From fb98c6dbd266573ed6e9b6eabab62b35abe864bf Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Wed, 14 Aug 2024 22:22:59 +0900
Subject: [PATCH 04/12] [ADD/#175] change Dokka Version

---
 core/build.gradle.kts     | 6 ++++++
 gradle/libs.versions.toml | 2 +-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/core/build.gradle.kts b/core/build.gradle.kts
index 0a8f86153..c3685a558 100644
--- a/core/build.gradle.kts
+++ b/core/build.gradle.kts
@@ -41,6 +41,12 @@ android {
     }
 }
 
+buildscript {
+    dependencies {
+        classpath("org.jetbrains.dokka:dokka-base:1.6.10")
+    }
+}
+
 tasks.dokkaHtml.configure {
     dokkaSourceSets {
         named("main") {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
index 68c90d89e..29d2a6622 100644
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@@ -91,7 +91,7 @@ processPhoenix = "2.0.0"
 browser = "1.4.0"
 
 ## dokka
-dokka = "1.6.10"
+dokka = "1.9.0"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "androidxCore" }

From 0646bde7228abfe1bcf24a575d443ed21f8be449 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Wed, 14 Aug 2024 23:17:56 +0900
Subject: [PATCH 05/12] [ADD/#175] add dokka file

---
 .github/workflows/dokka.yml | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 .github/workflows/dokka.yml

diff --git a/.github/workflows/dokka.yml b/.github/workflows/dokka.yml
new file mode 100644
index 000000000..8a741b352
--- /dev/null
+++ b/.github/workflows/dokka.yml
@@ -0,0 +1,30 @@
+name: TerningPoint DesignSystem CI
+
+on:
+  push:
+    branches: [ develop ]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 18
+        uses: actions/setup-java@v4
+        with:
+          java-version: 18
+          distribution: "temurin"
+
+      - name: permissions
+        run: chmod +x gradlew
+
+      - name: Build Documentation
+        run: ./gradlew dokkaHtml
+
+      - name: Deploy Documentation to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          BRANCH: gh-pages
+          FOLDER: core/build/dokka/html
+          TARGET_FOLDER: 'designsystem'
\ No newline at end of file

From 1cb6c693c917a48bdec622a907810d0115e0f02a Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 02:27:30 +0900
Subject: [PATCH 06/12] [ADD/#175] delete TARGET_FOLDER

---
 .github/workflows/dokka.yml | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/.github/workflows/dokka.yml b/.github/workflows/dokka.yml
index 8a741b352..5469273f5 100644
--- a/.github/workflows/dokka.yml
+++ b/.github/workflows/dokka.yml
@@ -26,5 +26,4 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           BRANCH: gh-pages
-          FOLDER: core/build/dokka/html
-          TARGET_FOLDER: 'designsystem'
\ No newline at end of file
+          FOLDER: core/build/dokka/html
\ No newline at end of file

From f610e44be1b2c69ed38b97ecbed19ba37f6029a8 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 03:06:29 +0900
Subject: [PATCH 07/12] =?UTF-8?q?[ADD/#175]=20TerningBasicButton=20?=
 =?UTF-8?q?=EC=A3=BC=EC=84=9D=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../component/button/TerningBasicButton.kt             | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt b/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt
index f8343416e..2b4ac9788 100644
--- a/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt
+++ b/core/src/main/java/com/terning/core/designsystem/component/button/TerningBasicButton.kt
@@ -31,9 +31,15 @@ import com.terning.core.designsystem.theme.White
 import com.terning.core.util.NoRippleTheme
 
 /**
- * 기본 버튼 입니다.
+ * 기본 버튼 함수입니다.
  *
- * @param shape 버튼의 모양 설정
+ * @param shape 버튼의 모양을 설정합니다.
+ * @param style 버튼 텍스트의 스타일을 정의합니다.
+ * @param paddingVertical 버튼의 위아래 패딩을 설정합니다. 패딩 값은 Dp 단위입니다.
+ * @param text 버튼에 표시될 텍스트입니다.
+ * @param onButtonClick 버튼 클릭 시 호출될 콜백 함수입니다.
+ * @param modifier 버튼에 적용할 Modifier입니다.
+ * @param isEnabled 버튼의 활성화 상태를 정의합니다.
  */
 @Composable
 fun TerningBasicButton(

From d23715f58f2d222d68e9ecb290e9aa8af108a8a8 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 03:16:43 +0900
Subject: [PATCH 08/12] =?UTF-8?q?[DEL/#175]=20core=20=EB=AA=A8=EB=93=88=20?=
 =?UTF-8?q?=EA=B7=B8=EB=9E=98=EB=93=A4=20=EB=B6=88=ED=95=84=EC=9A=94?=
 =?UTF-8?q?=ED=95=9C=20=EC=BD=94=EB=93=9C=20=EC=82=AD=EC=A0=9C?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/build.gradle.kts | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/core/build.gradle.kts b/core/build.gradle.kts
index c3685a558..0a8f86153 100644
--- a/core/build.gradle.kts
+++ b/core/build.gradle.kts
@@ -41,12 +41,6 @@ android {
     }
 }
 
-buildscript {
-    dependencies {
-        classpath("org.jetbrains.dokka:dokka-base:1.6.10")
-    }
-}
-
 tasks.dokkaHtml.configure {
     dokkaSourceSets {
         named("main") {

From 63cf60e3267a98b893af47c1d267e489264897f8 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 03:21:12 +0900
Subject: [PATCH 09/12] =?UTF-8?q?[ADD/#175]=20docs.md=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/docs.md | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 core/docs.md

diff --git a/core/docs.md b/core/docs.md
new file mode 100644
index 000000000..c1147080d
--- /dev/null
+++ b/core/docs.md
@@ -0,0 +1,3 @@
+# com.terning.core.designsystem.component.bottomsheet
+바텀시트가 있는 패키지입니다.
+

From 30d29124dd4d6fa832d01bfc0805d7a7c34f0224 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 03:34:33 +0900
Subject: [PATCH 10/12] =?UTF-8?q?[ADD/#175]=20docs.md=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/docs.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/core/docs.md b/core/docs.md
index c1147080d..c014df172 100644
--- a/core/docs.md
+++ b/core/docs.md
@@ -1,3 +1,28 @@
-# com.terning.core.designsystem.component.bottomsheet
+# Package com.terning.core.designsystem.component.bottomsheet
 바텀시트가 있는 패키지입니다.
 
+# Package com.terning.core.designsystem.component.button
+버튼이 있는 패키지입니다.
+
+# Package com.terning.core.designsystem.component.datepicker
+
+# Package com.terning.core.designsystem.component.dialog
+
+# Package com.terning.core.designsystem.component.image
+
+# Package com.terning.core.designsystem.component.item
+
+# Package com.terning.core.designsystem.component.textfield
+
+# Package com.terning.core.designsystem.component.topappbar
+
+# Package com.terning.core.designsystem.theme
+
+# Package com.terning.core.extension
+확장함수를 모아놓은 패키지입니다.
+
+# Package com.terning.core.navigation
+
+# Package com.terning.core.state
+
+# Package com.terning.core.util

From 74cc36578b36b61413d308dec2003de02936841c Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 03:42:48 +0900
Subject: [PATCH 11/12] =?UTF-8?q?[ADD/#175]=20docs.md=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/build.gradle.kts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/core/build.gradle.kts b/core/build.gradle.kts
index 0a8f86153..b1e09da7e 100644
--- a/core/build.gradle.kts
+++ b/core/build.gradle.kts
@@ -44,6 +44,7 @@ android {
 tasks.dokkaHtml.configure {
     dokkaSourceSets {
         named("main") {
+            includes.from("docs.md")
             noAndroidSdkLink.set(false)
         }
     }

From aa27078548ea53b7a7ad008667e5b497ad4278e9 Mon Sep 17 00:00:00 2001
From: LEE YOU BIN <youbeene3409@naver.com>
Date: Thu, 15 Aug 2024 03:52:08 +0900
Subject: [PATCH 12/12] =?UTF-8?q?[ADD/#175]=20docs.md=20=EC=84=A4=EB=AA=85?=
 =?UTF-8?q?=20=EC=B6=94=EA=B0=80?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 core/docs.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/core/docs.md b/core/docs.md
index c014df172..a2447db18 100644
--- a/core/docs.md
+++ b/core/docs.md
@@ -5,24 +5,34 @@
 버튼이 있는 패키지입니다.
 
 # Package com.terning.core.designsystem.component.datepicker
+데이트 피커가 있는 패키지입니다.
 
 # Package com.terning.core.designsystem.component.dialog
+다이얼로그가 있는 패키지입니다.
 
 # Package com.terning.core.designsystem.component.image
+contentDescription을 사용하지 않는 Image가 담긴 패키지입니다.
 
 # Package com.terning.core.designsystem.component.item
+여러 화면에서 쓰이는 아이템들이 들어있는 패키지입니다.
 
 # Package com.terning.core.designsystem.component.textfield
+텍스트 필드가 있는 패키지입니다.
 
 # Package com.terning.core.designsystem.component.topappbar
+탑바가 있는 패키지입니다.
 
 # Package com.terning.core.designsystem.theme
+<terning>의 theme가 있는 패키지입니다.
 
 # Package com.terning.core.extension
 확장함수를 모아놓은 패키지입니다.
 
 # Package com.terning.core.navigation
+네비게이션 루트가 있는 패키지입니다.
 
 # Package com.terning.core.state
+기본 상태를 나타내는 파일이 있는 패키지입니다.
 
 # Package com.terning.core.util
+여러 곳에서 유용하게 쓰이는 객체를 모아놓은 패키지입니다.