From ab61c03433423d1744db3550db8e1e281dbdf256 Mon Sep 17 00:00:00 2001
From: Albrecht Schlosser <albrechts.fltk@online.de>
Date: Wed, 10 Aug 2022 18:51:53 +0200
Subject: Improve automatic documentation generation

This removes the need to edit the copyright year before generating
  the documentation (every year, in several files) and adds some
  technical information (doxygen generation date, doxygen version,
  and FLTK Git revision) in both HTML and PDF docs.

- auto-generate copyright year (current year) used in several places
- include FLTK Git revision in HTML and PDF docs
- include generation date and doxygen version
- replace special html footer which didn't work well with default footer
---
 documentation/CMakeLists.txt | 68 +++++++++++++++++++++++++++++++++++++-------
 1 file changed, 57 insertions(+), 11 deletions(-)

(limited to 'documentation/CMakeLists.txt')

diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
index 41ed62961..1fe6d615e 100644
--- a/documentation/CMakeLists.txt
+++ b/documentation/CMakeLists.txt
@@ -1,7 +1,7 @@
 #
 # CMakeLists.txt to build docs for the FLTK project using CMake (www.cmake.org)
 #
-# Copyright 1998-2021 by Bill Spitzak and others.
+# Copyright 1998-2022 by Bill Spitzak and others.
 #
 # This library is free software. Distribution and use rights are outlined in
 # the file "COPYING" which should have been included with this file.  If this
@@ -15,6 +15,11 @@
 #
 
 set (DOCS)
+set (GENERATE_DOCS FALSE)
+
+if (OPTION_BUILD_HTML_DOCUMENTATION OR OPTION_BUILD_PDF_DOCUMENTATION)
+  set (GENERATE_DOCS TRUE)
+endif ()
 
 if (OPTION_INCLUDE_DRIVER_DOCUMENTATION)
   set (DRIVER_DOCS "DriverDev")
@@ -22,6 +27,57 @@ else ()
   set (DRIVER_DOCS "")
 endif ()
 
+#------------------------------------------------
+# generate files used for both HTML and PDF docs
+#------------------------------------------------
+
+if (GENERATE_DOCS)
+
+  # create required variables
+
+  execute_process (COMMAND date "+%Y"
+    OUTPUT_VARIABLE YEAR
+  )
+
+  # note: current locale is used for abbreviated month
+  execute_process (COMMAND date "+%b %d, %Y"
+    OUTPUT_VARIABLE CURRENT_DATE
+  )
+
+  execute_process (COMMAND git rev-parse --short=10 HEAD
+    OUTPUT_VARIABLE GIT_REVISION
+  )
+
+  # strip trailing newline
+  string (REPLACE "\n" "" GIT_REVISION ${GIT_REVISION})
+
+  execute_process (COMMAND doxygen --version
+    OUTPUT_VARIABLE DOXYGEN_VERSION_SHORT
+  )
+
+  # strip trailing git revision if doxygen was built from source
+  string (REGEX REPLACE " .*$" "" DOXYGEN_VERSION_SHORT ${DOXYGEN_VERSION_SHORT})
+
+  ## fl_debug_var (GIT_REVISION)
+  ## fl_debug_var (DOXYGEN_EXECUTABLE)
+  ## fl_debug_var (DOXYGEN_VERSION_SHORT)
+
+  # configure copyright.dox (includes current year)
+  configure_file (
+    ${CMAKE_CURRENT_SOURCE_DIR}/copyright.dox.in
+    ${CMAKE_CURRENT_BINARY_DIR}/copyright.dox
+    @ONLY
+  )
+
+  # configure generated.dox (includes date and versions)
+  configure_file (
+    ${CMAKE_CURRENT_SOURCE_DIR}/generated.dox.in
+    ${CMAKE_CURRENT_BINARY_DIR}/generated.dox
+    @ONLY
+  )
+
+endif (GENERATE_DOCS)
+
 #--------------------------
 # build html documentation
 #--------------------------
@@ -36,12 +92,6 @@ if (OPTION_BUILD_HTML_DOCUMENTATION)
   set (GENERATE_LATEX NO)
   set (LATEX_HEADER   "")
 
-  configure_file (
-    ${CMAKE_CURRENT_SOURCE_DIR}/src/tiny.png
-    ${CMAKE_CURRENT_BINARY_DIR}/html/tiny.png
-    COPYONLY
-  )
-
   # configure Doxygen input file for HTML docs (Doxyfile.in)
 
   configure_file (
@@ -87,10 +137,6 @@ if (OPTION_BUILD_PDF_DOCUMENTATION)
   # strip potential " (Git-hash)" from the original version
   string (REGEX REPLACE " .*$" "" DOXY_VERSION ${DOXYGEN_VERSION})
 
-  execute_process (COMMAND date +%Y
-    OUTPUT_VARIABLE YEAR
-  )
-
   # configure Doxygen input file for PDF docs (Doxybook.in)
 
   configure_file (
-- 
cgit v1.2.3