Skip to content

Commit

Permalink
doc: fix doxygen configuration to actually find evsql.h vol2: can haz…
Browse files Browse the repository at this point in the history
… `git add ...`
  • Loading branch information
SpComb committed Feb 15, 2014
1 parent 93c8c54 commit 2841a70
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
22 changes: 12 additions & 10 deletions doc/CMakeLists.txt
@@ -1,33 +1,35 @@
# We need Doxygen
find_package (Doxygen)

# set our .dox path
# path to .dox with general project info
set (PROJECT_DOX_FILE "${CMAKE_CURRENT_SOURCE_DIR}/evsql.dox")

# where to install doxygen output
# source file/dirs to generate docs from
set (PROJECT_DOC_SOURCES "${PROJECT_SOURCE_DIR}/src/include/evsql.h")

# generate doxygen output under .../html
set (PROJECT_DOXYGEN_DIR "${PROJECT_SOURCE_DIR}/doc")

IF (DOXYGEN_FOUND)
# doxygen config path
set (DOXYGEN_CONFIG "${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf")

# doxygen.conf.in -> doxygen.conf
configure_file (
${CMAKE_CURRENT_SOURCE_DIR}/doxygen.conf.in
${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf
${DOXYGEN_CONFIG}
@ONLY
)

# set doxygen config path
set (DOXYGEN_CONFIG "${CMAKE_CURRENT_BINARY_DIR}/doxygen.conf")

# add custom doc target
ADD_CUSTOM_TARGET(
doc
ADD_CUSTOM_TARGET(doc
${DOXYGEN_EXECUTABLE} ${DOXYGEN_CONFIG}
)

MESSAGE (STATUS "Doxygen: output will be installed in ${PROJECT_DOXYGEN_DIR}")
MESSAGE (STATUS "Doxygen: output will be generated in ${PROJECT_DOXYGEN_DIR}/html")

ELSE (DOXYGEN_FOUND)
MESSAGE (STATUS "Doxygen: not found :(")
MESSAGE (STATUS "Doxygen: install `doxygen` and rerun cmake to use `make doc`")

ENDIF (DOXYGEN_FOUND)

4 changes: 2 additions & 2 deletions doc/doxygen.conf.in
Expand Up @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.

PROJECT_NAME = "@PROJECT_LONG_NAME@"
PROJECT_NAME = "@PROJECT_NAME@"

# The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or
Expand Down Expand Up @@ -534,7 +534,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.

INPUT = @PROJECT_DOX_FILE@ @PROJECT_SOURCECODE_DIR@
INPUT = @PROJECT_DOX_FILE@ @PROJECT_DOC_SOURCES@

# 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
Expand Down

0 comments on commit 2841a70

Please sign in to comment.