12345qiupeng
/
gtsam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doxygen documentation no longer build with autotools, added makedoc.sh to build it in top-level directory

release/4.3a0
Richard Roberts 2012-01-10 22:25:12 +00:00
parent c75f7ead65
commit d7317f4eb6
5 changed files with 36 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Doxyfile
View File

@ -567,7 +567,7 @@ FILE_VERSION_FILTER =
# You can optionally specify a file name after the option, if omitted # You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file. # DoxygenLayout.xml will be used as the name of the layout file.
LAYOUT_FILE = $(SRCDIR)/DoxygenLayout.xml LAYOUT_FILE = DoxygenLayout.xml
# The CITE_BIB_FILES tag can be used to specify one or more bib files # The CITE_BIB_FILES tag can be used to specify one or more bib files
# containing the references data. This must be a list of .bib files. The # containing the references data. This must be a list of .bib files. The
@ -638,13 +638,13 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = $(SRCDIR)/gtsam/base \ INPUT = gtsam/base \
$(SRCDIR)/gtsam/geometry \ gtsam/geometry \
$(SRCDIR)/gtsam/inference \ gtsam/inference \
$(SRCDIR)/gtsam/linear \ gtsam/linear \
$(SRCDIR)/gtsam/nonlinear \ gtsam/nonlinear \
$(SRCDIR)/gtsam/slam \ gtsam/slam \
$(SRCDIR)/gtsam gtsam
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

6
Makefile.am
View File

@ -11,7 +11,7 @@ ACLOCAL_AMFLAGS = -I m4
AUTOMAKE_OPTIONS = foreign nostdinc AUTOMAKE_OPTIONS = foreign nostdinc
# For Doxygen integration # For Doxygen integration
include aminclude.am #include aminclude.am
# All the sub-directories that need to be built # All the sub-directories that need to be built
SUBDIRS = CppUnitLite gtsam tests examples SUBDIRS = CppUnitLite gtsam tests examples
@ -24,8 +24,8 @@ endif
EXTRA_DIST = autogen.sh configure.ac COPYING INSTALL LGPL LICENSE README THANKS USAGE doc EXTRA_DIST = autogen.sh configure.ac COPYING INSTALL LGPL LICENSE README THANKS USAGE doc
# For Doxygen integration # For Doxygen integration
MOSTLYCLEANFILES = $(DX_CLEANFILES) #MOSTLYCLEANFILES = $(DX_CLEANFILES)
EXTRA_DIST += $(DX_CONFIG) #EXTRA_DIST += $(DX_CONFIG)
# Remove .svn directories from dist # Remove .svn directories from dist
dist-hook: dist-hook:

6
aminclude.am
View File

@ -5,7 +5,7 @@
# are controlled by the various DX_COND_??? conditionals set by autoconf. # are controlled by the various DX_COND_??? conditionals set by autoconf.
# #
# The provided goals are: # The provided goals are:
# doxygen-doc: Generate all doxygen documentation. # doc: Generate all doxygen documentation.
# doxygen-run: Run doxygen, which will generate some of the documentation # doxygen-run: Run doxygen, which will generate some of the documentation
# (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post # (HTML, CHM, CHI, MAN, RTF, XML) but will not do the post
# processing required for the rest of it (PS, PDF, and some MAN). # processing required for the rest of it (PS, PDF, and some MAN).
@ -158,13 +158,13 @@ DX_CLEAN_LATEX = @DX_DOCDIR@/latex
endif DX_COND_latex endif DX_COND_latex
.PHONY: doxygen-run doxygen-doc $(DX_PS_GOAL) $(DX_PDF_GOAL) .PHONY: doxygen-run doc $(DX_PS_GOAL) $(DX_PDF_GOAL)
.INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL) .INTERMEDIATE: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag doxygen-run: @DX_DOCDIR@/@PACKAGE@.tag
doxygen-doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL) doc: doxygen-run $(DX_PS_GOAL) $(DX_PDF_GOAL)
@DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS) @DX_DOCDIR@/@PACKAGE@.tag: $(DX_CONFIG) $(pkginclude_HEADERS)
rm -rf @DX_DOCDIR@ rm -rf @DX_DOCDIR@

18
configure.ac
View File

@ -19,15 +19,15 @@ AC_CONFIG_SRCDIR([examples/SimpleRotation.cpp])
AC_CONFIG_SRCDIR([gtsam/3rdparty/Makefile.am]) AC_CONFIG_SRCDIR([gtsam/3rdparty/Makefile.am])
# For doxygen support # For doxygen support
DX_HTML_FEATURE(ON) #DX_HTML_FEATURE(ON)
DX_CHM_FEATURE(OFF) #DX_CHM_FEATURE(OFF)
DX_CHI_FEATURE(OFF) #DX_CHI_FEATURE(OFF)
DX_MAN_FEATURE(OFF) #DX_MAN_FEATURE(OFF)
DX_RTF_FEATURE(OFF) #DX_RTF_FEATURE(OFF)
DX_XML_FEATURE(OFF) #DX_XML_FEATURE(OFF)
DX_PDF_FEATURE(OFF) #DX_PDF_FEATURE(OFF)
DX_PS_FEATURE(OFF) #DX_PS_FEATURE(OFF)
DX_INIT_DOXYGEN(gtsam) #DX_INIT_DOXYGEN(gtsam, Doxyfile, doc)
# Check for OS # Check for OS
# needs to be called at some point earlier # needs to be called at some point earlier

13
makedoc.sh Executable file
View File

@ -0,0 +1,13 @@
#!/bin/sh
# Add to PATH the default install path for doxygen on Mac OS X
PATH=$PATH:/Applications/Doxygen.app/Contents/Resources
# Run doxygen from the gtsam directory even if this script is run from another
# directory, so that the output 'doc' goes in the gtsam directory.
GTSAM_DIR=$(dirname "$0")
cd $GTSAM_DIR
doxygen