Skip to content

Commit a6bca72

Browse files
committed
docs ( #47 ) : 누락된 kdoc 추가
1 parent 114e3ce commit a6bca72

6 files changed

Lines changed: 18 additions & 0 deletions

File tree

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/document/admin/AdminApiDocument.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ import io.swagger.v3.oas.annotations.tags.Tag
1515
import org.springframework.http.ResponseEntity
1616
import org.springframework.web.bind.annotation.RequestBody
1717

18+
/**
19+
* 어드민 관련 API 문서화를 위한 인터페이스입니다.
20+
*/
1821
@Tag(name = "어드민 API", description = "어드민 관련 API")
1922
interface AdminApiDocument {
2023

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/document/application/ApplicationQueryApiDocument.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ import org.springframework.http.ResponseEntity
1515
import org.springframework.web.bind.annotation.PathVariable
1616
import org.springframework.web.bind.annotation.RequestParam
1717

18+
/**
19+
* 원서 조회 관련 API 문서화를 위한 인터페이스입니다.
20+
*/
1821
@Tag(name = "원서 조회 API", description = "원서 조회 관련 API")
1922
interface ApplicationQueryApiDocument {
2023

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/document/application/ApplicationSubmissionApiDocument.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ import io.swagger.v3.oas.annotations.tags.Tag
1111
import org.springframework.http.ResponseEntity
1212
import org.springframework.web.bind.annotation.RequestBody
1313

14+
/**
15+
* 원서 제출 관련 API 문서화를 위한 인터페이스입니다.
16+
*/
1417
@Tag(name = "원서 제출 API", description = "원서 제출 관련 API")
1518
interface ApplicationSubmissionApiDocument {
1619

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/document/application/WebApplicationApiDocument.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ import org.springframework.http.ResponseEntity
1414
import org.springframework.web.bind.annotation.RequestBody
1515
import org.springframework.web.bind.annotation.RequestParam
1616

17+
/**
18+
* 웹 애플리케이션 관련 API 문서화를 위한 인터페이스입니다.
19+
*/
1720
@Tag(name = "웹 애플리케이션 API", description = "웹 애플리케이션 관련 API")
1821
interface WebApplicationApiDocument {
1922

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/document/formula/FormulaSetApiDocument.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ import org.springframework.http.ResponseEntity
1717
import org.springframework.web.bind.annotation.PathVariable
1818
import org.springframework.web.bind.annotation.RequestBody
1919

20+
/**
21+
* 수식 집합 관련 API 문서화를 위한 인터페이스입니다.
22+
*/
2023
@Tag(name = "수식 집합 API", description = "수식 집합 관련 API")
2124
interface FormulaSetApiDocument {
2225

casper-application-infrastructure/src/main/kotlin/hs/kr/entrydsm/application/global/document/user/UserApiDocument.kt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ import org.springframework.http.ResponseEntity
1414
import org.springframework.web.bind.annotation.PathVariable
1515
import org.springframework.web.bind.annotation.RequestBody
1616

17+
/**
18+
* 사용자 관련 API 문서화를 위한 인터페이스입니다.
19+
*/
1720
@Tag(name = "사용자 API", description = "사용자 관련 API")
1821
interface UserApiDocument {
1922

0 commit comments

Comments
 (0)