酔漢用書き散らし
Fork

(Original repository, No fork origin)

提交

Editing doxygen comment. Add the structure to User's guide by page and
supage command.

--- a/stm32_development/murasaki/murasaki/murasaki_ug.hpp

+++ b/stm32_development/murasaki/murasaki/murasaki_ug.hpp

		@@ -9,13 +9,19 @@
9	9	#ifndef MURASAKI_UG_HPP_
10	10	#define MURASAKI_UG_HPP_
11	11
12		-
13	12	/**
14	13	* \page murasaki_ug A user's guide of Murasaki Class Library
	14	+ * \subpage murasaki_ug_design
	15	+ * \subpage murasaki_ug_usage
	16	+ * \subpage murasaki ug_configration
	17	+ */
	18	+
	19	+/**
	20	+ * \page murasaki_ug_design Design Philosophy
15	21	* Murasaki, is a class library on the STM32 HAL and FreeRTOS. By using murasaki,
16	22	* you can program STM32 series quickly and easily.
17	23	*
18		- * \section sec1 Design hilosophy
	24	+ * \section sec1 Overview
19	25	* Murasaki has following design philosophy.
20	26	*
21	27	* \li Simplified IO

		@@ -95,8 +101,16 @@
95	101	* \li none-blocking logging by internal buffer.
96	102	* \li user configurable output port
97	103	*
98		- * These features allow programmer to do the printf() debug not only
99		- * todo
	104	+ * These features allow programmer to do the printf() debug not only in the task context
	105	+ * but also in the interrupt context.
	106	+ *
	107	+ * \subsection sec1_6 Guard by assertion
	108	+ * In addition to the murasaki::debugger->printf(), programmer can use MURASAKI_ASSERT macro.
	109	+ * This allows easy assertion and logging. This macro uses the murasaki::debugger->printf()
	110	+ * internally.
	111	+ *
	112	+ * This assertion is used inside murasaki class library. Then, the wrong context,
	113	+ * wrong parameter, etc will be reported to the debugger output.
100	114	*
101	115	*
102	116	* Each classes are the components to control the each peripherals of the STM32 microcomputer.

		@@ -106,17 +120,6 @@
106	120	* what STM32 HAL or each peripheral can provide. Alternatively, interface is easy to use.
107	121	*
108	122	*
109		- * The FreeRTOS is required to implement the blocking IOs. During the waiting for the completion
110		- * of the IO activity, each interface
111		- * function yields the execusion to other tasks, rather than poling IO. Also, each IO communication
112		- * functions are internaly guarded
113		- * by semaphore. Thus, the transmission / receiving member functions must be invoked from the task context.
114		- *
115		- * The murasaki::Debug is a dedicated for the printf debug. This class has a member function named printf.
116		- * This function works like system's printf() and output the formatted string to the specified logging object.
117		- * The biggest advantage of this class is, its bi-modal operation on both task and interrupt context. In other
118		- * word, programmer can call the \ref murasaki::Debug::printf member function from both context. This is quite
119		- * usuful to the debug code.
120	123	*
121	124	* There are several directory and files to use Murasaki class library.
122	125	*

		@@ -137,6 +140,12 @@
137	140	* included by other murasaki files. The proposed directory of this file is Inc.
138	141	*/
139	142
	143	+/**
	144	+ * \page murasaki_ug_usage Usage Introduction
	145	+ */
140	146
	147	+/**
	148	+ * \page murasaki_ug_configuration Configuration
	149	+ */
141	150
142	151	#endif /* MURASAKI_UG_HPP_ */