Prepare to release

Change all "STM32 HAL" to "STM32Cube HAL", to align the ST brand.
Copy refman.pdf
 to doc/ subdirectory.

Inc/debuggeruart.hpp

@@ -72,7 +72,7 @@ class DebuggerUart : public UartStrategy
      * \brief Constructor
      * \param uart Pointer to a UART control struct. This device have to be configured to use DMA and interrupt for both Tx and Rx.
      * \details
-     * Store the given uart pointer into the internal variable. This pointer is passed to the STM32 HAL UART functions when needed.
+     * Store the given uart pointer into the internal variable. This pointer is passed to the STM32Cube HAL UART functions when needed.
      *
      */
     DebuggerUart(UART_HandleTypeDef * uart);

Inc/i2cmaster.hpp

@@ -20,7 +20,7 @@ namespace murasaki {
 
 /**
  * \ingroup MURASAKI_GROUP
- * @brief Thread safe, blocking IO. Encapsulating I2C master. Based on STM32 HAL driver and FreeRTOS
+ * @brief Thread safe, blocking IO. Encapsulating I2C master. Based on STM32Cube HAL driver and FreeRTOS
  * \details
  * The I2cMaster class is the wrapper of the I2C controller. To use the I2cMaster class,
  * make an instance with I2C_HandleTypeDef * type pointer. For example, to create

Inc/i2cslave.hpp

@@ -20,7 +20,7 @@
 namespace murasaki {
 /**
  * \ingroup MURASAKI_GROUP
- * @brief Thread safe, blocking IO. Encapsulating I2C slave. Based on STM32 HAL driver and FreeRTOS
+ * @brief Thread safe, blocking IO. Encapsulating I2C slave. Based on STM32Cube HAL driver and FreeRTOS
  * \details
  * The I2cSlave class is the wrapper of the I2C controller. To use the I2cSlave class,
  * make an instance with I2C_HandleTypeDef * type pointer. For example, to create

Inc/murasaki_0_intro.hpp

@@ -11,7 +11,7 @@
 
 /**
  * \page murasaki_ug_preface Preface
- * \brief Murasaki, is a class library on the STM32 HAL and FreeRTOS.
+ * \brief Murasaki, is a class library on the STM32Cube HAL and FreeRTOS.
  * \details
  * By using Murasaki, you can program STM32 series quickly and easily.
  *
@@ -36,7 +36,7 @@
  *
  * Where huart3 is a UART port 3 handle generated by the CubeMX.
  *
- * The STM32 HAL is quite rich and flexible. On the other hand, it is quite huge and complex.
+ * The STM32Cube HAL is quite rich and flexible. On the other hand, it is quite huge and complex.
  * The classes in Murasaki simplifies it by letting flexibility beside.
  * For example, the murasaki::Uart class  can support only the DMA transfer.
  * The interrupt-based transfer is not supported.

Inc/murasaki_2_ug.hpp

@@ -106,7 +106,7 @@
  * These features helps programmer to display message in the real-time, multi-task application.
  *
  * In addition to this simple debugging variable, a programmer can use assert_failure() function of the STM32 HA.
- * The STM32 HAL has assert_failure() to check the parameter on the fly.
+ * The STM32Cube HAL has assert_failure() to check the parameter on the fly.
  * By default, this function is disabled.
  * To use this function, programmer have to make it enable, and add function to receive the
  * debug information.

Inc/murasaki_3_pg.hpp

@@ -15,7 +15,7 @@
  * \details
  *
  * In this guide, user will study the library porting to the STM32 microcomputer
- * system working with STM32 HAL.
+ * system working with STM32Cube HAL.
  *
  * Followings are the contents of this porting guide :
  *

Inc/murasaki_assert.hpp

@@ -61,7 +61,7 @@
  * This assertion do nothing if programmer defines \ref MURASAKI_CONFIG_NODEBUG macro as true.
  * This macro is defined in the file \ref platform_config.hpp.
  *
- * For example, following code is typical usage of this macro. ERROR maccro is copied from STM32 HAL source code.
+ * For example, following code is typical usage of this macro. ERROR maccro is copied from STM32Cube HAL source code.
  * @code
  * bool Uart::HandleError(void* const ptr)
  * {

Inc/murasaki_defs.hpp

@@ -45,7 +45,7 @@
  * \brief Personal Platform parts collection
  * \details
  * This name space encloses personal collections of the software parts to create a "platform" of the software development.
- * This specific collection is based on the STM32 HAL and FreeRTOS, both are generated by CubeMX.
+ * This specific collection is based on the STM32Cube HAL and FreeRTOS, both are generated by CubeMX.
  */
 namespace murasaki {
 

Inc/spimaster.hpp

@@ -18,7 +18,7 @@
 
 namespace murasaki {
 /**
- * @brief Thread safe, blocking IO. Encapsulating SPI master. Based on STM32 HAL driver and FreeRTOS
+ * @brief Thread safe, blocking IO. Encapsulating SPI master. Based on STM32Cube HAL driver and FreeRTOS
  * \details
  * The SpiMaster class is the wrapper of the SPI controller. To use the SpiMaster class,
  * make an instance with SPI_HandleTypeDef * type pointer. For example, to create

Inc/spislave.hpp

@@ -18,7 +18,7 @@
 
 namespace murasaki {
 /**
- * @brief Thread safe, blocking IO. Encapsulating SPI slave. Based on STM32 HAL driver and FreeRTOS
+ * @brief Thread safe, blocking IO. Encapsulating SPI slave. Based on STM32Cube HAL driver and FreeRTOS
  * \details
  * The SpiSlave class is the wrapper of the SPI controller. To use the SpiSlave class,
  * make an instance with SPI_HandleTypeDef * type pointer. For example, to create

Inc/uart.hpp

@@ -20,7 +20,7 @@ namespace murasaki {
 
 /**
  * \ingroup MURASAKI_GROUP
- * \brief Concrete implementation of UART controller. Based on the STM32 HAL DMA Transfer.
+ * \brief Concrete implementation of UART controller. Based on the STM32Cube HAL DMA Transfer.
  * \details
  *
  * The Uart class is the wrapper of the UART controller. To use the Uart class,
@@ -72,7 +72,7 @@ class Uart : public UartStrategy
      * \brief Constructor
      * \param uart Pointer to a UART control struct. This device have to be configured to use DMA and interrupt for both Tx and Rx.
      * \details
-     * Store the given uart pointer into the internal variable. This pointer is passed to the STM32 HAL UART functions when needed.
+     * Store the given uart pointer into the internal variable. This pointer is passed to the STM32Cube HAL UART functions when needed.
      *
      */
     Uart(UART_HandleTypeDef * uart);

doc/DOCUMENTATION.md

@@ -0,0 +1,55 @@
+# HOW TO GENERATE Murasaki Document
+
+To generate the doxygen documents, there are two way.
+
+- Generate the document from SW4STM32
+- Generate the document from Ubuntu terminal window
+
+## Generate the document from SW4STM32
+
+Be sure the SW4STM32 is installed, and the murasaki project ( this
+directory ) is imported to the workspace.
+
+ 1. From the menu bar, choose Help->Eclipse Market place...
+ 1. From the Find input control, type "eclox", then type return.
+ 1. Install the eclox, including doxygen binary.
+ 1. Choose the murasaki project and right click.
+ 1. From the context menu, do the Build Documentation.
+
+You will see the documents in the html sub-directory.
+
+## Generate the document from Ubuntu terminal window
+
+Followings are tested in the Ubuntu 16.04 LTS
+
+1. Open the terminal window
+1. execute following :
+```
+sudo apt-get update
+sudo apt-get upgrade
+sudo apt-get install doxygen
+cd murasaki # this directory
+doxygen murasaki.doxyfile
+```
+ You will see the documents in the html sub-direcotry.
+
+## How to make PDF manual
+
+To make a PDF manual, follow :
+
+1. Open the terminal window
+2. execute following
+```
+ sudo apt-get install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
+ cd murasaki # this directory
+ cd latex
+ make
+```
+The file name is refman.pdf.
+
+## Where to read first
+
+Open the html file in the html directory, then, click Related Pages
+-> A user's guide of Murasaki Class library
+
+Or open murasaki_ug.html file.

template/murasaki_platform.cpp

@@ -187,7 +187,7 @@ void ExecPlatform()
  * @details
  * This is called from inside of HAL when an UART transmission done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default TX interrupt call back.
@@ -211,7 +211,7 @@ void HAL_UART_TxCpltCallback(UART_HandleTypeDef * huart)
  * @details
  * This is called from inside of HAL when an UART receive done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default RX interrupt call back.
@@ -235,7 +235,7 @@ void HAL_UART_RxCpltCallback(UART_HandleTypeDef * huart)
  * @details
  * This is called from inside of HAL when an UART error interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default error interrupt call back.
@@ -263,7 +263,7 @@ void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart) {
  * @details
  * This is called from inside of HAL when an SPI transfer done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default TX/RX interrupt call back.
@@ -287,7 +287,7 @@ void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi) {
  * @details
  * This is called from inside of HAL when an SPI error interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default error interrupt call back.
@@ -318,7 +318,7 @@ void HAL_SPI_ErrorCallback(SPI_HandleTypeDef * hspi) {
  * @details
  * This is called from inside of HAL when an I2C transmission done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default TX interrupt call back.
@@ -342,7 +342,7 @@ void HAL_I2C_MasterTxCpltCallback(I2C_HandleTypeDef * hi2c)
  * @details
  * This is called from inside of HAL when an I2C receive done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default RX interrupt call back.
@@ -365,7 +365,7 @@ void HAL_I2C_MasterRxCpltCallback(I2C_HandleTypeDef * hi2c) {
  * @details
  * This is called from inside of HAL when an I2C transmission done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default TX interrupt call back.
@@ -389,7 +389,7 @@ void HAL_I2C_SlaveTxCpltCallback(I2C_HandleTypeDef * hi2c)
  * @details
  * This is called from inside of HAL when an I2C receive done interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default RX interrupt call back.
@@ -413,7 +413,7 @@ void HAL_I2C_SlaveRxCpltCallback(I2C_HandleTypeDef * hi2c) {
  * @details
  * This is called from inside of HAL when an I2C error interrupt is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default error interrupt call back.
@@ -443,7 +443,7 @@ void HAL_I2C_ErrorCallback(I2C_HandleTypeDef * hi2c) {
  * @details
  * This is called from inside of HAL when an EXTI is accepted.
  *
- * STM32 HAL has same name function internally.
+ * STM32Cube HAL has same name function internally.
  * That function is invoked whenever an relevant interrupt happens.
  * In the other hand, that function is declared as weak bound.
  * As a result, this function overrides the default error interrupt call back.

template/murasaki_platform.hpp

@@ -58,7 +58,7 @@ void ExecPlatform();
  * @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.
+ * This routine provides a custom hook for the assertion inside STM32Cube HAL.
  * All assertion raised in HAL will be redirected here.
  *
  * @code