Doxygen 문서를 AutoTools로 생성 (및 설치)합니다

StackOverflow https://stackoverflow.com//questions/10682603

  •  12-12-2019
  •  | 
  •  

문제

DoxyGen을 사용하여 모든 API 문서가 수행되는 모든 API 문서가 수행되는 라이브러리 (libtools 사용)를 작성합니다.

생성 된 Doxygen 문서의 설치를 AutoTools에 통합하는 쉬운 방법이 있는지 궁금합니다.

Documentation을 빌드해야한다는 것을 알아야합니다. 그러나 일단 Doxygen을 실행하면 생성 된 (예 :) .html 파일을 $ (htmldir)로 가져 오는 적절한 방법은 무엇입니까?

문제는 내가 모르는 것처럼 보이는 것처럼 보입니다 (알고 싶지 않음) doxygen이 나를 위해 만들 것인가? 그래서 나는 그들 모두를 html_data 에 열거 할 수 없다.

html_data= html /*.* '와 같은 것을 알 수 있습니다 bad 아이디어

도움이 되었습니까?

해결책

Autotools 나 자신에게 많은 경험이없는 동안이 메일 스레드에서 몇 가지 제안이 이루어질 수 있습니다. http://old.nabble.com/How-to-install-doxygen-elegourted-html 문서 - TD17029178.html

다른 팁

약간의 공헌 매크로를 사용하기 위해 더 콤팩트 할 수 있습니다.여기에서 John Calcote PG 246의 Autotools Book의 예제를 기반으로 간단한 방법을 알아 냈습니다.

다음을 추가하여 configure.ac 바로 위에 

AC_CONFIG_FILES([Makefile
.

라인 

AC_CHECK_PROGS([DOXYGEN], [doxygen])
if test -z "$DOXYGEN"; then
   AC_MSG_WARN([Doxygen not found - continue without Doxygen support])
fi
AC_CHECK_PROGS([DOT], [dot])
if test -z "$DOT"; then
   AC_MSG_ERROR([Doxygen needs dot, please install dot first])
fi
AC_CHECK_PROGS([PDFLATEX], [pdflatex])
if test -z "$PDFLATEX"; then
   AC_MSG_ERROR([Doxygen needs pdflatex program, it is part of TeX http://www.tug.org/texlive/acquire-netinstall.html])
fi
AM_CONDITIONAL([HAVE_DOXYGEN], [test -n "$DOXYGEN"])
AM_COND_IF([HAVE_DOXYGEN], [AC_CONFIG_FILES([docs/Doxyfile])])
AM_COND_IF([HAVE_DOXYGEN], [AC_CONFIG_FILES([docs/Makefile])])
. ProjectDir / Docs 디렉토리의

두 파일 추가 : doxyfile.in 및 makefile.am

대체 변수 사용 예 : 

PROJECT_NAME           = @PACKAGE_NAME@
PROJECT_NUMBER         = @PACKAGE_VERSION@
INPUT                  = @top_srcdir@
.

다른 Doxygen 구성 필드를 올바르게 수정하십시오. 

LATEX_OUTPUT           = latex
PDF_HYPERLINKS         = YES
USE_PDFLATEX           = YES
.

이 방법으로 PDF 파일을 생성합니다.

makefile.am은 간단해야합니다 : 

if HAVE_DOXYGEN
directory = $(top_srcdir)/docs/man/man3

man_MANS = $(directory)

$(directory): doxyfile.stamp

doxyfile.stamp: Doxyfile
    $(DOXYGEN) $^
    cd latex && $(MAKE)
    echo Timestamp > $@

CLEANFILES = doxyfile.stamp

all-local: doxyfile.stamp
clean-local:
    -rm -rf $(top_srcdir)/docs/man

endif
.

(이를 복사하는 동안 makefile 들여 쓰기를 존중하십시오.)

이것은 나를 위해 일한 것처럼 보였습니다.결과 문서는 문서 폴더에 생성됩니다.실수를 한 지 알려주십시오.

OREN Ben-kiki의 매크로를 사용합니다 http : //www.ben-kiki.org/oren/doxample/ 또는 google 이 스크립트는 PDF / HTML / MAN (구성 가능한) 형식으로 Doxygen 설명서를 만듭니다.

생성 된 도움말 파일을 makefile.am의 * dist_doc_data * 목록에 추가하십시오.

라이센스 : CC-BY-SA ~와 함께 속성
제휴하지 않습니다 StackOverflow
scroll top