2.2.1

added new diagnostics about missing bw-traces
restructured doc and example
updated README.md

Author: quantum-leaps

README.md

@@ -15,6 +15,12 @@ _Spexygen_ documentation (generated with _Spexygen_) is available at:
 - [Spexygen Reference Manual in HTML](https://www.state-machine.com/spexygen)
 - [Spexygen Reference Manual in PDF](https://www.state-machine.com/spexygen/DOC_MAN_SPX.pdf)
 
+<p align="center">
+<a href="https://youtu.be/5naC_z-76Aw?si=x4Svroqv9qDdkpsE" target="_blank" title="Spexygen video">
+<img src="https://www.state-machine.com/attachments/spexygen-video.jpg"><br>
+Traceable Documentation with Doxygen &amp; Spexygen</a>
+</p>
+
 # Licensing
 Spexygen is released under the terms of the permissive [MIT open source license](LICENSE).
 Please note that the attribution clause in the MIT license requires you to preserve

deploy.bat

@@ -33,6 +33,5 @@ twine upload dist/* --verbose
 @rm -rf build
 @rm -rf dist
 @rm -rf %PROJ%.egg-info
-@rm -rf %PROJ%-*
 
 @endlocal

doc/DOC_MAN_SPX.pdf

@@ -6,9 +6,9 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 PROJECT_NAME           = Spexygen
-PROJECT_NUMBER         = 2.2.0
+PROJECT_NUMBER         = 2.2.1
 PROJECT_BRIEF          = "Reference Manual"
-PROJECT_LOGO           = ./img/logo_spexygen.webp
+PROJECT_LOGO           = $(SPEXYGEN)/spexygen-awesome/img/logo_spexygen.webp
 PROJECT_ICON           =
 
 FULL_PATH_NAMES        = NO
@@ -40,22 +40,24 @@ SORT_MEMBER_DOCS       = NO
 #---------------------------------------------------------------------------
 INPUT = \
     main.dox \
-    ../spexygen-awesome/help.dox
+    ../example/main.dox \
+    $(SPEXYGEN)/spexygen-awesome/help.dox
 
 @INCLUDE = spex/Spexyinc
 
-ENABLED_SECTIONS       =
+ENABLED_SECTIONS       = IN_SPEXYGEN
 OPTIMIZE_OUTPUT_FOR_C  = YES
 
 RECURSIVE              = NO
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
 EXCLUDE_SYMBOLS        =
-EXAMPLE_PATH           = ../example
+EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = ./img
+IMAGE_PATH             = ./img \
+                         $(SPEXYGEN)/spexygen-awesome/img
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
 #---------------------------------------------------------------------------
@@ -68,8 +70,8 @@ STRIP_CODE_COMMENTS    = NO
 GENERATE_HTML          = YES
 HTML_OUTPUT            = ./html
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = ./spexy-header.html
-HTML_FOOTER            = ./spexy-footer.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       =
@@ -136,8 +138,8 @@ EXTRA_SEARCH_MAPPINGS  =
 GENERATE_LATEX         = NO
 LATEX_OUTPUT           = ./latex
 LATEX_CMD_NAME         = latex
-LATEX_HEADER           = ./spexy-header.tex
-LATEX_FOOTER           = ./spexy-footer.tex
+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

doc/Doxyfile

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

doc/Doxyfile-PDF

@@ -25,6 +25,16 @@
 - traceable @ref test1.c "tests"
 - traceable specifications of other kind
 
+@ifnot LATEX
+<a href="" target="_blank" title="Spexygen video">
+<img src="spexygen-video.jpg">
+</a>
+@else
+@image latex spexygen-video.jpg width=5in
+@webref{https://youtu.be/5naC_z-76Aw?si=x4Svroqv9qDdkpsE,Spexygen video}
+@endif
+<br>
+
 @note
 By extending Doxygen with a uniform __traceability management__ not just for source code, but also for all other specifications, _Spexygen_ supports regulatory compliance with functional safety standards such as IEC 61508, IEC 62304, ISO 26262 and others.
 
@@ -41,7 +51,7 @@ The main objectives and features of _Spexygen_ are:
 
 
 @section tr Traceability
-__Traceability__ is the cornerstone of any formal documentation system, especially those intended for managing __functional safety__. It enables product teams to associate every work artifact (e.g., a specific requirement) with all the related project artifacts (e.g., design, code, or tests), both backward and forward. Traceability enables everyone to see how every work artifact relates to the requirement &mdash; and vice versa &mdash; at any point during development. This ability fosters team collaboration and enables early detection of possible production risks.
+__Traceability__ is the cornerstone of any formal documentation system, especially those intended for managing __functional safety__. It enables product teams to associate every work artifact (e.g., a specific requirement) with all the related project artifacts (e.g., design, code, or tests), both backward and forward. Traceability lets everyone to see how every work artifact relates to the requirement &mdash; and vice versa &mdash; at any point during development. This ability fosters team collaboration and enables early detection of possible production risks.
 
 @attention
 _Spexygen_ provides consistent and __automated__ management of traceability within the whole documentation set.
@@ -171,7 +181,7 @@ relation between _Spexygen_ and Doxygen, and the flow of information between the
 
 `[8]` The `spexygen.py` Python script also generates the `Spexyinc` file that contains the information about all generated files.
 
-`[9]` Developers can prepare other documentation, not processed by _spexigen_, but also included in the final Doxygen-generated documentation.
+`[9]` Developers can prepare other documentation, not processed by _Spexygen_, but also included in the final Doxygen-generated documentation.
 
 `[10]` The Doxygen configuration file (`Doxyfile`) includes the `Spexyfile` (with the _Spexygen_ custom commands) and the generated `Spexyinc` file (with files generated by _Spexygen_ and to be processed by Doxygen)
 

doc/img/spexygen-video.jpg

@@ -2,9 +2,7 @@
     "gen-dir": "spex",
     "gen-inc": "Spexyinc",
     "gen": [
-        "../example/exa.dox",
         "../example/srs.dox",
-        "../example/dev.dox",
         "../example/inc",
         "../example/src",
         "../example/test"