git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@716 35acf78f-673a-0410-8e92-d51de3d6d3f4

docs/ch.txt

@@ -88,7 +88,6 @@
 /**
  * @defgroup Kernel Kernel
  * @{
- * @file ch.h ChibiOS/RT main include file, it includes everything else.
  */
 /** @} */
 
@@ -97,7 +96,6 @@
  * @{
  * In @p chconf.h are defined the required subsystems for your application.
  * @ingroup Kernel
- * @file chconf.h ChibiOS/RT configuration file.
  */
 /** @} */
 
@@ -106,8 +104,6 @@
  * @{
  * Non portable code templates.
  * @ingroup Kernel
- * @file src/templates/chcore.c Non portable code template file.
- * @file src/templates/chcore.h Non portable macros and structures template file.
  */
 /** @} */
 
@@ -116,7 +112,6 @@
  * @{
  * System types and macros.
  * @ingroup Kernel
- * @file templates/chtypes.h System types and code modifiers.
  */
 /** @} */
 
@@ -126,8 +121,6 @@
  * Initialization, Locks, Interrupt Handling, Power Management, Abnormal
  * Termination.
  * @ingroup Kernel
- * @file sys.h System related macros and structures.
- * @file chsys.c System related code.
  */
 /** @} */
 
@@ -136,7 +129,6 @@
  * @{
  * System inline-able code.
  * @ingroup Kernel
- * @file inline.h Inline versions of some critical system routines.
  */
 /** @} */
 
@@ -145,8 +137,6 @@
  * @{
  * Debug APIs and procedures.
  * @ingroup Kernel
- * @file debug.h Debug macros and structures.
- * @file chdebug.c ChibiOS/RT Debug code.
  */
 /** @} */
 
@@ -155,8 +145,6 @@
  * @{
  * ChibiOS/RT scheduler.
  * @ingroup Kernel
- * @file chschd.c Scheduler code.
- * @file scheduler.h Scheduler macros and structures.
  */
 /** @} */
 
@@ -165,8 +153,6 @@
  * @{
  * ChibiOS/RT thread lists and queues utilities.
  * @ingroup Kernel
- * @file chlists.c Lists and queues code.
- * @file lists.h Lists and queues macros and structures.
  */
 /** @} */
 
@@ -174,8 +160,6 @@
  * @defgroup Threads Threads
  * @{
  * Threads creation and termination APIs.
- * @file threads.h Threads structures, macros and functions.
- * @file chthreads.c Threads code.
  */
 /** @} */
 
@@ -183,8 +167,6 @@
  * @defgroup Time Time and Virtual Timers
  * @{
  * Time and Virtual Timers related APIs.
- * @file include/vt.h Time macros and structures.
- * @file chvt.c Time functions.
  */
 /** @} */
 
@@ -201,8 +183,6 @@
  * instead of the system provided allocator.<br>
  * In order to use the heap APIs the @p CH_USE_HEAP option must be specified
  * in @p chconf.h.
- * @file include/heap.h Heap macros and structures.
- * @file chheap.c Heap functions.
  */
 /** @} */
 
@@ -215,8 +195,6 @@
  * <b>constant time</b> and reliably without memory fragmentation problems.<br>
  * In order to use the Time APIs the @p CH_USE_MEMPOOLS option must be
  * specified in @p chconf.h.
- * @file include/mempools.h Memory Pools macros and structures.
- * @file chmempools.c Memory Pools functions.
  */
 /** @} */
 
@@ -243,8 +221,6 @@
  * @p chconf.h.<br>
  * In order to use the Semaphores APIs the @p CH_USE_SEMAPHORES
  * option must be specified in @p chconf.h.<br><br>
- * @file semaphores.h Semaphores macros and structures.
- * @file chsem.c Semaphores code.
  */
 /** @} */
 
@@ -280,8 +256,6 @@
  * priority was not already equal or higher). The mechanism works with any
  * number of nested mutexes and any number of involved threads. The algorithm
  * complexity (worst case) is N with N equal to the number of nested mutexes.
- * @file mutexes.h Mutexes macros and structures.
- * @file chmtx.c Mutexes functions.
  */
 /** @} */
 
@@ -295,8 +269,6 @@
  * a Monitor construct.<br>
  * In order to use the Condition Variables APIs the @p CH_USE_CONDVARS
  * option must be specified in @p chconf.h.<br><br>
- * @file condvars.h Condition Variables macros and structures.
- * @file chcond.c Condition Variables code.
  */
 /** @} */
 
@@ -318,8 +290,6 @@
  * thread invokes a @p chEvtWaitXXX().<br>
  * In order to use the Event APIs the @p CH_USE_EVENTS option must be
  * specified in @p chconf.h.
- * @file events.h Events macros and structures.
- * @file chevents.c Events functions.
  */
 /** @} */
 
@@ -341,8 +311,6 @@
  * queue header).<br>
  * In order to use the Messages APIs the @p CH_USE_MESSAGES option must be
  * specified in @p chconf.h.
- * @file messages.h	Messages macros and structures.
- * @file chmsg.c Messages functions.
  */
 /** @} */
 
@@ -371,8 +339,6 @@
  * be specified in @p chconf.h.<br>
  * In order to use the half duplex queues the @p CH_USE_QUEUES_HALFDUPLEX
  * option must be specified in @p chconf.h.
- * @file queues.h I/O Queues macros and structures.
- * @file chqueues.c I/O Queues code.
  */
 /** @} */
 
@@ -389,8 +355,6 @@
  * @p CH_USE_SERIAL_FULLDUPLEX option must be specified in @p chconf.h.<br>
  * In order to use the serial half duplex driver the
  * @p CH_USE_SERIAL_HALFDUPLEX option must be specified in @p chconf.h.
- * @file serial.h Serial Drivers macros and structures.
- * @file chserial.c Serial Drivers code.
  */
 /** @} */
 
@@ -415,8 +379,6 @@
  * from C++ as classes and objects rather the traditional "C" APIs.
  *
  * @ingroup utilities_library
- * @file ch.hpp C++ wrapper classes and definitions.
- * @file ch.cpp C++ wrapper code.
  */
 /** @} */
 
@@ -429,8 +391,6 @@
  * Multiple threads can listen to the same timer.
  *
  * @ingroup utilities_library
- * @file evtimer.c Events Generator Timer code.
- * @file evtimer.h Events Generator Timer structures and macros.
  */
 /** @} */
 

readme.txt

@@ -73,6 +73,12 @@ Win32-MinGW            - ChibiOS/RT simulator and demo into a WIN32 process,
 *****************************************************************************
 
 *** 1.1.0unstable ***
+- FIX: Modified the default value for the STM32 HSI setup it was 1, it should
+  be 0x10 (backport in stable branch).
+- FIX: Removed an obsolete constant (P_SUSPENDED) from thread.h (backport in
+  stable branch).
+- FIX: Removed unused field mp_grow in the MemoryPool structure  (backport in
+  stable branch).
 - NEW: Better separation between the port code and the system APIs, now an
   architecture-specific "driver" contains all the port related code.
   Port functions/macros are no more directly exposed as APIs to the user code.
@@ -114,12 +120,6 @@ Win32-MinGW            - ChibiOS/RT simulator and demo into a WIN32 process,
   info they add and the size of all the images. It is possible to configure
   Doxygen to have them again (and more graph types).
 
-*** 1.0.1 ***
-- FIX: Modified the default value for the STM32 HSI setup it was 1, it should
-  be 0x10.
-- FIX: Removed an obsolete constant (P_SUSPENDED) from thread.h.
-- FIX: Removed unused field mp_grow in the MemoryPool structure.
-
 *** 1.0.0 ***
 - License switch, added GPL exception, see exception.txt.
 - Full test cycle and test reports updated.

src/chcond.c

@@ -22,6 +22,8 @@
  */
 
 /**
+ * @file chcond.c
+ * @brief Condition Variables code.
  * @addtogroup CondVars
  * @{
  */

src/chdebug.c

@@ -17,6 +17,13 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file chdebug.c
+ * @brief ChibiOS/RT Debug code.
+ * @addtogroup CondVars
+ * @{
+ */
+
 #include <ch.h>
 
 #ifdef CH_USE_DEBUG
@@ -72,3 +79,5 @@ void chDbgTrace(Thread *otp, Thread *ntp) {
 #endif /* CH_USE_TRACE */
 
 #endif /* CH_USE_DEBUG */
+
+/** @} */

src/chevents.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chevents.c
+ * @brief Events code.
  * @addtogroup Events
  * @{
  */

src/chheap.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chheap.c
+ * @brief Heap code.
  * @addtogroup Heap
  * @{
  */

src/chlists.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chlists.c
+ * @brief Lists and queues code.
  * @addtogroup ThreadLists
  * @{
  */

src/chmempools.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chmempools.c
+ * @brief Memory Pools code.
  * @addtogroup MemoryPools
  * @{
  */

src/chmsg.c

@@ -18,9 +18,12 @@
 */
 
 /**
+ * @file chmsg.c
+ * @brief Messages code.
  * @addtogroup Messages
  * @{
  */
+
 #include <ch.h>
 
 #ifdef CH_USE_MESSAGES

src/chmtx.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chmtx.c
+ * @brief Mutexes code.
  * @addtogroup Mutexes
  * @{
  */

src/chqueues.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chqueues.c
+ * @brief I/O Queues code.
  * @addtogroup IOQueues
  * @{
  */

src/chschd.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chschd.c
+ * @brief Scheduler code.
  * @addtogroup Scheduler
  * @{
  */

src/chsem.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chsem.c
+ * @brief Semaphores code.
  * @addtogroup Semaphores
  * @{
  */

src/chserial.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chserial.c
+ * @brief Serial Drivers code.
  * @addtogroup Serial
  * @{
  */

src/chsys.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chsys.c
+ * @brief System related code.
  * @addtogroup System
  * @{
  */

src/chthreads.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chthreads.c
+ * @brief Threads code.
  * @addtogroup Threads
  * @{
  */

src/chvt.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file chvt.c
+ * @brief Time related code.
  * @addtogroup Time
  * @{
  */

src/include/ch.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file ch.h
+ * @brief ChibiOS/RT main include file, it includes everything else.
  * @addtogroup Kernel
  * @{
  */

src/include/condvars.h

@@ -22,6 +22,8 @@
  */
 
 /**
+ * @file condvars.h
+ * @brief Condition Variables macros and structures.
  * @addtogroup CondVars
  * @{
  */

src/include/debug.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file debug.h
+ * @brief Debug macros and structures.
  * @addtogroup Debug
  * @{
  */

src/include/events.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file events.h
+ * @brief Events macros and structures.
  * @addtogroup Events
  * @{
  */

src/include/heap.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file heap.h
+ * @brief Heap macros and structures.
  * @addtogroup Heap
  * @{
  */

src/include/inline.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file inline.h
+ * @brief Inline versions of some critical system routines.
  * @addtogroup Inline
  * @{
  */

src/include/lists.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file lists.h
+ * @brief Lists and queues macros and structures.
  * @addtogroup ThreadLists
  * @{
  */

src/include/mempools.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file mempools.h
+ * @brief Memory Pools macros and structures.
  * @addtogroup MemoryPools
  * @{
  */

src/include/messages.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file messages.h
+ * @brief Messages macros and structures.
  * @addtogroup Messages
  * @{
  */

src/include/mutexes.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file mutexes.h
+ * @brief Mutexes macros and structures.
  * @addtogroup Mutexes
  * @{
  */

src/include/queues.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file queues.h I/O
+ * @brief Queues macros and structures.
  * @addtogroup IOQueues
  * @{
  */

src/include/scheduler.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file scheduler.h
+ * @brief Scheduler macros and structures.
  * @addtogroup Scheduler
  * @{
  */

src/include/semaphores.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file semaphores.h
+ * @brief Semaphores macros and structures.
  * @addtogroup Semaphores
  * @{
  */

src/include/serial.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file serial.h
+ * @brief Serial Drivers macros and structures.
  * @addtogroup Serial
  * @{
  */

src/include/sys.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file sys.h
+ * @brief System related macros and structures.
  * @addtogroup System
  * @{
  */

src/include/threads.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file threads.h
+ * @brief Threads macros and structures.
  * @addtogroup Threads
  * @{
  */

src/include/vt.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file vt.h
+ * @brief Time macros and structures.
  * @addtogroup Time
  * @{
  */

src/lib/ch.cpp

@@ -16,6 +16,12 @@
     You should have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
+/**
+ * @file ch.cpp
+ * @brief C++ wrapper code.
+ * @addtogroup CPlusPlusLibrary
+ * @{
+ */
 
 #include <ch.hpp>
 
@@ -329,3 +335,5 @@ namespace chibios_rt {
 #endif /* CH_USE_EVENTS_TIMEOUT */
 #endif /* CH_USE_EVENTS */
 }
+
+/** @} */

src/lib/ch.hpp

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file ch.hpp
+ * @brief C++ wrapper classes and definitions.
  * @addtogroup CPlusPlusLibrary
  * @{
  */

src/lib/evtimer.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file evtimer.c
+ * @brief Events Generator Timer code.
  * @addtogroup event_timer
  * @{
  */

src/lib/evtimer.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file evtimer.h
+ * @brief Events Generator Timer structures and macros.
  * @addtogroup event_timer
  * @{
  */

src/templates/chconf.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file src/templates/chconf.h
+ * @brief Configuration file template.
  * @addtogroup Config
  * @{
  */

src/templates/chcore.c

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file src/templates/chcore.c
+ * @brief Port related template code.
  * @addtogroup Core
  * @{
  */

src/templates/chcore.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file src/templates/chcore.h
+ * @brief Port related template macros and structures.
  * @addtogroup Core
  * @{
  */

src/templates/chtypes.h

@@ -18,6 +18,8 @@
 */
 
 /**
+ * @file src/templates/chtypes.h
+ * @brief System types template.
  * @addtogroup Types
  * @{
  */