テスト用のあれこれ共用フォルダ
| 修訂 | 81581ebb803e0b60e871bed1a642c54f5729cf47 (tree) |
|---|---|
| 時間 | 2018-09-23 16:32:00 |
| 作者 |  takemasa <suikan@user...> |
| Commiter | takemasa |
Updated documents for the DebuggerUart class.
stm32_development/murasaki/murasaki/debuggeruart.hpp (diff) stm32_development/murasaki/murasaki/murasaki_ug.hpp (diff)| @@ -19,15 +19,15 @@ | ||
| 19 | 19 | namespace murasaki { |
| 20 | 20 | |
| 21 | 21 | /** |
| 22 | - * \ingroup MURASAKI_GROUP | |
| 23 | - * \brief Concrete implementation of UART controller. Based on the STM32 HAL DMA Transfer. | |
| 22 | + * @ingroup MURASAKI_HELPER_GROUP | |
| 23 | + * \brief Logging dedicated UART class | |
| 24 | 24 | * \details |
| 25 | 25 | * |
| 26 | - * The Uart class is the wrapper of the UART controller. To use the Uart class, | |
| 26 | + * The Uart class is the wrapper of the UART controller. To use the DebuggerUart class, | |
| 27 | 27 | * make an instance with UART_HandleTypeDef * type pointer. For example, to create |
| 28 | 28 | * an instance for the UART3 peripheral : |
| 29 | 29 | * \code |
| 30 | - * my_uart3 = new murasaki::Uart(&huart3); | |
| 30 | + * my_uart3 = new murasaki::DebuggerUart(&huart3); | |
| 31 | 31 | * \endcode |
| 32 | 32 | * Where huart3 is the handle generated by CubeMX for UART3 peripheral. To use this class, |
| 33 | 33 | * the UART peripheral have to be configured to use the DMA functionality. The baud rate, |
| @@ -233,7 +233,7 @@ | ||
| 233 | 233 | * { |
| 234 | 234 | * counter = 0; |
| 235 | 235 | * |
| 236 | - * murasaki::platform.uart_console = new murasaki::Uart(uart_handle); | |
| 236 | + * murasaki::platform.uart_console = new murasaki::DebuggerUart(uart_handle); | |
| 237 | 237 | * murasaki::platform.logger = new murasaki::UartLogger(murasaki::platform.uart_console); |
| 238 | 238 | * |
| 239 | 239 | * murasaki::debugger = new murasaki::Debugger(murasaki::platform.logger); |
| @@ -315,11 +315,13 @@ | ||
| 315 | 315 | * } |
| 316 | 316 | * \endcode |
| 317 | 317 | * |
| 318 | - * Above example is basic setup of Uart class. But common among the peripheral encapsulating class in Murasaki. | |
| 318 | + * Above example is basic setup of DebuggerUart class. But common among the peripheral encapsulating class in Murasaki. | |
| 319 | 319 | * |
| 320 | + * Note that it is strongly recommended to use the @ref DebuggerUart class as base of the debugger. But for | |
| 321 | + * the normal use, the @ref Uart class is provided better class. | |
| 320 | 322 | * |
| 321 | 323 | * \section sec_us_4 Test run |
| 322 | - * The murasaki::Uart type object can transmit or receive data in task context. | |
| 324 | + * The murasaki::Uart ( and muraski::DebuggerUart ) type object can transmit or receive data in task context. | |
| 323 | 325 | * Both transmission and receive are independent. Then, 2 independent tasks can |
| 324 | 326 | * call each member function simultaneously. |
| 325 | 327 | * |
Fork