MySQL Doxygen 문서 콘텐츠 생성

MySQL의 소스 코드에는 Doxygen을 사용하여 작성된 많은 내부 문서가 포함되어 있습니다. 이 Doxygen 콘텐츠는 https://dev.mysql.com/doc/index-other.html에서 사용할 수 있습니다. 이 Doxygen 콘텐츠는 MySQl 소스 배포판에서 로컬로 생성할 수 있습니다. 이것은 아래 언급된 단계에 따라 수행할 수 있습니다 -

Doxygen 설치

첫 번째 단계는 Doxygen 1.8.11 이상 버전을 설치하는 것입니다. 배포판은 https://www.doxygen.nl/에서 사용할 수 있습니다.

설치가 완료되면 버전 번호를 확인해야 합니다. 이것은 아래 명령을 사용하여 수행할 수 있습니다 -

shell > doxygen −−version
1.8.13

PlantUML 설치

다음 단계는 PlantUML을 설치하는 것입니다. Windows 10에 설치 시 관리자 권한으로 한 번 이상 실행하여 레지스트리 키를 생성해야 합니다.

관리자 콘솔을 열 수 있으며 아래 코드를 실행해야 합니다 -

shell> java −jar path−to−plantuml.jar

위의 명령은 콘솔에 오류 없이 GUI 창을 엽니다.

이 작업이 완료되면 PLANTUML_JAR_PATH 환경 변수를 PlantUML이 설치된 위치로 설정해야 합니다. 예를 살펴보겠습니다 -

shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar

내보내기

Graphviz 설치

다음 단계는 Graphviz dot 명령을 설치하는 것입니다.

이 작업이 완료되면 도트 가용성을 확인해야 합니다. 이것은 아래 명령을 사용하여 수행할 수 있습니다 -

shell> which dot
/usr/bin/dot

shell> dot −V
dot − graphviz version 2.28.0 (20130928.0220)

MySQL 소스 배포판의 최상위 디렉토리 위치를 변경해야 합니다. 이것은 아래 명령을 사용하여 수행할 수 있습니다 -

shell> cd your-mysql-source-directory
shell> mkdir bld
shell> cd bld
shell> cmake ..

cmake가 먼저 실행됩니다.

Doxygen 문서 생성

다음 단계는 doxygen 문서를 생성하는 것입니다. 이것은 아래 명령을 실행하여 수행할 수 있습니다 -

shell> make doxygen

이 작업이 완료되면 오류 로그를 검사해야 합니다. 이것은 최상위 디렉토리에 있는 doxyerror 파일에서 사용할 수 있습니다. 빌드가 제대로 실행되면 생성된 출력을 브라우저에서 볼 수 있습니다. 이것은 아래 명령을 사용하여 수행할 수 있습니다 -

shell> firefox doxygen/html/index.html