[Doxygen] 설치 및 한글 인코딩 오류 해결

설치 및 실행

Linux (Ubuntu)

sudo apt update
sudo apt install doxygen
sudo apt install doxygen-gui    # Doxygen GUI frontend
sudo apt install graphviz    

./doxywizard

한글 깨짐 (EUC-KR)

예전에 사용되었던 코드의 경우 파일의 encoding 방식이 euc-kr로 지정되어 있는 경우가 많아, doxygen 으로 생성한 문서에 한글 주석이 올바르게 표시되지 않습니다. 따라서 이 경우 encoding 방식을 다음과 같이 변경합니다.

Export 탭 → Topics → Project
DOXYFILE_ENCODING : EUC-KR
OUTPUT_LANGUAGE : Korean-en

Export 탭 → Topics → Input
INPUT_ENCODING : EUC-KR

오류

위와 같이 encoding 방식을 설정한 후, 다음과 같이 오류가 발생할 수 있습니다. 이것은 EUC-KR과 UTF-8 방식이 프로젝트 내에서 혼합되어 사용되기 때문입니다.

Error: failed to translate characters from  EUC-KR to UTF-8: check INPUT_ENCODING

따라서, 오류가 발생하는 파일 확인하여 EUC-KR 방식으로 다시 저장합니다.

만약, 변경해야 할 파일의 수가 많다면 일괄 변환을 위하여 다음과 같이 스크립트를 사용하여 변환합니다.

#!/bin/bash
# 2016-02-08
# check encoding and convert files
dir=$1
echo $dir
for f in `find $dir | egrep -v Eliminate`
do
  case "$f" in
    *.c | *.cpp | *.h)
    encoding=`file -b --mime-encoding $f`
    case $encoding in
      "iso-8859-1" | "euc-kr")
      # euc-kr 형식도 iso-8859-1 로 검출됨
      iconv -f euc-kr -t utf-8 $f > $f.utf8
      mv $f.utf8 $f
      ;;
    esac
    ;;
  esac
done

참고

• How to find encoding of a file via script on Linux?
• How to Convert Files to UTF-8 Encoding in Linux