Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable Doxygen generation #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Enable Doxygen generation #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,17 @@ message(STATUS ${HDF5_INCLUDE_DIR})
add_subdirectory(test)
enable_testing()
add_subdirectory(src)

option(BUILD_DOC "Build documentation" OFF)
if(BUILD_DOC)
find_package(Doxygen REQUIRED)
configure_file(Doxyfile.in Doxyfile @ONLY)
add_custom_target(docs-mrf
COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
COMMENT "Generating API documentation with Doxygen"
VERBATIM)
if(NOT TARGET docs)
add_custom_target(docs ALL)
endif()
add_dependencies(docs docs-mrf)
endif()
26 changes: 26 additions & 0 deletions Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
PROJECT_NAME = "LP_MP-MRF"
PROJECT_BRIEF = "Message-Passing for Markov Random Fields"
QUIET = YES

OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@/docs/
INPUT = @CMAKE_CURRENT_SOURCE_DIR@/include
RECURSIVE = YES

GENERATE_TAGFILE = @CMAKE_CURRENT_BINARY_DIR@/docs/lpmp_mrf.tag
TAGFILES = \
@CMAKE_CURRENT_BINARY_DIR@/external/LP_MP/docs/lpmp.tag=../external/LP_MP/docs \
@CMAKE_CURRENT_BINARY_DIR@/external/LP_MP/external/DD_ILP/docs/ddilp.tag=../external/LP_MP/external/DD_ILP/docs

MARKDOWN_SUPPORT = YES
BUILTIN_STL_SUPPORT = YES

EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
INTERNAL_DOCS = YES

SOURCE_BROWSER = YES

GENERATE_LATEX = NO
GENERATE_HTML = YES
HTML_OUTPUT = "."