From 6c59014b467e315e69eccf8ee5aabb0695f990fa Mon Sep 17 00:00:00 2001 From: Boris Pek Date: Thu, 11 Oct 2018 02:33:51 +0300 Subject: Fix generating of Doxygen documentation Closes: #158 --- doc/CMakeLists.txt | 16 +++++++++------- doc/Doxyfile.in | 10 ++++++---- doc/index.doc | 6 +++--- 3 files changed, 18 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 2fb54f3c..a27a28ce 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,19 +1,21 @@ find_package(Doxygen REQUIRED) -set(DOXYGEN_INPUT - ${CMAKE_CURRENT_SOURCE_DIR}/index.doc - ${CMAKE_CURRENT_SOURCE_DIR}/using.doc - ${CMAKE_CURRENT_SOURCE_DIR}/xep.doc - ${PROJECT_SOURCE_DIR}/src -) +if(NOT DOXYGEN_FOUND) + message(FATAL_ERROR "Doxygen is needed to build the documentation.") +endif() -configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) +configure_file( + ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in + ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile + @ONLY +) add_custom_target( doc ALL COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} COMMENT "Generate API documentation with Doxygen" + VERBATIM ) install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION ${CMAKE_INSTALL_DOCDIR}) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 162406b5..97a4e1de 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -1,6 +1,9 @@ -PROJECT_NAME = "@CMAKE_PROJECT_NAME@" -PROJECT_NUMBER = @VERSION_STRING@ -INPUT = @DOXYGEN_INPUT@ +PROJECT_NAME = "QXmpp" +PROJECT_NUMBER = Version:@VERSION_STRING@ +INPUT = @PROJECT_SOURCE_DIR@/doc/index.doc \ + @PROJECT_SOURCE_DIR@/doc/using.doc \ + @PROJECT_SOURCE_DIR@/doc/xep.doc \ + @PROJECT_SOURCE_DIR@/src ALPHABETICAL_INDEX = NO EXCLUDE_PATTERNS = */moc_* */mod_* */*_p.h */QXmppCodec.cpp */QXmppSasl.cpp @@ -10,4 +13,3 @@ GENERATE_LATEX = NO HTML_TIMESTAMP = NO QUIET = YES RECURSIVE = YES - diff --git a/doc/index.doc b/doc/index.doc index 1652fe18..75af5e7a 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -31,8 +31,8 @@ classes. Project Details: -- Project Page: https://github.com/qxmpp-project/qxmpp/ -- Report Issues: https://github.com/qxmpp-project/qxmpp/issues/ -- New Releases: https://github.com/qxmpp-project/qxmpp/downloads/ +- Project Page: https://github.com/qxmpp-project/qxmpp +- Report Issues: https://github.com/qxmpp-project/qxmpp/issues +- New Releases: https://github.com/qxmpp-project/qxmpp/releases */ -- cgit v1.2.3