shared_fooの不要ディレクトリ削除前のもの
| Revision | c8c80687166a052e5aaad0a8ff4136547b352432 (tree) |
|---|---|
| Time | 2018-02-22 21:47:05 |
| Author |  takemasa <suikan@user...> |
| Commiter | takemasa |
Modified Doxygen comment.
stm32_development/murasaki/Inc/platform_defs.hpp (diff) stm32_development/murasaki/murasaki/abstractlogger.hpp (diff) stm32_development/murasaki/murasaki/debugger.hpp (diff) stm32_development/murasaki/murasaki/murasaki_config.hpp (diff) stm32_development/murasaki/murasaki/murasaki_ug.hpp (diff) stm32_development/murasaki/murasaki/uartlogger.hpp (diff)| @@ -31,7 +31,7 @@ namespace murasaki { | ||
| 31 | 31 | * recommended to declare for the ease of reading. |
| 32 | 32 | * |
| 33 | 33 | * \code |
| 34 | - * murasaki::Debug * murasaki::debugger; | |
| 34 | + * murasaki::Debugger * murasaki::debugger; | |
| 35 | 35 | * murasaki::Platform * murasaki::platform; |
| 36 | 36 | |
| 37 | 37 | * \endcode |
| @@ -50,14 +50,14 @@ namespace murasaki { | ||
| 50 | 50 | * The platform.logger member variable hooks a murasaki::AbstractLogger variable. In this example, murasaki::UartLogger |
| 51 | 51 | * class variable is instantiated. |
| 52 | 52 | * |
| 53 | - * Finally, the debugger variable is initialized. The murasaki::Debug constructor receives murasaki::AbstractLogger * type. | |
| 53 | + * Finally, the debugger variable is initialized. The murasaki::Debugger constructor receives murasaki::AbstractLogger * type. | |
| 54 | 54 | * \code |
| 55 | 55 | * void InitPlatform(UART_HandleTypeDef * uart_handle) |
| 56 | 56 | * { |
| 57 | 57 | * murasaki::platform.uart_console = new murasaki::Uart(uart_handle); |
| 58 | 58 | * murasaki::platform.logger = new murasaki::UartLogger(murasaki::platform.uart_console); |
| 59 | 59 | * |
| 60 | - * murasak::debugger = new murasaki::Debug(murasaki::platform.logger); | |
| 60 | + * murasak::debugger = new murasaki::Debugger(murasaki::platform.logger); | |
| 61 | 61 | * } |
| 62 | 62 | * |
| 63 | 63 | * \endcode |
| @@ -72,7 +72,7 @@ namespace murasaki { | ||
| 72 | 72 | * This is a custom struct. Programmer can change this struct as suitable to the hardware and software. |
| 73 | 73 | * But debugger_ member variable have to be left untouched. |
| 74 | 74 | * |
| 75 | - * In the run time, the debugger_ variable have to be initialized by appropriate \ref murasaki::Debug class instance. | |
| 75 | + * In the run time, the debugger_ variable have to be initialized by appropriate \ref murasaki::Debugger class instance. | |
| 76 | 76 | * |
| 77 | 77 | * See \ref murasaki::platform |
| 78 | 78 | */ |
| @@ -22,7 +22,7 @@ namespace murasaki { | ||
| 22 | 22 | * \brief Abstract class for logging. |
| 23 | 23 | * \details |
| 24 | 24 | * A generic class to serve a logging function. This class is designed to pass to the |
| 25 | - * \ref murasaki::Debug. | |
| 25 | + * \ref murasaki::Debugger. | |
| 26 | 26 | * |
| 27 | 27 | * As a service class to Debug. This class's two member functions ( putMessage() and getCharacter() ) |
| 28 | 28 | * have to be able to run in the task context. Both member functions also have to be the |
| @@ -1,5 +1,5 @@ | ||
| 1 | 1 | /** |
| 2 | - * \file debug.hpp | |
| 2 | + * \file debugger.hpp | |
| 3 | 3 | * |
| 4 | 4 | * \date 2018/01/03 |
| 5 | 5 | * \author takemasa |
| @@ -67,7 +67,7 @@ | ||
| 67 | 67 | * \def PLATFORM_CONFIG_DEBUG_TASK_STACK_SIZE |
| 68 | 68 | * \brief Size[Byte] of the task inside Debug class. |
| 69 | 69 | * \details |
| 70 | - * The murasaki::Debug class has internal task to handle its FIFO buffer. | |
| 70 | + * The murasaki::Debuger class has internal task to handle its FIFO buffer. | |
| 71 | 71 | * |
| 72 | 72 | * To override the definition here, define same macro inside @ref platform_config.hpp. |
| 73 | 73 | */ |
| @@ -81,7 +81,7 @@ | ||
| 81 | 81 | * \def PLATFORM_CONFIG_DEBUG_TASK_PRIORITY |
| 82 | 82 | * \brief The task proiority of the debug task. |
| 83 | 83 | * \details |
| 84 | - * The priority of the murasaki::Debug internal task. To output the logging data as fast as possible, | |
| 84 | + * The priority of the murasaki::Debuger internal task. To output the logging data as fast as possible, | |
| 85 | 85 | * the debug taks have to have relatively high priority. In other hand, to yield the CPU to the |
| 86 | 86 | * critical tasks, it's priority have to be smaller than the max priority. |
| 87 | 87 | * |
| @@ -278,7 +278,7 @@ | ||
| 278 | 278 | #include "murasaki.hpp" |
| 279 | 279 | |
| 280 | 280 | murasaki::Platform murasaki::platform; |
| 281 | - murasaki::Debug * murasaki::debugger; | |
| 281 | + murasaki::Debugger * murasaki::debugger; | |
| 282 | 282 | *\endcode |
| 283 | 283 | * |
| 284 | 284 | * Both variable is declared in header file. Then, they have to be declared |
| @@ -294,7 +294,7 @@ | ||
| 294 | 294 | * murasaki::platform.uart_console = new murasaki::Uart(uart_handle); |
| 295 | 295 | * murasaki::platform.logger = new murasaki::UartLogger(murasaki::platform.uart_console); |
| 296 | 296 | * |
| 297 | - * murasaki::debugger = new murasaki::Debug(murasaki::platform.logger); | |
| 297 | + * murasaki::debugger = new murasaki::Debugger(murasaki::platform.logger); | |
| 298 | 298 | * } |
| 299 | 299 | * \endcode |
| 300 | 300 | * |
| @@ -453,13 +453,13 @@ | ||
| 453 | 453 | * message is already transmitted ( and lost ). |
| 454 | 454 | * |
| 455 | 455 | * murasaki can save this problem. |
| 456 | - * By adding following code after creating murasaki::Debug instance, you can use history functionality. | |
| 456 | + * By adding following code after creating murasaki::Debugger instance, you can use history functionality. | |
| 457 | 457 | * |
| 458 | 458 | * @code |
| 459 | 459 | * murasaki::debugger->AutoHistory(); |
| 460 | 460 | * @endcode |
| 461 | 461 | * |
| 462 | - * The murasaki::Debug::AutoHistory() creattes a dedicated task for auto hisotry function. | |
| 462 | + * The murasaki::Debugger::AutoHistory() creattes a dedicated task for auto hisotry function. | |
| 463 | 463 | * This task watch the input from the logging port. |
| 464 | 464 | * Again, in this User's guide it is UART. |
| 465 | 465 | * Once any character is received from the logging port ( terminal ), |
| @@ -469,7 +469,7 @@ | ||
| 469 | 469 | * The auto hisotry is handy, but it blocks all input from the terminal. |
| 470 | 470 | * If you want to have your own console program through the debug port input, |
| 471 | 471 | * do not you the auto hisotry. Alternatively, you can send the previously transmitted mesage again, |
| 472 | - * by calling murasaki::Debug::PrintHistory() explicitly. | |
| 472 | + * by calling murasaki::Debugger::PrintHistory() explicitly. | |
| 473 | 473 | * |
| 474 | 474 | */ |
| 475 | 475 |
| @@ -21,7 +21,7 @@ namespace murasaki { | ||
| 21 | 21 | * \brief Logging through an UART port. |
| 22 | 22 | * \details |
| 23 | 23 | * This is a standard logging class through the UART port. The instance of this |
| 24 | - * class can be passed to the murasaki::Debug constructor. | |
| 24 | + * class can be passed to the murasaki::Debugger constructor. | |
| 25 | 25 | * |
| 26 | 26 | * See \ref MURASAKI_PLATFORM_GROUP as usage example. |
| 27 | 27 | * |
Fork