Commit a9a7fc18 authored by Gilles Caulier's avatar Gilles Caulier 🗼

move Doxyfile at root of source dir to be compatible with API doc script used with KDE (i hope)

remove configuration done by cmake but let's 'make doc' rule available.
The documentation is generated in ./html dir from root source dir. Sound like using another destination dir do not work. We will see at next API doc generation done tonight
parent cde33f3f
......@@ -31,14 +31,14 @@ PROJECT_NAME = digiKam
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = @DIGIKAM_VERSION_STRING@
PROJECT_NUMBER =
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = @API_DIR@
OUTPUT_DIRECTORY =
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
......@@ -312,7 +312,7 @@ EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
EXTRACT_PRIVATE = YES
EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
......@@ -567,7 +567,7 @@ WARN_FORMAT = "$file:$line: $text"
# and error messages should be written. If left blank the output is written
# to stderr.
WARN_LOGFILE = @WARNFILE@
WARN_LOGFILE = doxygen-warn.log
#---------------------------------------------------------------------------
# configuration options related to the input files
......@@ -578,7 +578,7 @@ WARN_LOGFILE = @WARNFILE@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = @SOURCE_DIR@
INPUT =
# 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
......@@ -632,7 +632,7 @@ EXCLUDE_PATTERNS = */project/* */build/* */extra/* */tests/* */o2/* */upnp
# wildcard * is used, a substring. Examples: ANamespace, AClass,
# AClass::ANamespace, ANamespace::*Test
EXCLUDE_SYMBOLS = cimg_library, cimg, dlib, Platinum, Eigen, lapack, cv, Marble, KIO, mediawiki, clix, Ui, Vkontakte, std, Solid
EXCLUDE_SYMBOLS = cimg_library, cimg, dlib, Platinum, Eigen, lapack, cv, Marble, KIO, mediawiki, clix, Ui, Vkontakte, std, Solid, boost, KSaneIface
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
......@@ -658,7 +658,7 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
IMAGE_PATH = @IMAGES_DIR@
IMAGE_PATH = ./core/data/pics/digikam/
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
......@@ -1002,12 +1002,12 @@ GENERATE_LATEX = NO
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
# put in front of it. If left blank `latex' will be used as the default path.
LATEX_OUTPUT = latex
LATEX_OUTPUT =
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked. If left blank `latex' will be used as the default command name.
LATEX_CMD_NAME = latex
LATEX_CMD_NAME =
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
# generate index for LaTeX. If left blank `makeindex' will be used as the
......@@ -1065,7 +1065,9 @@ LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER.
# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code
# with syntax highlighting in the LaTeX output. Note that which sources are
# shown also depends on other settings such as SOURCE_BROWSER.
LATEX_SOURCE_CODE = NO
......@@ -1365,7 +1367,7 @@ HIDE_UNDOC_RELATIONS = YES
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = @API_USE_DOT@
HAVE_DOT = YES
# By default doxygen will write a font called FreeSans.ttf to the output
# directory and reference it in all dot files that doxygen generates. This
......
......@@ -643,22 +643,16 @@ endif()
if(Doxygen_FOUND)
message(STATUS " ==> Doxygen is found: ${DOXYGEN_FOUND}")
message(STATUS " ==> Doxygen is found: ${Doxygen_FOUND}")
message(STATUS " ==> Graphviz Dot is found: ${DOXYGEN_DOT_FOUND}")
set(API_DIR ${CMAKE_BINARY_DIR}/api)
set(SOURCE_DIR ${CMAKE_SOURCE_DIR}/) # on root of source dir else export to doc web site will not be named as "digiKam"
set(DOXYFILE ${CMAKE_BINARY_DIR}/Doxyfile)
set(WARNFILE ${CMAKE_BINARY_DIR}/doxygen-warn.log)
set(IMAGES_DIR "${CMAKE_CURRENT_SOURCE_DIR}/data/pics/digikam")
if(Doxygen_FOUND AND DOXYGEN_DOT_FOUND)
if(DOXYGEN_DOT_FOUND)
set(API_USE_DOT "YES")
endif()
message(STATUS " To build API documentation use 'make doc'")
add_custom_target(doc ${DOXYGEN_EXECUTABLE}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/templates/Doxyfile.cmake.in
${DOXYFILE})
endif()
add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${DOXYFILE}
WORKING_DIRECTORY ${CMAKE_BINARY_DIR})
endif()
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment