2.3.0

updated for Doxygen 1.14

Author: quantum-leaps

Spexyfile

@@ -1,6 +1,6 @@
 #=============================================================================
 # _Spexygen_ - Traceable Specifications Based on doxygen
-# Copyright (C) 2024 Quantum Leaps, LLC <www.state-machine.com>
+# Copyright (C) 2025 Quantum Leaps, LLC <www.state-machine.com>
 #
 # SPDX-License-Identifier: MIT
 #
@@ -26,6 +26,8 @@
 # <[email protected]>
 #=============================================================================
 
+# Doxyfile 1.14.0
+
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
@@ -68,9 +70,9 @@ HTML_EXTRA_STYLESHEET  = $(SPEXYGEN)/spexygen-awesome/doxygen-awesome.css \
                          $(SPEXYGEN)/spexygen-awesome/doxygen-awesome-sidebar-only.css \
                          $(SPEXYGEN)/spexygen-awesome/doxygen-awesome-sidebar-only-darkmode-toggle.css \
                          $(SPEXYGEN)/spexygen-awesome/spexy-awesome.css
+
 HTML_EXTRA_FILES       = $(SPEXYGEN)/spexygen-awesome/doxygen-awesome-darkmode-toggle.js \
-                         $(SPEXYGEN)/spexygen-awesome/doxygen-awesome-fragment-copy-button.js \
-                         $(SPEXYGEN)/spexygen-awesome/doxygen-awesome-paragraph-link.js \
+                         $(SPEXYGEN)/spexygen-awesome/spexy-awesome.js \
                          $(SPEXYGEN)/spexygen-awesome/image-preview.js
 
 #---------------------------------------------------------------------------

doc/DOC_MAN_SPX.pdf

@@ -1,17 +1,23 @@
+# Doxyfile 1.14.0
+
 @INCLUDE = $(SPEXYGEN)/Spexyfile
 
 #---------------------------------------------------------------------------
 # Project related configuration options
 #---------------------------------------------------------------------------
+DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = Spexygen
-PROJECT_NUMBER         = 2.2.5
+PROJECT_NUMBER         = 2.3.0
 PROJECT_BRIEF          = "Reference Manual"
 PROJECT_LOGO           = $(SPEXYGEN)/spexygen-awesome/img/logo_spexygen.webp
 PROJECT_ICON           =
 
 FULL_PATH_NAMES        = NO
 EXTENSION_MAPPING      =
 TYPEDEF_HIDES_STRUCT   = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
 EXTRACT_ALL            = YES
 EXTRACT_PRIVATE        = YES
 EXTRACT_PRIV_VIRTUAL   = YES
@@ -24,10 +30,25 @@ EXTRACT_STATIC         = YES
 EXTRACT_LOCAL_CLASSES  = YES
 EXTRACT_LOCAL_METHODS  = YES
 EXTRACT_ANON_NSPACES   = NO
-FORCE_LOCAL_INCLUDES   = YES
+FORCE_LOCAL_INCLUDES   = NO
 INLINE_INFO            = YES
 SORT_MEMBER_DOCS       = NO
 #---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = YES
+WARN_IF_DOC_ERROR      = YES
+WARN_IF_INCOMPLETE_DOC = YES
+WARN_NO_PARAMDOC       = NO
+WARN_IF_UNDOC_ENUM_VAL = NO
+WARN_LAYOUT_FILE       = YES
+WARN_AS_ERROR          = NO
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LINE_FORMAT       = "at line $line of file $file"
+WARN_LOGFILE           =
+#---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
 # NOTE:
@@ -43,48 +64,68 @@ INPUT = \
 
 @INCLUDE = spex/Spexyinc
 
+INPUT_ENCODING         = UTF-8
+INPUT_FILE_ENCODING    =
 ENABLED_SECTIONS       = IN_SPEXYGEN
 OPTIMIZE_OUTPUT_FOR_C  = YES
+FILE_PATTERNS          = *.dox \
+                         *.c \
+                         *.h
 
-RECURSIVE              = NO
+RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
 EXCLUDE_SYMBOLS        =
 EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = ./img \
-                         $(SPEXYGEN)/spexygen-awesome/img
+IMAGE_PATH             = $(SPEXYGEN)/spexygen-awesome/img \
+                         ./img
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
 #---------------------------------------------------------------------------
 SOURCE_BROWSER         = YES
 INLINE_SOURCES         = NO
 STRIP_CODE_COMMENTS    = NO
+REFERENCED_BY_RELATION = NO
+REFERENCES_RELATION    = NO
+REFERENCES_LINK_SOURCE = YES
+SOURCE_TOOLTIPS        = YES
+USE_HTAGS              = NO
+VERBATIM_HEADERS       = YES
+CLANG_ASSISTED_PARSING = NO
+CLANG_ADD_INC_PATHS    = YES
+CLANG_OPTIONS          =
+CLANG_DATABASE_PATH    =
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = YES
+IGNORE_PREFIX          =
 #---------------------------------------------------------------------------
 # Configuration options related to the HTML output
 #---------------------------------------------------------------------------
 GENERATE_HTML          = YES
-HTML_OUTPUT            = ./html
+HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
 HTML_HEADER            = $(SPEXYGEN)/spexygen-awesome/spexy-header.html
 HTML_FOOTER            = $(SPEXYGEN)/spexygen-awesome/spexy-footer.html
 HTML_STYLESHEET        =
 #Spexygen HTML_EXTRA_STYLESHEET  =
 #Spexygen HTML_EXTRA_FILES       =
-HTML_COLORSTYLE        = DARK
-HTML_COLORSTYLE_HUE    = 209
-HTML_COLORSTYLE_SAT    = 255
-HTML_COLORSTYLE_GAMMA  = 113
+HTML_COLORSTYLE        = AUTO_LIGHT
+HTML_COLORSTYLE_HUE    = 220
+HTML_COLORSTYLE_SAT    = 100
+HTML_COLORSTYLE_GAMMA  = 80
 HTML_DYNAMIC_MENUS     = YES
 HTML_DYNAMIC_SECTIONS  = NO
 HTML_CODE_FOLDING      = YES
 HTML_COPY_CLIPBOARD    = YES
 HTML_PROJECT_COOKIE    =
 HTML_INDEX_NUM_ENTRIES = 100
 GENERATE_DOCSET        = NO
-DOCSET_FEEDNAME        =
+DOCSET_FEEDNAME        = "Spexygen generated docs"
 DOCSET_FEEDURL         =
 DOCSET_BUNDLE_ID       = com.state-machine.doc
 DOCSET_PUBLISHER_ID    = com.state-machine.doc
@@ -109,8 +150,10 @@ GENERATE_ECLIPSEHELP   = NO
 ECLIPSE_DOC_ID         = com.state-machine.qp
 DISABLE_INDEX          = NO
 GENERATE_TREEVIEW      = YES
+PAGE_OUTLINE_PANEL     = YES
 FULL_SIDEBAR           = NO
 ENUM_VALUES_PER_LINE   = 4
+SHOW_ENUM_VALUES       = NO
 TREEVIEW_WIDTH         = 335
 EXT_LINKS_IN_WINDOW    = NO
 OBFUSCATE_EMAILS       = NO
@@ -134,15 +177,23 @@ EXTRA_SEARCH_MAPPINGS  =
 # Configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
 GENERATE_LATEX         = NO
-LATEX_OUTPUT           = ./latex
+LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
-LATEX_HEADER           = $(SPEXYGEN)/spexygen-awesome/spexy-header.tex
-LATEX_FOOTER           = $(SPEXYGEN)/spexygen-awesome/spexy-footer.tex
 MAKEINDEX_CMD_NAME     = makeindex
 LATEX_MAKEINDEX_CMD    = makeindex
 COMPACT_LATEX          = NO
 PAPER_TYPE             = letter
 EXTRA_PACKAGES         =
+LATEX_HEADER           = $(SPEXYGEN)/spexygen-awesome/spexy-header.tex
+LATEX_FOOTER           = $(SPEXYGEN)/spexygen-awesome/spexy-footer.tex
+LATEX_EXTRA_STYLESHEET =
+LATEX_EXTRA_FILES      =
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+LATEX_BIB_STYLE        = plainnat
+LATEX_EMOJI_DIRECTORY  =
 #---------------------------------------------------------------------------
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
@@ -154,7 +205,7 @@ INCLUDE_PATH           =
 INCLUDE_FILE_PATTERNS  =
 PREDEFINED             =
 EXPAND_AS_DEFINED      =
-SKIP_FUNCTION_MACROS   = NO
+SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------
 # Configuration options related to external references
 #---------------------------------------------------------------------------

doc/Doxyfile

@@ -4,7 +4,7 @@
 # Configuration options related to the LateX output
 #---------------------------------------------------------------------------
 PROJECT_NAME           = Reference Manual
-PROJECT_BRIEF          = For Spexygen 2.2.5
+PROJECT_BRIEF          = For Spexygen 2.3.0
 PROJECT_NUMBER         = Document: DOC_MAN_SPX
 
 #---------------------------------------------------------------------------

doc/Doxyfile-PDF

@@ -48,18 +48,17 @@ python %SPEXYGEN%/spexygen.py spex.json
 ::============================================================================
 @if "%1"=="-PDF" goto PDF
 
+@echo.
 @echo Generate HTML Documentation --------------------------------------------
 @set HTML_OUT=html
 
-@echo.
 @echo cleanup
 rmdir /S /Q %HTML_OUT%
 
 @echo generating HTML...
-%DOXYGEN% Doxyfile
+call %DOXYGEN% Doxyfile
 
 @echo Adding custom files...
-copy %SPEXYGEN%\spexygen-awesome\jquery.js %HTML_OUT%
 @copy DOC_MAN_SPX.pdf %HTML_OUT%
 
 ::qclean %HTML_OUT%
@@ -74,7 +73,7 @@ goto END
 rmdir /S /Q  %LATEX_OUT%
 
 @echo generating LATEX...
-%DOXYGEN% Doxyfile-PDF
+call %DOXYGEN% Doxyfile-PDF
 
 :: Generate LaTex/PDF Documentation...
 @echo generating PDF...