Commit: 275b579445324f4d5465d4909bff9ee62b8729c5 - shared_foo (git)

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

Commit MetaInfo

• Revision: 275b579445324f4d5465d4909bff9ee62b8729c5 (tree)
• Time: 2019-02-06 08:36:36
• Author: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Edit Doxygen comment

murasaki_platform.cpp is movied to hpp

Change Summary

• modified: stm32_experimental/murasaki_sample/murasaki/template/murasaki_platform.cpp
• modified: stm32_experimental/murasaki_sample/murasaki/template/murasaki_platform.hpp

Incremental Difference

--- a/stm32_experimental/murasaki_sample/murasaki/template/murasaki_platform.cpp
+++ b/stm32_experimental/murasaki_sample/murasaki/template/murasaki_platform.cpp
@@ -15,6 +15,8 @@
 
 // Include the prototype  of functions of this file.
 
+/* -------------------- PLATFORM Type and classes -------------------------- */
+
 /* -------------------- PLATFORM VARIABLES-------------------------- */
 
 // Essential definition.
@@ -45,25 +47,6 @@ extern UART_HandleTypeDef huart3;
 
 void TaskBodyFunction(const void* ptr);
 
-/**
- * @brief Initialize the platform variables.
- * @ingroup MURASAKI_PLATFORM_GROUP
- * @details
- * The murasaki::platform variable is an interface between the application program and HAL / RTOS.
- * To use it correctly, the initialization is neede before any activity of murasaki client.
- *
- * @code
- * void StartDefaultTask(void const * argument)
- * {
- *     InitPlatform();
- *     ExecPlatform();
- * }
- * @endcode
- *
- * This function have to be invoked from the StartDefaultTask() of the main.c only once
- * to initialize the platform varaiable.
- *
- */
 void InitPlatform()
 {
     // UART device setting for console interface.
@@ -103,18 +86,6 @@ void InitPlatform()
 
 }
 
-/**
- * @brief The body of the real application.
- * @ingroup MURASAKI_PLATFORM_GROUP
- * @details
- * The body function of the murasaki application. Usually this function is called from
- * the StartDefaultTask() of the main.c.
- *
- * This function is invoked only once, and never return. See @ref InitPlatform() as calling sample.
- *
- * By default, it toggles LED as sample program.
- * Inside this function can be customized freely.
- */
 void ExecPlatform()
 {
     // counter for the demonstration.
@@ -477,63 +448,18 @@ void HAL_GPIO_EXTI_Callback(uint16_t GPIO_P)
 
 /* ------------------ ASSERTION AND ERROR -------------------------- */
 
-/**
- * @brief Hook for the assert_failure() in main.c
- * @ingroup MURASAKI_PLATFORM_GROUP
- * @param file Name of the source file where assertion happen
- * @param line Number of the line where assertion happen
- * @details
- * This routine provides a custom hook for the assertion inside STM32 HAL.
- * All assertion raised in HAL will be redirected here.
- *
- * @code
- * void assert_failed(uint8_t* file, uint32_t line)
- * {
- *     CustomAssertFailed(file, line);
- * }
- * @endcode
- * By default, this routine output a message with location informaiton
- * to the debugger console.
- */
 void CustomAssertFailed(uint8_t* file, uint32_t line)
                         {
     murasaki::debugger->Printf("Wrong parameters value: file %s on line %d\r\n",
                                file, line);
 }
 
-/**
- * @brief Hook for the default exception handler. Never return.
- * @ingroup MURASAKI_PLATFORM_GROUP
- * @details
- * This routine is invoked from the default handler of the start up file.
- * The modification to the startup file is user's responsibility.
- *
- * For example, the start up code for the Nucleo-L152RE is startup_stml152xe.s.
- * This file is generated by CubeMX. This file has default handler as like this:
- *
- * @code
- * .section .text.Default_Handler,"ax",%progbits
- *     Default_Handler:
- * Infinite_Loop:
- *     b Infinite_Loop
- * @endcode
- *
- * This code can be modified to call CustomDefaultHanler as like this :
- * @code
- * .global CustomDefaultHandler
- * .section .text.Default_Handler,"ax",%progbits
- * Default_Handler:
- *     bl CustomDefaultHandler
- * Infinite_Loop:
- *     b Infinite_Loop
- * @endcode
- */
 void CustomDefaultHandler() {
     // Call debugger's post mortem processing. Never return again.
     murasaki::debugger->DoPostMortem();
 }
 
-
+/* ------------------ User Function -------------------------- */
 // Task body of the murasaki::platform.task1
 void TaskBodyFunction(const void* ptr)
                       {

--- a/stm32_experimental/murasaki_sample/murasaki/template/murasaki_platform.hpp
+++ b/stm32_experimental/murasaki_sample/murasaki/template/murasaki_platform.hpp
@@ -17,11 +17,88 @@ extern "C" {
 
 #include <stdint.h>
 // Murasaki platform control
+/**
+ * @brief Initialize the platform variables.
+ * @ingroup MURASAKI_PLATFORM_GROUP
+ * @details
+ * The murasaki::platform variable is an interface between the application program and HAL / RTOS.
+ * To use it correctly, the initialization is needed before any activity of murasaki client.
+ *
+ * @code
+ * void StartDefaultTask(void const * argument)
+ * {
+ *     InitPlatform();
+ *     ExecPlatform();
+ * }
+ * @endcode
+ *
+ * This function have to be invoked from the StartDefaultTask() of the main.c only once
+ * to initialize the platform varaiable.
+ *
+ */
 void InitPlatform();
+
+/**
+ * @brief The body of the real application.
+ * @ingroup MURASAKI_PLATFORM_GROUP
+ * @details
+ * The body function of the murasaki application. Usually this function is called from
+ * the StartDefaultTask() of the main.c.
+ *
+ * This function is invoked only once, and never return. See @ref InitPlatform() as calling sample.
+ *
+ * By default, it toggles LED as sample program.
+ * Inside this function can be customized freely.
+ */
+
 void ExecPlatform();
-// For the STM32 HAL assertion_failed();
+/**
+ * @brief Hook for the assert_failure() in main.c
+ * @ingroup MURASAKI_PLATFORM_GROUP
+ * @param file Name of the source file where assertion happen
+ * @param line Number of the line where assertion happen
+ * @details
+ * This routine provides a custom hook for the assertion inside STM32 HAL.
+ * All assertion raised in HAL will be redirected here.
+ *
+ * @code
+ * void assert_failed(uint8_t* file, uint32_t line)
+ * {
+ *     CustomAssertFailed(file, line);
+ * }
+ * @endcode
+ * By default, this routine output a message with location informaiton
+ * to the debugger console.
+ */
+
 void CustomAssertFailed(uint8_t* file, uint32_t line);
-// For the hook of the default exception handler.
+/**
+ * @brief Hook for the default exception handler. Never return.
+ * @ingroup MURASAKI_PLATFORM_GROUP
+ * @details
+ * This routine is invoked from the default handler of the start up file.
+ * The modification to the startup file is user's responsibility.
+ *
+ * For example, the start up code for the Nucleo-L152RE is startup_stml152xe.s.
+ * This file is generated by CubeMX. This file has default handler as like this:
+ *
+ * @code
+ * .section .text.Default_Handler,"ax",%progbits
+ *     Default_Handler:
+ * Infinite_Loop:
+ *     b Infinite_Loop
+ * @endcode
+ *
+ * This code can be modified to call CustomDefaultHanler as like this :
+ * @code
+ * .global CustomDefaultHandler
+ * .section .text.Default_Handler,"ax",%progbits
+ * Default_Handler:
+ *     bl CustomDefaultHandler
+ * Infinite_Loop:
+ *     b Infinite_Loop
+ * @endcode
+ */
 void CustomDefaultHandler();
 #ifdef __cplusplus
 }