Corporatura doxygen da CMake sceneggiatura

Question

ho trovato sul file CMake campione Web e metterlo nel /doc sottodirectory del mio progetto, dove si trova anche il file myproject.doxgen, che contiene la configurazione Doxygen.

Ho verificato che l'esecuzione di doxygen.exe myproject.doxygen produce un output valido. Ho solo bisogno di creare questo nel processo CMake. Così /doc/CMakeLists.txt è:

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() 

Non funziona per me, è solo copia il file di configurazione originale in /build/my/project/doc/ e non fa nulla di più.

Quello che voglio è generare la documentazione doxygen durante le mie build; idealmente, solo quando si crea la configurazione Release.

Answer 1

Il modo in cui il file CMake che hai mostrato è impostato, crea un target chiamato doc; la creazione di quella destinazione (come l'esecuzione di make doc) genera la doxymentation. L'obiettivo non fa parte di make all (o equivalente); per renderlo tale, aggiungere ALL nella creazione di destinazione personalizzato:

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

Se si desidera limitare questo obiettivo di costruire solo in una particolare configurazione (come avete accennato nei commenti), è possibile utilizzare generator expressions:

Potrebbe accadere che alcuni generatori CMake non gestiscano correttamente uno COMMAND vuoto. Con questo in mente, il seguente dovrebbe essere fail-safe: il file

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 
)