7.1.3

Replaced QF_EVT_REF_CTR_INC_() with QEvt_refCtr_inc_() in ports
- embOS
- ESP-IDF
- Qt

Author: quantum-leaps

doxygen/Doxyfile

@@ -131,6 +131,7 @@ INPUT                  = main.dox \
                          ../../cert-pack/sds_sm-c.dox \
                          ../../cert-pack/misra.dox \
                          ../../cert-pack/metrics.dox \
+                         history.dox \
                          exa.dox \
                          exa_native.dox \
                          exa_rtos.dox \
@@ -143,7 +144,6 @@ INPUT                  = main.dox \
                          ports_rtos.dox \
                          ports_os.dox \
                          api.dox \
-                         history.dox \
                          ../../ql-doxygen/help.dox \
                          dir.dox \
                          config.h \

doxygen/Doxyfile-LATEX

@@ -2,7 +2,39 @@
 
 @INCLUDE = Doxyfile
 
-GENERATE_HTML          = NO
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = main.dox \
+                         gs.dox \
+                         ../../cert-pack/cert-pack.dox \
+                         ../../cert-pack/srs.dox \
+                         ../../cert-pack/sas.dox \
+                         ../../cert-pack/sds.dox \
+                         ../../cert-pack/sds_sm-c.dox \
+                         ../../cert-pack/misra.dox \
+                         ../../cert-pack/metrics.dox \
+                         history.dox \
+                         exa.dox \
+                         exa_native.dox \
+                         exa_rtos.dox \
+                         exa_os.dox \
+                         exa_qutest.dox \
+                         exa_mware.dox \
+                         ports.dox \
+                         ports_native.dox \
+                         ports_arm-cm.dox \
+                         ports_rtos.dox \
+                         ports_os.dox \
+                         api.dox \
+                         dir.dox \
+                         config.h \
+                         ../include \
+                         ../src \
+                         ../ports/lint-plus/std.lnt \
+                         ../ports/lint-plus/qpc.lnt \
+                         ../ports/lint-plus/options.lnt
+
 GENERATE_LATEX         = YES
 ENABLED_SECTIONS      += LATEX
 

doxygen/api.dox

@@ -1,5 +1,7 @@
 /*! @page api API Reference
+@ifnot LATEX
 @nav_next{deprecated}
+@endif
 
 @section api_qep QEP (Hierarchical State Machines)
 QEP is a universal, UML-compliant event processor that enables developers to code UML state machines in highly readable ANSI-C, in which every state machine element is mapped to code precisely, unambiguously, and exactly once (traceability). QEP fully supports hierarchical state nesting, which is the fundamental mechanism for reusing behavior across many states instead of repeating the same actions and transitions over and over again.
@@ -230,8 +232,9 @@ QXK is a small, preemptive, priority-based, dual-mode (run-to-completion/**block
 - QMPool_get()
 - QMPool_put()
 
-<br>
+@ifnot LATEX
 @nav_next{deprecated}
+@endif
 */
 ##############################################################################
 /*! @page deprecated Deprecated APIs

doxygen/exa.dox

@@ -171,7 +171,9 @@ To work with QP/C effectively, you need to learn a bit more about active objects
 4. QP Application Notes (https://www.state-machine.com/an/ )
 5. "State Space" Blog (https://www.state-machine.com/category/blog/ )
 
-@next{exa_ref}
+@ifnot LATEX
+@nav_next{exa_ref}
+@endif
 */
 
 /*##########################################################################*/
@@ -278,8 +280,10 @@ You can hover the mouse cursor over the <span class="board"></span>&nbsp;&nbsp;
 
 @subsection exa_ref_arm-cm ARM Cortex-M Boards
 
-@image{anchor:EK-TM4C123GXL} html  bd_EK-TM4C123GXL.jpg "EK-TM4C123GXL (TivaC LaunchPad)"
-@image{anchor:EK-TM4C123GXL} latex bd_EK-TM4C123GXL.jpg "EK-TM4C123GXL (TivaC LaunchPad)" width=2.75in
+@anchor EK-TM4C123GXL
+@image html  bd_EK-TM4C123GXL.jpg
+@image latex bd_EK-TM4C123GXL.jpg width=2.5in
+@caption{EK-TM4C123GXL (TivaC LaunchPad)}
 
 - @ref arm-cm_blinky_ek-tm4c123gxl (QV, QK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref arm-cm_dpp_ek-tm4c123gxl (QV, QK, QXK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
@@ -289,80 +293,82 @@ You can hover the mouse cursor over the <span class="board"></span>&nbsp;&nbsp;
 - @ref uc-os2_dpp_ek-tm4c123gxl  (uC/OS-II kernel; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 
 
-
-@image{anchor:EFM32-SLSTK3401A} html  bd_EFM32-SLSTK3401A.jpg "EFM32-SLSTK3401A"
-@image{anchor:EFM32-SLSTK3401A} latex bd_EFM32-SLSTK3401A.jpg "EFM32-SLSTK3401A" width=4.75in
+@anchor EFM32-SLSTK3401A
+@image html  bd_EFM32-SLSTK3401A.jpg
+@image latex bd_EFM32-SLSTK3401A.jpg width=4.5in
+@caption{EFM32-SLSTK3401A (Pearl-Gecko)}
 
 - @ref arm-cm_blinky_efm32-slstk3401a (QV, QK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref arm-cm_dpp_efm32-slstk3401a (QV, QK, QXK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref arm-cm_game_efm32-slstk3401a (QV, QK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains; <a href="https://www.state-machine.com/qtools/qwin.html"><b>QWin-GUI emulation</b></a>)
 
 
 @anchor mbed-LPC1768
-
-@image html  bd_mbed-LPC1768.jpg "mbed-LPC1768"
-@image latex bd_mbed-LPC1768.jpg "mbed-LPC1768" width=2.75in
+@image html  bd_mbed-LPC1768.jpg
+@image latex bd_mbed-LPC1768.jpg width=2.5in
+@caption{mbed-LPC1768}
 - @ref arm-cm_dpp_mbed-lpc1768 (QV, QK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 
 @anchor NUCLEO-L053R8
-
-@image html  bd_NUCLEO-L053R8.jpg "NUCLEO-L053R8"
-@image latex bd_NUCLEO-L053R8.jpg "NUCLEO-L053R8" width=3.10in
+@image html  bd_NUCLEO-L053R8.jpg
+@image latex bd_NUCLEO-L053R8.jpg width=2.5in
+@caption{NUCLEO-L053R8}
 - @ref arm-cm_dpp_nucleo-l053r8 (QV, QK, QXK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 
 @anchor NUCLEO-L152RE
-
-@image html  bd_NUCLEO-L152RE.jpg "NUCLEO-L152RE"
-@image latex bd_NUCLEO-L152RE.jpg "NUCLEO-L152RE" width=3in
+@image html  bd_NUCLEO-L152RE.jpg
+@image latex bd_NUCLEO-L152RE.jpg width=2.4in
+@caption{NUCLEO-L152RE}
 - @ref arm-cm_dpp_nucleo-l152re (QV, QK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref uc-os2_dpp_nucleo-l053r8 (uC/OS-II kernel; ARM-KEIL, IAR-EWARM toolchains)
 
-@anchor exa_EK-LM3S6965
-
-@image html  bd_EK-LM3S6965.jpg "EK-LM3S6965"
-@image latex bd_EK-LM3S6965.jpg "EK-LM3S6965" width=3in
+@anchor EK-LM3S6965
+@image html  bd_EK-LM3S6965.jpg
+@image latex bd_EK-LM3S6965.jpg width=2.0in
+@caption{EK-LM3S6965}
 - @ref lwip_ek-lm3s6965 (**LwIP TCP/IP**; QV, QK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 
-
 @anchor NUCLEO-H743ZI
-
-@image html  bd_NUCLEO-H743ZI.jpg "NUCLEO-H743ZI"
-@image latex bd_NUCLEO-H743ZI.jpg "NUCLEO-H743ZI" width=4.75in
+@image html  bd_NUCLEO-H743ZI.jpg
+@image latex bd_NUCLEO-H743ZI.jpg width=4.5in
+@caption{NUCLEO-H743ZI}
 - @ref arm-cm_dpp_nucleo-h743zi (QV, QK, QXK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref freertos_dpp_nucleo-h743zi (FreeRTOS kernel; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 
 
 @anchor STM32F4-Discovery
-
-@image html  bd_STM32F4-Disco.jpg "STM32F4-Discovery"
-@image latex bd_STM32F4-Disco.jpg "STM32F4-Discovery" width=3.1in
+@image html  bd_STM32F4-Disco.jpg
+@image latex bd_STM32F4-Disco.jpg width=2.8in
+@caption{STM32F4-Discovery}
 - @ref arm-cm_dpp_stm32f4-discovery (QV, QK, QXK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref embos_dpp_stm32f429-discovery (embOS kernel; IAR-EWARM toolchain)
 - @ref threadx_dpp_stm32f429-discovery (ThreadX kernel; IAR-EWARM toolchain)
 
 
 @anchor STM32F746G-Discovery
-
-@image html  bd_STM32F746G-Disco.jpg "STM32F746G-Discovery"
-@image latex bd_STM32F746G-Disco.jpg "STM32F746G-Discovery" width=4.75in
+@image html  bd_STM32F746G-Disco.jpg
+@image latex bd_STM32F746G-Disco.jpg width=4.75in
+@caption{STM32F746G-Discovery}
 - @ref arm-cm_dpp_stm32f746g-disco (QV, QK, QXK kernels; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 - @ref freertos_dpp_stm32f746g-disco (FreeRTOS kernel; ARM-KEIL, GNU-ARM, IAR-EWARM toolchains)
 
 
 @subsection exa_ref_arm-cr ARM Cortex-R Boards:
-@anchor LAUNCHXL2-TMS57012
 
-@image html  bd_LAUNCHXL2-TMS57012.jpg "LAUNCHXL2-TMS57012"
-@image latex bd_LAUNCHXL2-TMS57012.jpg "LAUNCHXL2-TMS57012" width=4.75in
+@anchor LAUNCHXL2-TMS57012
+@image html  bd_LAUNCHXL2-TMS57012.jpg
+@image latex bd_LAUNCHXL2-TMS57012.jpg width=4.0in
+@caption{LAUNCHXL2-TMS57012}
 - @ref arm-cr_blinky_launchxl2-tms57012 (QV, QK kernels; CCS-TI-ARM, IAR-EWARM toolchains)
 - @ref arm-cr_dpp_launchxl2-tms57012 (QV, QK kernels; CCS-TI-ARM, IAR-EWARM toolchains)
 
 
 @subsection exa_ref_msp430 MSP430 Boards:
-@anchor MSP-EXP430F5529LP
 
-@image html  bd_MSP-EXP430F5529LP.jpg "MSP-EXP430F5529LP"
-@image latex bd_MSP-EXP430F5529LP.jpg "MSP-EXP430F5529LP" width=3.5in
+@anchor MSP-EXP430F5529LP
+@image html  bd_MSP-EXP430F5529LP.jpg
+@image latex bd_MSP-EXP430F5529LP.jpg width=3.5in
+@caption{MSP-EXP430F5529LP}
 - @ref msp430_blinky_msp-exp430f5529lp (QV, QK kernels; CCS=430, IAR-EW430 toolchains)
 - @ref msp430_dpp_msp-exp430f5529lp (QV, QK kernels; CCS=430, IAR-EW430 toolchains)
 
@@ -413,5 +419,7 @@ You can hover the mouse cursor over the <span class="board"></span>&nbsp;&nbsp;
     - @ref arm-cr_dpp_launchxl2-tms57012 <a class="preview board" href="bd_LAUNCHXL2-TMS57012.jpg" title="LAUNCHXL2-TMS57012"></a>
     - @ref lwip_ek-lm3s6965 <a class="preview board" href="bd_EK-LM3S6965.jpg" title="EK-LM3S6965"></a>
 
-@next{exa_native}
+@ifnot LATEX
+@nav_next{exa_native}
+@endif
 */

doxygen/exa_mware.dox

@@ -13,31 +13,37 @@
 /*##########################################################################*/
 /*! @page lwip_ek-lm3s6965 lwIP on EK-LM3S6965
 
-@image html bd_EK-LM3S6965.jpg EK-LM3S6965 board
+@image html  bd_EK-LM3S6965.jpg
+@image latex bd_EK-LM3S6965.jpg width=2.0in
+@caption{EK-LM3S6965}
 
 lwIP example for Texas Instruments EK-LM3S6965 (Cortex-M3) with GNU-ARM and IAR-ARM toolsets.
 
-@image html  bd_EK-LM3S6965_lwip.jpg "QP-lwIP on EK-LM3S6965"
-@image latex bd_EK-LM3S6965_lwip.jpg "QP-lwIP on EK-LM3S6965"
+@image html  bd_EK-LM3S6965_lwip.jpg
+@image latex bd_EK-LM3S6965_lwip.jpg width=2.0in
+@caption{QP-lwIP on EK-LM3S6965}
 <br>
 
 @section lwip_AN Application Note: QP and lwIP TCP/IP Stack
 The [Application Note](https://www.state-machine.com/doc/AN_QP_and_lwIP.pdf) describes how to use the lightweight TCP/IP stack called lwIP with the QP real-time embedded frameworks.
 
-@image html  AN-QL.png "Application Note: QP and lwIP TCP/IP"
-@image latex AN-QL.png "Application Note: QP and lwIP TCP/IP"
+@image html  AN-QL.png
+@image latex AN-QL.png width=2in
+@caption{Application Note: QP and lwIP TCP/IP}
 
-@next{ exa_emwin}
+@ifnot LATEX
+@nav_next{exa_emwin}
+@endif
 */
 
 /*##########################################################################*/
 /*! @page exa_emwin emWin Embedded GUI
 
 The <a href="https://www.state-machine.com/doc/AN_QP_emWin.pdf" target="_blank" class="extern"><strong>Application Note "QP and emWin Embedded GUI"</strong></a> describes how to use QP&trade; with the <a href="https://www.segger.com/emwin.html" target="_blank" class="extern">emWin&trade; Embedded GUI from SEGGER</a> and also <a href="https://www.micrium.com/rtos/gui/" target="_blank" class="extern">&micro;C/GUI from Micrium</a>, which technically are the same products.
 
-@image html  emWin_demo.jpg "QP-emWin demo (DPP) running on Windows"
-@image latex emWin_demo.jpg "QP-emWin demo (DPP) running on Windows"
-
+@image html  emWin_demo.jpg
+@image latex emWin_demo.jpg width=4.0in
+@caption{QP-emWin demo (DPP) running on Windows}
 
 To demonstrate the working examples, this Application Note uses the emWin Simulation on Windows, which is available for a <a href="https://www.segger.com/downloads/emwin" target="_blank" class="extern">free download from the SEGGER</a> (requires registration). You need only a Windows-based PC to execute the examples provided in this Application Note. Additionally, you'd need Microsoft Visual Studio 2013 (could be the free Express Edition) or higher to re-build and debug the provided examples.