diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile index 1991b010..e5214d7a 100644 --- a/doxygen/Doxyfile +++ b/doxygen/Doxyfile @@ -1,403 +1,403 @@ -# Doxyfile 1.9.1 - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "QP/C" -PROJECT_NUMBER = "6.9.4" -PROJECT_BRIEF = "Real-Time Embedded Framework" -PROJECT_LOGO = images/logo_ql.png -OUTPUT_DIRECTORY = -CREATE_SUBDIRS = NO -ALLOW_UNICODE_NAMES = NO -OUTPUT_LANGUAGE = English -OUTPUT_TEXT_DIRECTION = None -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = NO -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO -JAVADOC_BANNER = NO -QT_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = NO -PYTHON_DOCSTRING = YES -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 4 -ALIASES = "next{1}=
The Application Note "QP and emWin Embedded GUI" describes how to use QP™ with the emWin™ Embedded GUI from SEGGER and also uC/GUI from Micrium, which technically are the same products. +
The Application Note "QP and emWin Embedded GUI" describes how to use QP™ with the emWin™ Embedded GUI from SEGGER and also µC/GUI from Micrium, which technically are the same products.
@image html emWin_demo.jpg 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 free download from the SEGGER (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. +To demonstrate the working examples, this Application Note uses the emWin Simulation on Windows, which is available for a free download from the SEGGER (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. @note -Although the QP-emWin (µC/GUI) integration runs on Windows, the application-level code uses exclusively the embedded emWin™ API and is designed to run without any modifications on embedded targets. +Although the QP-emWin (µC/GUI) integration runs on Windows, the application-level code uses exclusively the embedded emWin™ API and is designed to run without any modifications on embedded targets. */ diff --git a/doxygen/history.dox b/doxygen/history.dox index db450363..7fe662bf 100644 --- a/doxygen/history.dox +++ b/doxygen/history.dox @@ -1,6 +1,16 @@ /** @page history Revision History + +@section qpc_6_9_4 Version 6.9.4, 2021-10-31 + +- removed unused `ARM_ARCH` symbol from Makefiles for GNU-ARM +- imoroved the Doxygen documentation for member functions of classes in C +- introudced new styling for the HTML documentation +- updated links in the documentation + + + @section qpc_6_9_3 Version 6.9.3, 2021-04-12 __Feature Requests:__ @@ -616,7 +626,7 @@ This release does not change any of the QP/C APIs. @section qpc_6_0_1 Version 6.0.1, 2017-11-10 The main focus of this release is to fix the remaining problems with transitions out of eXit-Points in sub-machines. Specifically, this release modifies the QMsm-based state machine implementation strategy (file src/qf/qep_msm.c to properly handle transitions from eXit-Points to Entry-Points and from eXit-Points to History connectors in sub-machines. These changes are part of fixing the following bugs reported for QM: -- [bug#190 "Exit-Point segment targeting History doesn't work](https://sourceforge.net/p/qpc/bugs/190/) +- [bug#190 "Exit-Point segment targeting History doesn't work"](https://sourceforge.net/p/qpc/bugs/190/) - [bug#189 "Exit-Point segment targeting an Entry-Point to sub-machine state doesn't work"](https://sourceforge.net/p/qpc/bugs/189/) diff --git a/doxygen/images/AN-QL.png b/doxygen/images/AN-QL.png new file mode 100644 index 00000000..1cbeddfc Binary files /dev/null and b/doxygen/images/AN-QL.png differ diff --git a/doxygen/main.dox b/doxygen/main.dox index 5099f386..8904de0c 100644 --- a/doxygen/main.dox +++ b/doxygen/main.dox @@ -29,10 +29,10 @@ The main goals of the QP/C™ framework are: - to provide efficient and thread-safe asynchronous mechanisms for active objects to communicate, such as direct event passing and publish-subscribe. - to provide event-driven timing services (time events). - to provide a selection of built-in real-time kernels to run the QP applications, such as the cooperative @ref qv "QV kernel", the preemptive non-blocking @ref qk "QK kernel", and the preemptive blocking @ref qxk "QXK kernel". +- to provide testing support for applications based on software tracing (@ref qs "Q-Spy"). - to provide **unit testing** support for applications based on software tracing (QUTest™). -- to provide portability layer and ready-to-use ports to @ref ports_rtos "3rd-party RTOSes" and desktop operating systems such as @ref posix "Linux" and @ref win32 "Windows". -- to provide a target for modeling and automatic code generation from the QM™ modeling tool. - +- to provide portability layer and ready-to-use ports to @ref ports_rtos "3rd-party RTOSes" and general purpose operating systems such as @ref posix "Linux" and @ref win32 "Windows". +- to provide a target for modeling and automatic code generation from the QM™ modeling tool. @section ab_special What's special about it? @@ -40,13 +40,13 @@ The main goals of the QP/C™ framework are: The QP/C™ Real-Time Embedded Framework (RTEF) is a unique offering on the embedded software market. It provides a modern, reusable **architecture** of embedded applications, which combines object-orientation with the particular model of concurrency, known as active objects (actors). This architecture is generally **safer**, more responsive and easier to understand than "free threading" with a traditional Real-Time Operating System (RTOS). It also provides sufficiently high level of abstraction and the right abstractions to effectively apply modeling and code generation to deeply embedded systems. - @subsection oop Object Orientation -Even though it is written in @ref misra "MISRA-compliant" ANSI-C, QP/C™ is fundamentally an **object-oriented** framework, which means that the framework itself and your applications derived from the framework are fundamentally composed of classes and only classes can have @ref sm "state machines" associated with them.