dir.dox 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. /*##########################################################################*/
  2. /*! @dir include
  3. @brief Platform-independent QP™/C API
  4. @attention
  5. The QP&trade;/C <span class="img folder">include</span> directory needs to be added to the compiler's include path in the applications using QP&trade;/C.
  6. */
  7. /*##########################################################################*/
  8. /*! @dir src
  9. @brief Platform-independent QP&trade;/C source code
  10. Files from this directory need to be added to the project, to build the QP&trade;/C framework from source code.
  11. @attention
  12. The QP&trade;/C <span class="img folder">src</span> directory needs to be added to the compiler's include path in the applications that build QP&trade;/C framework from sources (as opposed to using QP as a pre-built library).
  13. */
  14. /*##########################################################################*/
  15. /*! @dir src/qf
  16. @brief Platform-independent implementation of the QEP and QF components.
  17. @note
  18. Typically, files in this directory need to be added to the application build, but some QP ports might not need all the files in this directory. For example, a QP port to a 3rd-party RTOS kernel might be using a message queue of the RTOS instead of the native QP event queue, in which case the file qf_actq.c would not be needed and should be excluded from the build.
  19. */
  20. /*##########################################################################*/
  21. /*! @dir src/qv
  22. @brief Platform-independent implementation of the @ref srs_qv built-in kernel.
  23. @attention
  24. Files in this directory need to be included in the QP application build only if the application uses the @ref srs_qv kernel.
  25. */
  26. /*##########################################################################*/
  27. /*! @dir src/qk
  28. @brief Platform-independent implementation of the @ref srs_qk built-in kernel.
  29. @attention
  30. Files in this directory need to be included in the QP application build only if the application uses the @ref srs_qk kernel.
  31. */
  32. /*##########################################################################*/
  33. /*! @dir src/qxk
  34. @brief Platform-independent implementation of the @ref srs_qxk built-in kernel.
  35. @attention
  36. Files in this directory need to be included in the QP application build only if the application uses the @ref srs_qxk kernel.
  37. */
  38. /*##########################################################################*/
  39. /*! @dir src/qs
  40. @brief Platform-independent implementation of the QS component (software tracing).
  41. */