Commit: 78946eebd430f8866e5a45965d6cb68dc313c842 - shared_foo (git)

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

Commit MetaInfo

• Revision: 78946eebd430f8866e5a45965d6cb68dc313c842 (tree)
• Time: 2019-02-03 19:38:26
• Author: takemasa <suikan@user...>
• Commiter: takemasa

Log Message

Added doxygen comment

Change Summary

• modified: stm32_development/murasaki/NUCLEO-F746ZG.xml
• modified: stm32_development/murasaki/murasaki/task.hpp

Incremental Difference

--- 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>SWD</dbgIF>
     <dbgIF>JTAG</dbgIF>
+    <dbgIF>SWD</dbgIF>
     <dbgDEV>ST-Link</dbgDEV>
     <mcuId>stm32f746zgtx</mcuId>
   </board>

--- a/stm32_development/murasaki/murasaki/task.hpp
+++ b/stm32_development/murasaki/murasaki/task.hpp
@@ -18,19 +18,39 @@ namespace murasaki {
  * This class is handy class to encapsulate the task creation without inheriting.
  * A task can be created easy like :
  * @code
+ *     // For demonstration of FreeRTOS task.
+ *     murasaki::platform.task1 = new murasaki::Task(
+ *                                                   "Master",
+ *                                                   256,
+ *                                                   (( configMAX_PRIORITIES > 1) ? 1 : 0),
+ *                                                   nullptr,
+ *                                                   &TaskBodyFunction
+ *                                                   );
+ * @endcode
+ *
+ * Then, task you can call Start() member function to run.
  *
+ * @code
+ *    murasaki::platform.task1->Start();
  * @endcode
  *
  */
 class Task : public murasaki::AbstractTask {
  public:
     /**
+     * @brief Ease to use task class.
+     * @param task_name A name of task. This is relevant to the FreeRTOS's API manner.
+     * @param stack_depth Task stack size by byte.
+     * @param task_priority The task priority. Max priority is defined by configMAX_PRIOIRTIES in FreeRTOSConfig.h
+     * @param task_parameter A pointer to the parameter passed to task.
+     * @param task_body_func A pointer to the task body function.
+     * @details
+     * Create an task object. Given parameters are stored internally. And then passed to the
+     * FreeRTOS API when task is started by Start() member function.
+     *
+     * A task parameter can be passed to task through the task_parameter. This pointer is simply passed
+     * to the task body function without modification.
      *
-     * @param task_name
-     * @param stack_depth
-     * @param task_priority
-     * @param task_parameter
-     * @param task_body_func
      */
     Task(
          const char * task_name,
@@ -41,15 +61,18 @@ class Task : public murasaki::AbstractTask {
 
  protected:
     /**
-     *
-     * @param ptr
+     * @brief Task member function.
+     * @param ptr The task_parameter parameter of the constructor is passed to this parameter.
+     * @details
+     * This member function runs as task. In this function, the function passed thorough task_body_func parameter
+     * is invoked as actual task body.
      */
     virtual void TaskBody(const void * ptr);
 
  private:
     /**
      *
-     * @param
+     * @brief A storage for the pointer to the task body function.
      */
     void (*task_body_func_)(const void *);
     };