Commit: b05d7c6ac23c1fa146fa414d3bf715e4c190920d - shared_foo (git)

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

Commit MetaInfo

• Revision: b05d7c6ac23c1fa146fa414d3bf715e4c190920d (tree)
• Zeit: 2019-01-28 18:26:47
• Autor: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Edited Doxygen comment : Modify the subpage and added brief to PG/UG

Ändern Zusammenfassung

• modified: stm32_development/murasaki/murasaki/murasaki_0_intro.hpp
• add: stm32_development/murasaki/murasaki/murasaki_1_env.hpp
• delete: stm32_development/murasaki/murasaki/{murasaki_1_ug.hpp => murasaki_2_ug.hpp}
• delete: stm32_development/murasaki/murasaki/{murasaki_2_pg.hpp => murasaki_3_pg.hpp}

Diff

--- a/stm32_development/murasaki/murasaki/murasaki_0_intro.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_0_intro.hpp
@@ -6,8 +6,8 @@
  * \brief Doxygen document file. No need to include.
  */
 
-#ifndef MURASAKI_0_UG_HPP_
-#define MURASAKI_0_UG_HPP_
+#ifndef MURASAKI_0_INTRO_HPP_
+#define MURASAKI_0_INTRO_HPP_
 
 /**
  * \page murasaki_ug_preface Preface
@@ -17,16 +17,17 @@
  *
  * Murasaki has following design philosophies:
  *
- * \li \ref sec2
- * \li \ref sec3
- * \li \ref sec4
- * \li \ref sec5
- * \li \ref sec6
- * \li \ref sec7
- * \li \ref sec8
- *
- * \section sec2 Simplified IO
- * The IO function is packaged by class types. For example, The murasaki::Uart class can
+ * \li \subpage intro_sec1
+ * \li \subpage intro_sec2
+ * \li \subpage intro_sec3
+ * \li \subpage intro_sec4
+ * \li \subpage intro_sec5
+ * \li \subpage intro_sec6
+ * \li \subpage intro_sec7
+ * \li \subpage intro_sec8
+ *
+ * \page intro_sec1 Simplified IO
+ * \brief The IO function is packaged by class types. For example, The murasaki::Uart class can
  * receive a UART handle
  *
  * \code
@@ -41,8 +42,8 @@
  * The interrupt-based transfer is not supported.
  * By giving up the flexibility, programming with Murasaki is easier than using HAL directly.
  *
- * \section sec3 Preemptive multi-task
- * The Murasaki class library is buit on FreeRTOS's preemptive configuration.
+ * \page intro_sec2 Preemptive multi-task
+ * \brief The Murasaki class library is buit on FreeRTOS's preemptive configuration.
  * As a result, Murasaki is automatically aware with preemptive multi-task.
  *
  * That means, Murasaki's classes don't use polling to wait for any event. Then, a task
@@ -52,8 +53,8 @@
  * a good way to develop a large program easier.
  * And the more important point, it is easier to maintain.
  *
- * \section sec4 Blocking IO
- * The blocking IO is one of the most important features of Murasaki.
+ * \page intro_sec3 Blocking IO
+ * \brief The blocking IO is one of the most important features of Murasaki.
  *
  * The peripheral wrapping class like murasaki::Uart provides a set of member functions
  * to do the data transmission/receiving. Such the member functions are programmed
@@ -70,8 +71,8 @@
  * To provide the blocking IO, some member functions are restricted to use only in
  * the task context.
  *
- * \section sec5 Thread safe IO
- * The blocking IO and the  preemptive multi-task provide easier programming.
+ * \page intro_sec4 Thread safe IO
+ * \brief The blocking IO and the  preemptive multi-task provide easier programming.
  * In the other hand, there is a possibility that two different task accesses
  * one peripheral simultaneously.
  * This kind of access messes the peripheral's behavior.
@@ -82,8 +83,8 @@
  * By this mechanism, if two tasks try to transmit though one peripheral, one task
  * is kept waiting until the other finished to transmit.
  *
- * \section sec6 Versatile printf() logger
- * Logging or "printf debug" is a strong tool in the embedded system development.
+ * \page intro_sec5 Versatile printf() logger
+ * \brief Logging or "printf debug" is a strong tool in the embedded system development.
  *
  * Murasaki has three levels of the printf debugging mechanism. One is the \ref murasaki::debugger->Printf(),
  * the second is \ref MURASAKI_ASSERT macro. In addtion to these two, \ref MURASAKI_SYSLOG macro is avairable.
@@ -98,21 +99,21 @@
  * These features allow a programmer to do the printf() debug not only in the task context
  * but also in the interrupt context.
  *
- * \section sec7 Guard by assertion
- * In addition to the murasaki::debugger->Printf(), programmer can use \ref MURASAKI_ASSERT macro.
+ * \page intro_sec6 Guard by assertion
+ * \brief In addition to the murasaki::debugger->Printf(), programmer can use \ref MURASAKI_ASSERT macro.
  * This allows easy assertion and logging. This macro uses the murasaki::debugger->Printf()
  * internally.
  *
  * This assertion is used inside Murasaki class library.
  * 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.
+ * \page intro_sec7 System Logging
+ * \brief \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.
+ * \page intro_sec8 Configurable
+ * \brief Murasaki is configurable from the two point of view.
  *
  * First, Musaraki's modules enable only when the relevant peripheral is generated by CubeMX.
  * This allows you set the CubeMX to generate only the used peripheral's source code.
@@ -131,24 +132,5 @@
 
 
 
-/**
- * \page murasaki_ug_environment Target and Environment
- * \brief Murasaki library was originally developed with following environment:
- * \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 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>
- *
- */
-
 
 #endif /* MURASAKI_0_UG_HPP_ */

--- /dev/null
+++ b/stm32_development/murasaki/murasaki/murasaki_1_env.hpp
@@ -0,0 +1,33 @@
+/*
+ * \file murasaki_ug.hpp
+ *
+ * \date 2018/02/01
+ * \author takemasa
+ * \brief Doxygen document file. No need to include.
+ */
+
+#ifndef MURASAKI_0_ENV_HPP_
+#define MURASAKI_1_ENV_HPP_
+
+
+/**
+ * \page murasaki_ug_environment Target and Environment
+ * \brief Murasaki library was originally developed with following environment:
+ * \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 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>
+ *
+ */
+
+
+#endif /* MURASAKI_0_UG_HPP_ */

--- a/stm32_development/murasaki/murasaki/murasaki_1_ug.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_2_ug.hpp
@@ -6,8 +6,8 @@
  * \brief Doxygen document file. No need to include.
  */
 
-#ifndef MURASAKI_1_UG_HPP_
-#define MURASAKI_1_UG_HPP_
+#ifndef MURASAKI_2_UG_HPP_
+#define MURASAKI_2_UG_HPP_
 
 
 /**
@@ -15,6 +15,12 @@
  * \brief In this introduction, we see how to use  Murasaki class library in the STM32 program.
  * \details
  *
+ * In this seciton, we see folling issues :
+ * \li \subpage ug_sec_us_1
+ * \li \subpage ug_sec_us_2
+ * \li \subpage ug_sec_us_3
+ * \li \subpage ug_sec_us_4
+ * \li \subpage ug_sec_us_5
  *
  * For the easy-to-understand description, we assumes several things on the application skeleton which we are going to use Murasaki :
  * \li The application skeleton is generated by <a href= "http://www.st.com/ja/development-tools/stm32cubemx.html"> CubeMX </a>
@@ -22,8 +28,8 @@
  * \li UART3 is configured to work with DMA.
  * \li One of the EXTI interrupt lines is enabled and label "B1" is assigned.
  *
- * \section sec_us_1 Using C++ class from C application
- * First of all, we have to consider the inter-language linking between C and C++ program.
+ * \page ug_sec_us_1 Using C++ class from C application
+ * \brief First of all, we have to consider the inter-language linking between C and C++ program.
  *
  * The CubeMX generates a program skeleton by C language.
  * Also, the STM32 HAL is programmed by C language.
@@ -72,8 +78,8 @@
  *
  * This is a common and essential technique to run C++ program with C application.
  *
- * \section sec_us_2 Platform variables.
- * There two Murasaki related variables which user should define.
+ * \page ug_sec_us_2 Platform variables.
+ * \brief There two Murasaki related variables which user should define.
  * One is required variable murasaki::debugger.
  * The other is optional variable murasaki::platform.
  *
@@ -138,8 +144,8 @@
  * By initializing this variable, the debug functionality of Murasaki becomes
  * ready to use.
  *
- * \section sec_us_3 Routing interrupts
- * Certain class variable of Murasaki have to be connected with
+ * \page ug_sec_us_3 Routing interrupts
+ * \brief Certain class variable of Murasaki have to be connected with
  * interrupt callback.
  *
  * The STM32 HAL uses the weak linkage prototype for the interrupt callback.
@@ -180,8 +186,8 @@
  * 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  murasaki::DebuggerUart ) type object can transmit or receive data in task context.
+ * \page ug_sec_us_4 Test run
+ * \brief 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.
  *
@@ -200,8 +206,8 @@
  *
  *
  *
- * \section sec_us_5 Debugging with Murasaki.
- * Murasaki has simple messaging output for realtime debug. This feature is
+ * \page ug_sec_us_5 Debugging with Murasaki.
+ * \brief Murasaki has simple messaging output for realtime debug. This feature is
  * typically used as UART serial output, but configurable by programmer.
  *
  * The murasaki::debugger is the useful variable to output the debugging message.
@@ -281,4 +287,4 @@
 
 
 
-#endif /* MURASAKI_1_UG_HPP_ */
+#endif /* MURASAKI_2_UG_HPP_ */

--- a/stm32_development/murasaki/murasaki/murasaki_2_pg.hpp
+++ b/stm32_development/murasaki/murasaki/murasaki_3_pg.hpp
@@ -6,8 +6,8 @@
  * @brief Porting Guide
  */
 
-#ifndef MURASAKI_2_PG_HPP_
-#define MURASAKI_2_PG_HPP_
+#ifndef MURASAKI_3_PG_HPP_
+#define MURASAKI_3_PG_HPP_
 
 /**
  * \page murasaki_pg Porting guide
@@ -455,5 +455,5 @@
 
 
 
-#endif /* MURASAKI_2_PG_HPP_ */
+#endif /* MURASAKI_3_PG_HPP_ */