docs: Add standard Javadoc comments to all Java source files

This commit is contained in:
jade
2026-07-09 09:11:46 +09:00
parent 69d7a7bff0
commit 5e4f88ea41
147 changed files with 2259 additions and 115 deletions

View File

@@ -10,6 +10,20 @@ import lombok.NoArgsConstructor;
@NoArgsConstructor
@AllArgsConstructor
//@Schema(description = "응답 에러 객체. 성공 케이스일 경우 null. 실제 에러가 발생할 경우에만 예외명, 예외 메시지 필드 세팅 예정.")
/**
* @package io.shinhanlife.glow
* @className BaseException
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class BaseException {
// @Schema(description = "Error 코드 Meta 참조 운영. (예) 20001, 50001 등", shinhanlife = "20001")
@@ -26,4 +40,4 @@ public class BaseException {
@Builder.Default
String exceptionDetail = "";
}
}

View File

@@ -5,6 +5,20 @@ import lombok.Builder;
import lombok.Getter;
import lombok.ToString;
/**
* @package io.shinhanlife.glow
* @className BaseResponse
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@ToString
@Getter
@Builder
@@ -22,4 +36,4 @@ public class BaseResponse<T> {
private BaseException error;
}
}

View File

@@ -1,6 +1,20 @@
package io.shinhanlife.glow;
/**
* @package io.shinhanlife.glow
* @className BizException
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public class BizException extends RuntimeException {
public BizException(String s) {
}
}
}

View File

@@ -9,7 +9,21 @@ public @interface GlowLogTarget {
Target[] value() default {};
/**
* @package io.shinhanlife.glow
* @className Target
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
enum Target {
FILE, CONSOLE
}
}
}

View File

@@ -5,6 +5,20 @@ import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
/**
* @package io.shinhanlife.glow
* @className GlowLogger
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Component
@Scope("prototype")
public class GlowLogger {

View File

@@ -10,6 +10,20 @@ import org.apache.ibatis.session.RowBounds;
import java.io.Serial;
import java.io.Serializable;
/**
* @package io.shinhanlife.glow
* @className PageInfo
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@JsonIgnoreProperties(ignoreUnknown = true)
@@ -65,4 +79,4 @@ public class PageInfo extends RowBounds implements Serializable {
return super.getLimit();
}
}
}

View File

@@ -4,6 +4,20 @@ import lombok.Getter;
import lombok.RequiredArgsConstructor;
import org.springframework.http.HttpStatus;
/**
* @package io.shinhanlife.glow
* @className ResponseCode
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@RequiredArgsConstructor
public enum ResponseCode {
@@ -28,4 +42,4 @@ public enum ResponseCode {
private final HttpStatus status;
private final String message;
}
}

View File

@@ -3,6 +3,20 @@ package io.shinhanlife.glow;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
/**
* @package io.shinhanlife.glow
* @className ResponseUtil
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
public final class ResponseUtil {
private ResponseUtil() {
@@ -108,4 +122,4 @@ public final class ResponseUtil {
);
}
}
}

View File

@@ -8,6 +8,20 @@ import lombok.AllArgsConstructor;
import java.util.Date;
/**
* @package io.shinhanlife.glow.db.dto
* @className AuditInfo
* @description AX HUB 시스템 처리 클래스
* @author 김형식
* @create 2026.09.01
* <pre>
* ---------- 개정이력 ----------
* 수정일 수정자 수정내용
* ---------- -------- ---------------------------
* 2026.09.01 김형식 최초생성
*
* </pre>
*/
@Getter
@Setter
@NoArgsConstructor
@@ -23,4 +37,4 @@ public class AuditInfo {
private String systChgOgnzNo; // 시스템변경조직번호
private String systChgSystCd; // 시스템변경시스템코드
private String systChgPrgrId; // 시스템변경프로그램ID
}
}