Build Doxygen von CMake Skript

Question

Ich fand im Web eine Beispiel-cmake-Datei und legte es in das /doc Unterverzeichnis meines Projekts, wo sich auch die Datei myproject.doxgen befindet, die Doxygen-Konfiguration enthält.

Ich habe getestet, dass doxygen.exe myproject.doxygen eine gültige Ausgabe erzeugt. Ich muss das nur in den CMake-Prozess einbauen. So /doc/CMakeLists.txt ist:

find_package(Doxygen) 
option(BUILD_DOCUMENTATION "Create and install the HTML based API   
documentation (requires Doxygen)" ${DOXYGEN_FOUND}) 

if(BUILD_DOCUMENTATION) 
    if(NOT DOXYGEN_FOUND) 
     message(FATAL_ERROR "Doxygen is needed to build the documentation.") 
    endif() 

    set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/../doc/myproject.doxygen) 
    set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/doxyfile) 

    configure_file(${doxyfile_in} ${doxyfile} @ONLY) 

    message("Doxygen build started.") 

    add_custom_target(doc 
         COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile_in} 
         WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc 
         COMMENT "Generating API documentation with Doxygen" 
         VERBATIM) 

    # install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION  share/doc) 
endif() 

Es ist nicht für mich arbeiten, kopieren Sie nur die Original-Konfigurationsdatei in /build/my/project/doc/ und tut nichts mehr.

Was ich möchte, ist die Doxygen-Dokumentation während meiner Builds zu generieren; idealerweise nur beim Erstellen der Release-Konfiguration.

Answer 1

Die Art und Weise, wie die CMake-Datei, die Sie angezeigt haben, eingerichtet ist, erstellt ein Ziel namens doc; Durch das Erstellen dieses Ziels (z. B. Ausführen von make doc) wird die Doximierung generiert. Das Ziel ist nicht Teil von make all (oder gleichwertig); es so zu machen, ALL in die individuellen Ziel Schöpfung hinzufügen:

add_custom_target(
    doc ALL 
    COMMAND #... everything else as before 
) 

Wenn Sie dieses Ziel begrenzen wollen nur in einer bestimmten Konfiguration zu bauen (wie Sie in den Kommentaren erwähnt haben), können Sie generator expressions verwenden:

Es kann passieren, dass einige CMake Generatoren nicht gut mit einem leeren COMMAND zurechtkommen. In diesem Sinne sollte die folgenden ausfallsicher sein:

add_custom_target(
    doc ALL 
    COMMAND 
    $<$<CONFIG:Release>:${DOXYGEN_EXECUTABLE} ${doxyfile_in}> 
    $<$<NOT:$<CONFIG:Release>>:${CMAKE_COMMAND} -E echo "Only done in Release builds"> 
    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc 
    COMMENT "Generating API documentation with Doxygen" 
    VERBATIM 
)