Commit: 2d3400804ecb021e6332a8097b987a4ac4cd25fd - shared_foo (git)

テスト用のあれこれ共用フォルダ

Commit MetaInfo

• Revision: 2d3400804ecb021e6332a8097b987a4ac4cd25fd (tree)
• Time: 2019-01-28 17:39:07
• Author: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Update doxygen comment : User's guide

Change Summary

• modified: stm32_development/murasaki/murasaki/murasaki_0_intro.hpp
• modified: stm32_development/murasaki/murasaki/murasaki_2_pg.hpp

Incremental Difference

--- a/stm32_development/murasaki/murasaki/murasaki_0_intro.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_0_intro.hpp
@@ -107,6 +107,9 @@
  * As a result, the wrong context, wrong parameter, etc will be reported to the debugger output.
  *
  * \section sec7_5 System Logging
+ * \ref MURASAKI_SYSLOG provides the message output based on the level and filtering.
+ * This mechanism is intended to help the Murasaki library development. But also application
+ * can use this mechanism.
  *
  * \section sec8 Configurable
  * Murasaki is configurable from the two point of view.
@@ -134,14 +137,17 @@
  * \details
  *
  * \li <a href="http://www.st.com/en/evaluation-tools/nucleo-f746zg.html">Nucleo F746ZG ( STM32F746ZG )</a>
- * \li <a href="http://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-configurators-and-code-generators/stm32cubemx.html">STM32CubeMX 4.22.1</a>
- * \li <a href="http://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-ides/sw4stm32.html">SW4STM32 1.15.0.201708311556 ( with eclipse 4.6.3 )</a>
+ * \li <a href="http://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-configurators-and-code-generators/stm32cubemx.html">STM32CubeMX 5.0</a>
+ * \li <a href="http://www.st.com/content/st_com/en/products/development-tools/software-development-tools/stm32-software-development-tools/stm32-ides/sw4stm32.html">SW4STM32 1.16.0.201807130628 ( with eclipse 4.6.3 )</a>
  * \li <a href="http://releases.ubuntu.com/16.04/">Ubuntu 16.04.03 (64bit)</a>
  *
  * And then, confirmed portability with following boards :
  * \li <a href="http://www.st.com/en/evaluation-tools/nucleo-f746zg.html">Nucleo F746ZG ( STM32F746ZG : Cortex-M7 )</a>
+ * \li <a href="http://www.st.com/en/evaluation-tools/nucleo-f722ze.html">Nucleo F722ZE ( STM32F722ZE : Cortex-M7 )</a>,
  * \li <a href="http://www.st.com/en/evaluation-tools/nucleo-f303k8.html">Nucleo F303K8 ( STM32F303K8 : Cortex-M4 )</a>
  * \li <a href="http://www.st.com/en/evaluation-tools/nucleo-l152re.html">Nucleo L152RE ( STM32L152RE : Cortex-M3 )</a>
+ * \li <a href="http://www.st.com/en/evaluation-tools/nucleo-f091rc.html">Nucleo F091RC ( STM32F091RC : Cortex-M0 )</a>
+ *
  */
 
 

--- a/stm32_development/murasaki/murasaki/murasaki_2_pg.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_2_pg.hpp
@@ -30,7 +30,8 @@
  *
  * There are some other manuals of murasaki class library :
  *
- * \li \ref murasaki_ug
+ * \li \ref murasaki_ug_preface
+ * \li \ref murasaki_ug_usage
  * \li \ref MURASAKI_GROUP
  *
  */
@@ -106,11 +107,10 @@
  * This file has variables / functions which user needs to program at porting time.
  * @li @ref murasaki::platform variable
  * @li @ref murasaki::debugger variable
- * @li \ref InitPlatform()
- * \li \ref ExecPlatform()
- * \li Interrupt routing functions
- * \li HAL assertion function
- * \li Custome default exception handler
+ * @li \ref InitPlatform() to initialize the platfrom variable
+ * \li \ref ExecPlatform() to execute the platform algorithm
+ * \li \link murasaki_pg_interrupt Interrupt routing functions \endlink
+ * \li \link murasaki_pg_error HAL assertion function and Custome default exception handler \endlink
  *
  * @section sec_ds_6 murasaki_platform.hpp
  * A header file of the @ref murasaki_platform.cpp