2.8.10 Generating MySQL Doxygen Documentation Content

2.8.10 MySQL Doxygen Documentation 콘텐츠 생성

MySQL 소스 코드에는 Doxygen을 사용해 작성된 내부 도큐멘테이션이 포함되어 있습니다. 생성된 Doxygen 콘텐츠는 https://dev.mysql.com/doc/index-other.html에서 제공됩니다. 또한 다음 절차를 사용하여 MySQL 소스 배포본에서 이 콘텐츠를 로컬로 생성할 수도 있습니다:

1. doxygen 1.9.2 이상을 설치합니다.
   배포판은 http://www.doxygen.nl/에서 제공됩니다.

   doxygen을 설치한 후, 버전 번호를 확인합니다:

1$> doxygen --version
21.9.2

2. PlantUML을 설치합니다.

   Windows(Windows 10에서 테스트됨)에 PlantUML을 설치할 때에는, 레지스트리 키를 생성하도록 적어도 한 번은 관리자 권한으로 실행해야 합니다. 관리자 콘솔을 열고 다음 명령을 실행합니다:

1$> java -jar path-to-plantuml.jar

이 명령은 GUI 창을 열고, 콘솔에 오류를 출력하지 않아야 합니다.

3. PLANTUML_JAR_PATH 환경 변수를 PlantUML을 설치한 위치로 설정합니다. 예를 들면 다음과 같습니다:

1$> export PLANTUML_JAR_PATH=path-to-plantuml.jar

4. Graphviz dot 명령을 설치합니다.

   Graphviz를 설치한 후, dot 사용 가능 여부를 확인합니다. 예를 들면 다음과 같습니다:

1$> which dot
2/usr/bin/dot
3
4$> dot -V
5dot - graphviz version 2.40.1 (20161225.0304)

5. MySQL 소스 배포본의 최상위 디렉터리로 위치를 변경하고 다음을 수행합니다:

   먼저 cmake를 실행합니다:

1$> cd mysql-source-directory
2$> mkdir build
3$> cd build
4$> cmake ..

다음으로 **doxygen** 도큐멘테이션을 생성합니다:

1$> make doxygen

최상위 디렉터리에 있는 `doxyerror.log` 파일에서 오류 로그를 확인합니다. 빌드가 성공적으로 실행되었다고 가정하면, 브라우저를 사용해 생성된 출력 결과를 확인합니다. 예를 들면 다음과 같습니다:

1$> firefox doxygen/html/index.html