Commit: 0dc59fe500ea268b7c1a1fcb3050028184eaeb9f - shared_foo (git)

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

Commit MetaInfo

• Revisión: 0dc59fe500ea268b7c1a1fcb3050028184eaeb9f (tree)
• Tiempo: 2019-01-14 11:28:09
• Autor: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Refactoring doxygen comment.

Cambiar Resumen

• modified: stm32_development/murasaki/NUCLEO-F746ZG.xml
• modified: stm32_development/murasaki/murasaki.doxyfile
• modified: stm32_development/murasaki/murasaki/abstracti2cmaster.hpp
• modified: stm32_development/murasaki/murasaki/i2cmaster.hpp
• delete: stm32_development/murasaki/murasaki/{murasaki_pg.hpp => murasaki_1_pg.hpp}
• delete: stm32_development/murasaki/murasaki/{murasaki_ug.hpp => murasaki_0_ug.hpp}

Diferencia incremental

--- a/stm32_development/murasaki/NUCLEO-F746ZG.xml
+++ b/stm32_development/murasaki/NUCLEO-F746ZG.xml
@@ -12,8 +12,8 @@
 <targetDefinitions>
   <board id="nucleo-f746zg">
     <name>NUCLEO-F746ZG</name>
-    <dbgIF>JTAG</dbgIF>
     <dbgIF>SWD</dbgIF>
+    <dbgIF>JTAG</dbgIF>
     <dbgDEV>ST-Link</dbgDEV>
     <mcuId>stm32f746zgtx</mcuId>
   </board>

--- a/stm32_development/murasaki/murasaki.doxyfile
+++ b/stm32_development/murasaki/murasaki.doxyfile
@@ -98,7 +98,7 @@ OUTPUT_LANGUAGE = English
 # documentation (similar to Javadoc). Set to NO to disable this.
 # The default value is: YES.
 
-BRIEF_MEMBER_DESC = YES
+BRIEF_MEMBER_DESC = NO
 
 # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
 # description of a member or function before the detailed description
@@ -107,7 +107,7 @@ BRIEF_MEMBER_DESC = YES
 # brief descriptions will be completely suppressed.
 # The default value is: YES.
 
-REPEAT_BRIEF = YES
+REPEAT_BRIEF = NO
 
 # This tag implements a quasi-intelligent brief description abbreviator that is
 # used to form the text in various listings. Each string in this list, if found
@@ -2037,7 +2037,7 @@ INCLUDE_FILE_PATTERNS =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED = HAL_UART_MODULE_ENABLED HAL_I2C_MODULE_ENABLED HAL_SPI_MODULE_ENABLED HAL_GPIO_MODULE_ENABLED USE_FULL_ASSERT MURASAKI_CONFIG_NOSYSLOG 
+PREDEFINED = HAL_UART_MODULE_ENABLED HAL_I2C_MODULE_ENABLED HAL_SPI_MODULE_ENABLED HAL_GPIO_MODULE_ENABLED USE_FULL_ASSERT MURASAKI_CONFIG_NOSYSLOG
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

--- a/stm32_development/murasaki/murasaki/abstracti2cmaster.hpp
+++ b/stm32_development/murasaki/murasaki/abstracti2cmaster.hpp
@@ -75,7 +75,7 @@ class AbstractI2CMaster : murasaki::AbstractPeripheral
      * @param rx_data Data array to transmit.
      * @param rx_size Data counts[bytes] to transmit.
      * @param tx_transfered_count the count of the bytes transmitted during the API execution.
-     * @param tx_transfered_count the count of the bytes received during the API execution.
+     * @param rx_transfered_count the count of the bytes received during the API execution.
      * @param timeout_ms Time ou [mS]. By default, there is not timeout.
      * @return Result of the processing
      * @details

--- a/stm32_development/murasaki/murasaki/i2cmaster.hpp
+++ b/stm32_development/murasaki/murasaki/i2cmaster.hpp
@@ -151,7 +151,7 @@ class I2cMaster : public AbstractI2CMaster
      * @param rx_data Data array to transmit.
      * @param rx_size Data counts[bytes] to transmit. Must be smaller than 65536
      * @param tx_transfered_count the count of the bytes transmitted during the API execution.
-     * @param tx_transfered_count the count of the bytes received during the API execution.
+     * @param rx_transfered_count the count of the bytes received during the API execution.
      * @param timeout_ms Time ou [mS]. By default, there is not timeout.
      * @return Result of the processing
      * @details

--- a/stm32_development/murasaki/murasaki/murasaki_ug.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_0_ug.hpp
@@ -6,14 +6,14 @@
  * \brief Doxygen document file. No need to include.
  */
 
-#ifndef MURASAKI_UG_HPP_
-#define MURASAKI_UG_HPP_
+#ifndef MURASAKI_0_UG_HPP_
+#define MURASAKI_0_UG_HPP_
 
 /**
- * \page murasaki_ug A user's guide of Murasaki Class Library
- * \brief Overview of the Murasaki documentation.
+ * \page murasaki_ug User's guide
+ * \brief This user's guide introduces Murasaki class library step by step.
  * \details
- * This user's guide introduces Murasaki class library step by step.
+ *
  * In this guide, user will study the class library from scratch.
  * This guide is written carefully to be ease of understand.
  * But coverage is not perfect.
@@ -33,10 +33,9 @@
 
 /**
  * \page murasaki_ug_design Design Philosophy
- * \brief The base idea of this class library.
+ * \brief Murasaki, is a class library on the STM32 HAL and FreeRTOS.
  * \details
- * Murasaki, is a class library on the STM32 HAL and FreeRTOS. By using Murasaki,
- * you can program STM32 series quickly and easily.
+ * By using Murasaki, you can program STM32 series quickly and easily.
  *
  * \section sec1 Overview
  * Murasaki has following design philosophies:
@@ -152,9 +151,9 @@
 
 /**
  * \page murasaki_ug_usage Usage Introduction
- * \brief Step by Step introduction
+ * \brief In this page, we see how to use the Murasaki class library in the STM32 program.
  * \details
- * In this page, we see how to use the Murasaki class library in the STM32 program.
+ *
  *
  * In the following description we assumes several things on the application skeleton which we are going to use Murasaki :
  * \li It is generated by <a href= "http://www.st.com/ja/development-tools/stm32cubemx.html"> CubeMX </a>
@@ -317,11 +316,11 @@
  *
  * Above example is basic setup of DebuggerUart class. But common among the peripheral encapsulating class in Murasaki.
  *
- * Note that it is strongly recommended to use the @ref DebuggerUart class as base of the debugger. But for
+ * Note that it is strongly recommended to use the murasaki::DebuggerUart class as base of the debugger. But for
  * the normal use, the @ref murasaki::Uart class is provided better class.
  *
  * \section sec_us_4 Test run
- * The murasaki::Uart ( and @ref murasaki::DebuggerUart ) type object can transmit or receive data in task context.
+ * The murasaki::Uart ( and  murasaki::DebuggerUart ) type object can transmit or receive data in task context.
  * Both transmission and receive are independent. Then, 2 independent tasks can
  * call each member function simultaneously.
  *
@@ -421,9 +420,9 @@
 
 /**
  * \page murasaki_ug_environment Target and Environment
- * \brief Hardware and Software.
+ * \brief Murasaki library was originally developed with following environment:
  * \details
- * Murasaki library was originally developed with following environment:
+ *
  * \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>
@@ -436,4 +435,4 @@
  */
 
 
-#endif /* MURASAKI_UG_HPP_ */
+#endif /* MURASAKI_0_UG_HPP_ */

--- a/stm32_development/murasaki/murasaki/murasaki_pg.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_1_pg.hpp
@@ -6,14 +6,14 @@
  * @brief Porting Guide
  */
 
-#ifndef MURASAKI_PG_HPP_
-#define MURASAKI_PG_HPP_
+#ifndef MURASAKI_1_PG_HPP_
+#define MURASAKI_1_PG_HPP_
 
 /**
- * \page murasaki_pg A porting guide of Murasaki Class Library
- * \brief Describes how to port the murasaki library to the STM32 processor board.
+ * \page murasaki_pg Porting guide
+ * \brief This porting guide introduces murasaki class library porting step by step.
  * \details
- * This porting guide introduces murasaki class library porting step by step.
+ *
  * In this guide, user will study the library porting to the STM32 microcomputer
  * system working with STM32 HAL.
  *
@@ -38,9 +38,9 @@
 
 /**
  * \page murasaki_pg_directory Directory Structure
- * \brief Explain where is what
+ * \brief Murasaki has two main directory and several user modifiable files.
  * \details
- * Murasaki has two main directory and several user modifiable files
+ *
  * This page describes these directories and files. These file can be copied from the sample program.
  *
  * In the following descriptions, "/" means project root directory.
@@ -113,15 +113,15 @@
  * \li Custome default exception handler
  *
  * @section sec_ds_6 murasaki_platform.hpp
- * A header file of the @ref murasaki_platfrom.cpp
+ * A header file of the @ref murasaki_platform.cpp
  *
  */
 
 /**
  * \page murasaki_pg_cubemx CubeMX setting
- * \brief Setting for the runtime resources.
+ * \brief There is several required CubeMX setting.
  * \details
- * There is several required CubeMX setting
+ *
  * \li Heap Size
  * \li Stack Size
  * \li Task stack size of the default task
@@ -194,16 +194,16 @@
 
 /**
  * \page murasaki_pg_configuration Configuration
- * \brief Do you need to change the priority and stack size of task? Read here.
+ * \brief Murasaki has configurable parameters.
  * \details
- * Murasaki has configurable parameters.
+ *
  * These parameters control mainly the task size and task priority.
  *
  * One of the special configuration is \ref MURASAKI_CONFIG_NODEBUG macro.
  * This macro controls whether assertion inside murasaki source code works or ignored.
  *
  * To customize the configuration, define the configuration macro with desired value in the
- * \ref platform_config.hpp file.
+ *  platform_config.hpp file.
  * This definition will override the murasaki default configuration.
  *
  * For the detail of the each macros, see \ref MURASAKI_DEFINITION_GROUP.
@@ -211,9 +211,9 @@
 
 /**
  * @page murasaki_pg_task_priority_and_stack Task Priority and Stack Size
- * @brief How the task and ISR priority works.
+ * @brief The FreeRTOS task priority is allowed from 1 to configMAX_PRIORITIES.
  * @details
- * The FreeRTOS task priority is allowed from 1 to configMAX_PRIORITIES.
+ *
  * Where configMAX_PRIORITIES is porting dependent. Tha task with priority == configMAX_PRIORITIES will run with
  * the highest priority among all tasks.
  *
@@ -234,10 +234,9 @@
 
 /**
  * \page murasaki_pg_heap Heap memory consideration
- * \brief A consideration of the heap setting and usage.
+ * \brief In murasaki, there is a re-definition of new and delete operator inside \ref allocators.cpp.
  * @details
- * In murasaki, there is a re-definition of \ref new and \ref delete operator
- * inside \ref allocators.cpp. This re-definition let the pvPortMalloc() allocate
+ * This re-definition let the pvPortMalloc() allocate
  * a fragment of memory for the new operators.
  *
  * This changes converges all allocation to the FreeRTOS's heap.
@@ -256,9 +255,9 @@
 
 /**
  * \page murasaki_pg_platform_varialbe Platform variable
- * \brief Making platform variable.
+ * \brief The murasaki::platform and the murasaki::debugger have to be initialized by the InitPlatform() function.
  * @details
- * The murasaki::platform and the murasaki::debugger have to be initialized by the InitPlatform() function.
+ *
  * The programming of this function is a responsibility of the porting programmer.
  *
  * First of all, the porting programmer has to make the peripheral handles as visible from the murasaki_platform.cpp.
@@ -356,9 +355,9 @@
 
 /**
  * \page murasaki_pg_interrupt Routing interrupts
- * \brief Routing the system interrupt to the Murasaki platform.
+ * \brief The murasaki_platform.cpp has skeletons of HAL callback.
  * @details
- * The murasaki_platform.cpp has skeletons of HAL callbacks.
+ *
  * These callbacks are pre-defined inside HAL as receptors of interrupt.
  * These definitions inside HAL are "weak" binding. Thus, these skeletons in murasaki_platform.cpp overrides the definition.
  * The porting programmer have to program these skeltons correctly.
@@ -379,6 +378,8 @@
  * Murasaki class returns true if the given peripheral handle matches with its internal handle.
  * Thus, this is good way to poll all the UART peripheral inside this callback function.
  *
+ * Following is the list of the interrupts which applicaiton have to route to the peripehral class variables.
+ *
  * \li void HAL_UART_TxCpltCallback(UART_HandleTypeDef * huart);
  * \li void HAL_UART_RxCpltCallback(UART_HandleTypeDef * huart);
  * \li void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart);
@@ -393,9 +394,9 @@
 
 /**
  * \page murasaki_pg_error Error handling
- * \brief System error handling by the Murasaki platform.
+ * \brief The murasaki_platform.cpp has two error handling functions.
  * @details
- * The murasaki_platform.cpp has two error handling functions.
+ *
  * These functions are pre-programmed from the first.
  * And usually its enough to use the pre-programmed version.
  * In the other hand the porting programmer have to modify the application program to call these
@@ -454,5 +455,5 @@
 
 
 
-#endif /* MURASAKI_PG_HPP_ */
+#endif /* MURASAKI_1_PG_HPP_ */