Skip to content

Commit

Permalink
improved documentation, added build target doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
fkutzner committed Feb 11, 2017
1 parent 9a7b49f commit 3d7376e
Show file tree
Hide file tree
Showing 19 changed files with 696 additions and 52 deletions.
12 changes: 11 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
# the test output only when it fails) or ctest --verbose
#
#
# To build the documentation, run
# make doxygen
# or
# cmake --build . --target doxygen
#
# The documentation is generated in doc/ within your build directory.
#
# II. Invoking cmake
#
# Examples:
Expand Down Expand Up @@ -76,6 +83,9 @@ option(CANDY_DISABLE_RTTI OFF "Disable RTTI and defines CANDY_HAS_NO_RTTI. Use w
enable_testing()


### Add doxygen targets
add_subdirectory(doc)

### Compiler flags

set(CMAKE_CXX_FLAGS "-std=c++11 -Wall -Wno-parentheses -D __STDC_LIMIT_MACROS -D __STDC_FORMAT_MACROS -march=native")
Expand Down Expand Up @@ -115,7 +125,7 @@ endfunction()

### Set up include directories

include_directories(${PROJECT_SOURCE_DIR})
include_directories(${PROJECT_SOURCE_DIR}/src)
# for refactoring purposes, TODO: use e.g. candy/core/SolverTypes.h instead of core/SolverTypes.h
include_directories(${PROJECT_SOURCE_DIR}/src/candy)

Expand Down
6 changes: 6 additions & 0 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
find_package(Doxygen)

if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(doxygen ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
endif()
Loading

0 comments on commit 3d7376e

Please sign in to comment.