chore: (#191) javadoc 추가

Team-ComIT · Dec 7, 2022 · 9ba79e7 · 9ba79e7
1 parent 144b66a
commit 9ba79e7
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/...pplication/src/main/kotlin/team/comit/simtong/domain/file/usecase/CheckEmployeeUseCase.kt b/...pplication/src/main/kotlin/team/comit/simtong/domain/file/usecase/CheckEmployeeUseCase.kt
@@ -4,6 +4,14 @@ import team.comit.simtong.domain.file.exception.InvalidEmployeeException
 import team.comit.simtong.domain.file.spi.QueryEmployeeCertificatePort
 import team.comit.simtong.global.annotation.ReadOnlyUseCase
 
+/**
+ *
+ * 입력받은 이름과 사원번호를 DB에서 비교해 일치하는지 확인하는 CheckEmployeeUseCase
+ *
+ * @author kimbeomjin
+ * @date 2022/12/07
+ * @version 1.0.0
+ **/
 @ReadOnlyUseCase
 class CheckEmployeeUseCase(
     private val queryEmployeeCertificatePort: QueryEmployeeCertificatePort

diff --git a/...main/src/main/kotlin/team/comit/simtong/domain/file/exception/InvalidEmployeeException.kt b/...main/src/main/kotlin/team/comit/simtong/domain/file/exception/InvalidEmployeeException.kt
@@ -3,6 +3,14 @@ package team.comit.simtong.domain.file.exception
 import team.comit.simtong.domain.file.error.FileErrorCode
 import team.comit.simtong.global.error.BusinessException
 
+/**
+ *
+ * DB에 저장된 일치하는 사원이 없는 경우 발생시키는 InvalidEmployeeException
+ *
+ * @author kimbeomjin
+ * @date 2022/12/07
+ * @version 1.0.0
+ **/
 object InvalidEmployeeException : BusinessException(
     FileErrorCode.INVALID_EMPLOYEE
 )
diff --git a/...domain/src/main/kotlin/team/comit/simtong/domain/file/spi/QueryEmployeeCertificatePort.kt b/...domain/src/main/kotlin/team/comit/simtong/domain/file/spi/QueryEmployeeCertificatePort.kt
@@ -1,5 +1,13 @@
 package team.comit.simtong.domain.file.spi
 
+/**
+ *
+ * EmployeeCertificate Domain에 관한 Query를 요청하는 QueryEmployeeCertificatePort
+ *
+ * @author kimbeomjin
+ * @date 2022/12/07
+ * @version 1.0.0
+ **/
 interface QueryEmployeeCertificatePort {
 
     fun existsEmployeeCertificateByNameAndEmployeeNumber(name: String, employeeNumber: Int): Boolean