From d950d6af5271cd6733db9d47297d6b32de9c23a7 Mon Sep 17 00:00:00 2001 From: Aris Adamantiadis Date: Wed, 16 Dec 2009 23:19:18 +0100 Subject: [PATCH] Optional compilation of developper's doc --- DefineOptions.cmake | 1 + cmake/Modules/UseDoxygen.cmake | 7 +++++++ doc/doxy.config.in | 2 +- 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/DefineOptions.cmake b/DefineOptions.cmake index fe9d405a..21e562ed 100644 --- a/DefineOptions.cmake +++ b/DefineOptions.cmake @@ -7,3 +7,4 @@ option(WITH_DEBUG_CRYPTO "Build with cryto debug output" OFF) option(WITH_DEBUG_CALLTRACE "Build with calltrace debug output" ON) option(WITH_GCRYPT "Compile against libgcrypt" OFF) option(WITH_PCAP "Compile with Pcap generation support" ON) +option(WITH_INTERNAL_DOC "Compile doxygen internal documentation" OFF) diff --git a/cmake/Modules/UseDoxygen.cmake b/cmake/Modules/UseDoxygen.cmake index 3eb94906..541daced 100644 --- a/cmake/Modules/UseDoxygen.cmake +++ b/cmake/Modules/UseDoxygen.cmake @@ -30,6 +30,13 @@ IF (DOXYGEN_FOUND) SET(DOXY_WARN_FORMAT "\"$file:$line: $text \"") ENDIF (CMAKE_BUILD_TOOL MATCHES "(msdev|devenv)") + #Build the documentation for libssh developpers if asked + IF (WITH_INTERNAL_DOC) + SET(CMAKE_INTERNAL_DOC "Yes") + ELSE (WITH_INTERNAL_DOC) + SET(CMAKE_INTERNAL_DOC "No") + ENDIF (WITH_INTERNAL_DOC) + # we need latex for doxygen because of the formulas FIND_PACKAGE(LATEX) IF (NOT LATEX_COMPILER) diff --git a/doc/doxy.config.in b/doc/doxy.config.in index 768b5c44..03abd8be 100644 --- a/doc/doxy.config.in +++ b/doc/doxy.config.in @@ -374,7 +374,7 @@ HIDE_IN_BODY_DOCS = NO # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. -INTERNAL_DOCS = NO +INTERNAL_DOCS = @CMAKE_INTERNAL_DOC@ # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also