본문 바로가기
Web Programming/springboot

Gradle에서 JavaDoc생성시 한글깨짐 문제

by 맑은안개 2023. 3. 17.

Gradle에서 JavaDoc 을 실행하여 Springboot 프로젝트를 문서화하는 과정에서 아래의 오류 발생

 

.. 생략 ..

C:\Dev\restapi\src\main\java\com\example\restapi\dto\requestDTO.java:51: error: unmappable character (0xEC) for encoding x-windows-949
    @ApiModelProperty(notes = "?쟾?넀?슏?닔", example = "0",  dataType = "number")
    
    100 errors

> Task :javadoc FAILED

FAILURE: Build failed with an exception.

 

해결과정

1. 한글을 포함한 Java 코드를 EUC-KR로 변경 후 JavaDoc실행시 오류 해결 됨, 하지만 Swagger에서 한글이 깨지는 문제.

2. 다시 UTF-8로 원복하여 Gradle에 다음의 코드를 추가

tasks.withType(Javadoc) {
    options.addStringOption('Xdoclint:none', '-quiet')
    options.encoding = "UTF-8"
}
  • options.addStringOption('Xdoclint:none', '-quiet') 은 JavaDoc명령 실행 시 경고 메시지 무시, 출력 메시지를 최소화 합니다.

3. JavaDoc Task실행 후 정상 처리 됨을 확인

$ ./gradlew javaDoc

BUILD SUCCESSFUL in 10s
3 actionable tasks: 1 executed, 2 up-to-date

 

반응형