MySQL Doxygen 문서 콘텐츠 생성

MySQL의 소스 코드에는 Doxygen을 사용하여 작성된 광범위한 내부 문서가 포함되어 있습니다. 이 Doxygen 콘텐츠는 https://dev.mysql.com/doc/index-other.html에서 확인할 수 있습니다. 이 Doxygen 콘텐츠는 MySQl 소스 배포판에서 로컬로 생성될 수 있습니다. -

Doxygen 설치

첫 번째 단계는 Doxygen 1.8.11 이상을 설치하는 것입니다. 이러한 배포판은 http://www.doxygen.nl/에서 구할 수 있습니다.

설치 후 버전 번호를 확인해야 합니다. 이 작업은 다음 명령을 사용하여 수행할 수 있습니다. -

shell > doxygen −−version
1.8.13

Install 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

위 내용은 MySQL Doxygen 문서 콘텐츠 생성의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!