Documentation-related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@13427 27425a3e-05d8-49a3-a47f-9c15f0e5edd8
2020-03-15 13:51:47 +00:00 · 2020-03-15 13:51:47 +00:00 · bb1c6aba63
parent 6efb153e11
commit bb1c6aba63
56 changed files with 58 additions and 59 deletions
--- a/doc/full_rm/Doxyfile_html
+++ b/doc/full_rm/Doxyfile_html
@ -803,16 +803,15 @@ INPUT                  = ./src \
                         ../../os/hal/dox \
                         ../../os/hal/src \
                         ../../os/hal/include \
-                         ../../os/hal/lib/peripherals/flash \
-                         ../../os/hal/lib/peripherals/sensors \
                         ../../os/hal/lib/streams \
                         ../../os/hal/lib/complex/mfs \
                         ../../os/hal/lib/complex/serial_nor \
                         ../../os/hal/templates \
                         ../../os/hal/templates/osal \
                         ../../os/ex/dox \
-                         ../../os/ex/Bosch \
-                         ../../os/ex/ST
+                         ../../os/ex/devices/Bosch \
+                         ../../os/ex/devices/ST \
+                         ../../os/ex/include

 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
--- a/os/oslib/include/chbsem.h
+++ b/os/oslib/include/chbsem.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chbsem.h
+ * @file    oslib/include/chbsem.h
 * @brief   Binary semaphores structures and macros.
 * @details Binary semaphores related APIs and services.
 *          <h2>Operation mode</h2>
--- a/os/oslib/include/chdelegates.h
+++ b/os/oslib/include/chdelegates.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chdelegates.h
+ * @file    oslib/include/chdelegates.h
 * @brief   Delegate threads macros and structures.
 *
 * @addtogroup oslib_delegates
--- a/os/oslib/include/chfactory.h
+++ b/os/oslib/include/chfactory.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chfactory.h
+ * @file    oslib/include/chfactory.h
 * @brief   ChibiOS objects factory structures and macros.
 *
 * @addtogroup oslib_objects_factory
--- a/os/oslib/include/chjobs.h
+++ b/os/oslib/include/chjobs.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chjobs.h
+ * @file    oslib/include/chjobs.h
 * @brief   Jobs Queues structures and macros.
 * @details This module implements queues of generic jobs to be delegated
 *          asynchronously to a pool of dedicated threads.
--- a/os/oslib/include/chlib.h
+++ b/os/oslib/include/chlib.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chlib.h
+ * @file    oslib/include/chlib.h
 * @brief   ChibiOS/LIB main include file.
 * @details This header includes all the required library headers. This file
 *          is meant do be included by @p ch.h not directly by user.
--- a/os/oslib/include/chmboxes.h
+++ b/os/oslib/include/chmboxes.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmboxes.h
+ * @file    oslib/include/chmboxes.h
 * @brief   Mailboxes macros and structures.
 *
 * @addtogroup oslib_mailboxes
--- a/os/oslib/include/chmemcore.h
+++ b/os/oslib/include/chmemcore.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmemcore.h
+ * @file    oslib/include/chmemcore.h
 * @brief   Core memory manager macros and structures.
 *
 * @addtogroup oslib_memcore
--- a/os/oslib/include/chmemheaps.h
+++ b/os/oslib/include/chmemheaps.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmemheaps.h
+ * @file    oslib/include/chmemheaps.h
 * @brief   Memory heaps macros and structures.
 *
 * @addtogroup oslib_memheaps
--- a/os/oslib/include/chmempools.h
+++ b/os/oslib/include/chmempools.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmempools.h
+ * @file    oslib/include/chmempools.h
 * @brief   Memory Pools macros and structures.
 *
 * @addtogroup oslib_mempools
--- a/os/oslib/include/chobjcaches.h
+++ b/os/oslib/include/chobjcaches.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chobjcaches.h
+ * @file    oslib/include/chobjcaches.h
 * @brief   Objects Caches macros and structures.
 *
 * @addtogroup oslib_objchaches
--- a/os/oslib/include/chobjfifos.h
+++ b/os/oslib/include/chobjfifos.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chobjfifos.h
+ * @file    oslib/include/chobjfifos.h
 * @brief   Objects FIFO structures and macros.
 * @details This module implements a generic FIFO queue of objects by
 *          coupling a Guarded Memory Pool (for objects storage) and
--- a/os/oslib/include/chpipes.h
+++ b/os/oslib/include/chpipes.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chpipes.h
+ * @file    oslib/include/chpipes.h
 * @brief   Pipes macros and structures.
 *
 * @addtogroup oslib_pipes
--- a/os/oslib/src/chdelegates.c
+++ b/os/oslib/src/chdelegates.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chdelegates.c
+ * @file    oslib/src/chdelegates.c
 * @brief   Delegate threads code.
 * @details Delegate threads.
 *          <h2>Operation mode</h2>
--- a/os/oslib/src/chfactory.c
+++ b/os/oslib/src/chfactory.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chfactory.c
+ * @file    oslib/src/chfactory.c
 * @brief   ChibiOS objects factory and registry code.
 *
 * @addtogroup oslib_objects_factory
--- a/os/oslib/src/chmboxes.c
+++ b/os/oslib/src/chmboxes.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmboxes.c
+ * @file    oslib/src/chmboxes.c
 * @brief   Mailboxes code.
 *
 * @addtogroup oslib_mailboxes
--- a/os/oslib/src/chmemcore.c
+++ b/os/oslib/src/chmemcore.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmemcore.c
+ * @file    oslib/src/chmemcore.c
 * @brief   Core memory manager code.
 *
 * @addtogroup oslib_memcore
--- a/os/oslib/src/chmemheaps.c
+++ b/os/oslib/src/chmemheaps.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmemheaps.c
+ * @file    oslib/src/chmemheaps.c
 * @brief   Memory heaps code.
 *
 * @addtogroup oslib_memheaps
--- a/os/oslib/src/chmempools.c
+++ b/os/oslib/src/chmempools.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmempools.c
+ * @file    oslib/src/chmempools.c
 * @brief   Memory Pools code.
 *
 * @addtogroup oslib_mempools
--- a/os/oslib/src/chobjcaches.c
+++ b/os/oslib/src/chobjcaches.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chobjcaches.c
+ * @file    oslib/src/chobjcaches.c
 * @brief   Objects Caches code.
 * @details Objects caches.
 *          <h2>Operation mode</h2>
--- a/os/oslib/src/chpipes.c
+++ b/os/oslib/src/chpipes.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chpipes.c
+ * @file    oslib/src/chpipes.c
 * @brief   Pipes code.
 * @details Byte pipes.
 *          <h2>Operation mode</h2>
--- a/os/rt/include/chalign.h
+++ b/os/rt/include/chalign.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chalign.h
+ * @file    rt/include/chalign.h
 * @brief   Memory alignment macros and structures.
 *
 * @addtogroup mem
--- a/os/rt/include/chchecks.h
+++ b/os/rt/include/chchecks.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chchecks.h
+ * @file    rt/include/chchecks.h
 * @brief   Configuration file checks header.
 *
 * @addtogroup conf_checks
--- a/os/rt/include/chcond.h
+++ b/os/rt/include/chcond.h
@ -21,7 +21,7 @@
 */

 /**
- * @file    chcond.h
+ * @file    rt/include/chcond.h
 * @brief   Condition Variables macros and structures.
 *
 * @addtogroup condvars
--- a/os/rt/include/chdebug.h
+++ b/os/rt/include/chdebug.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chdebug.h
+ * @file    rt/include/chdebug.h
 * @brief   Debug support macros and structures.
 *
 * @addtogroup checks_assertions
--- a/os/rt/include/chdynamic.h
+++ b/os/rt/include/chdynamic.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chdynamic.h
+ * @file    rt/include/chdynamic.h
 * @brief   Dynamic threads macros and structures.
 *
 * @addtogroup dynamic_threads
--- a/os/rt/include/chevents.h
+++ b/os/rt/include/chevents.h
@ -21,7 +21,7 @@
 */

 /**
- * @file    chevents.h
+ * @file    rt/include/chevents.h
 * @brief   Events macros and structures.
 *
 * @addtogroup events
--- a/os/rt/include/chmsg.h
+++ b/os/rt/include/chmsg.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmsg.h
+ * @file    rt/include/chmsg.h
 * @brief   Messages macros and structures.
 *
 * @addtogroup messages
--- a/os/rt/include/chmtx.h
+++ b/os/rt/include/chmtx.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmtx.h
+ * @file    rt/include/chmtx.h
 * @brief   Mutexes macros and structures.
 *
 * @addtogroup mutexes
--- a/os/rt/include/chregistry.h
+++ b/os/rt/include/chregistry.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chregistry.h
+ * @file    rt/include/chregistry.h
 * @brief   Threads registry macros and structures.
 *
 * @addtogroup registry
--- a/os/rt/include/chrestrictions.h
+++ b/os/rt/include/chrestrictions.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chrestrictions.h
+ * @file    rt/include/chrestrictions.h
 * @brief   Licensing restrictions header.
 *
 * @addtogroup rt_restrictions
--- a/os/rt/include/chschd.h
+++ b/os/rt/include/chschd.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chschd.h
+ * @file    rt/include/chschd.h
 * @brief   Scheduler macros and structures.
 *
 * @addtogroup scheduler
--- a/os/rt/include/chsem.h
+++ b/os/rt/include/chsem.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chsem.h
+ * @file    rt/include/chsem.h
 * @brief   Semaphores macros and structures.
 *
 * @addtogroup semaphores
--- a/os/rt/include/chstats.h
+++ b/os/rt/include/chstats.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chstats.h
+ * @file    rt/include/chstats.h
 * @brief   Statistics module macros and structures.
 *
 * @addtogroup statistics
--- a/os/rt/include/chsys.h
+++ b/os/rt/include/chsys.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chsys.h
+ * @file    rt/include/chsys.h
 * @brief   System related macros and structures.
 *
 * @addtogroup system
--- a/os/rt/include/chsystypes.h
+++ b/os/rt/include/chsystypes.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chsystypes.h
+ * @file    rt/include/chsystypes.h
 * @brief   System types header.
 *
 * @addtogroup scheduler
--- a/os/rt/include/chthreads.h
+++ b/os/rt/include/chthreads.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chthreads.h
+ * @file    rt/include/chthreads.h
 * @brief   Threads module macros and structures.
 *
 * @addtogroup threads
--- a/os/rt/include/chtime.h
+++ b/os/rt/include/chtime.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chtime.h
+ * @file    rt/include/chtime.h
 * @brief   Time and intervals macros and structures.
 *
 * @addtogroup time_intervals
--- a/os/rt/include/chtm.h
+++ b/os/rt/include/chtm.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chtm.h
+ * @file    rt/include/chtm.h
 * @brief   Time Measurement module macros and structures.
 *
 * @addtogroup time_measurement
--- a/os/rt/include/chtrace.h
+++ b/os/rt/include/chtrace.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chtrace.h
+ * @file    rt/include/chtrace.h
 * @brief   Tracer macros and structures.
 *
 * @addtogroup trace
--- a/os/rt/include/chvt.h
+++ b/os/rt/include/chvt.h
@ -18,7 +18,7 @@
 */

 /**
- * @file    chvt.h
+ * @file    rt/include/chvt.h
 * @brief   Time and Virtual Timers module macros and structures.
 *
 * @addtogroup time
--- a/os/rt/src/chcond.c
+++ b/os/rt/src/chcond.c
@ -21,7 +21,7 @@
 */

 /**
- * @file    chcond.c
+ * @file    rt/src/chcond.c
 * @brief   Condition Variables code.
 *
 * @addtogroup condvars
--- a/os/rt/src/chdebug.c
+++ b/os/rt/src/chdebug.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chdebug.c
+ * @file    rt/src/chdebug.c
 * @brief   Debug support code.
 *
 * @addtogroup checks_assertions
--- a/os/rt/src/chdynamic.c
+++ b/os/rt/src/chdynamic.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chdynamic.c
+ * @file    rt/src/chdynamic.c
 * @brief   Dynamic threads code.
 *
 * @addtogroup dynamic_threads
--- a/os/rt/src/chevents.c
+++ b/os/rt/src/chevents.c
@ -21,7 +21,7 @@
 */

 /**
- * @file    chevents.c
+ * @file    rt/src/chevents.c
 * @brief   Events code.
 *
 * @addtogroup events
--- a/os/rt/src/chmsg.c
+++ b/os/rt/src/chmsg.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmsg.c
+ * @file    rt/src/chmsg.c
 * @brief   Messages code.
 *
 * @addtogroup messages
--- a/os/rt/src/chmtx.c
+++ b/os/rt/src/chmtx.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chmtx.c
+ * @file    rt/src/chmtx.c
 * @brief   Mutexes code.
 *
 * @addtogroup mutexes
--- a/os/rt/src/chregistry.c
+++ b/os/rt/src/chregistry.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chregistry.c
+ * @file    rt/src/chregistry.c
 * @brief   Threads registry code.
 *
 * @addtogroup registry
--- a/os/rt/src/chschd.c
+++ b/os/rt/src/chschd.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chschd.c
+ * @file    rt/src/chschd.c
 * @brief   Scheduler code.
 *
 * @addtogroup scheduler
--- a/os/rt/src/chsem.c
+++ b/os/rt/src/chsem.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chsem.c
+ * @file    rt/src/chsem.c
 * @brief   Semaphores code.
 *
 * @addtogroup semaphores
--- a/os/rt/src/chstats.c
+++ b/os/rt/src/chstats.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chstats.c
+ * @file    rt/src/chstats.c
 * @brief   Statistics module code.
 *
 * @addtogroup statistics
--- a/os/rt/src/chsys.c
+++ b/os/rt/src/chsys.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chsys.c
+ * @file    rt/src/chsys.c
 * @brief   System related code.
 *
 * @addtogroup system
--- a/os/rt/src/chthreads.c
+++ b/os/rt/src/chthreads.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chthreads.c
+ * @file    rt/src/chthreads.c
 * @brief   Threads code.
 *
 * @addtogroup threads
--- a/os/rt/src/chtm.c
+++ b/os/rt/src/chtm.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chtm.c
+ * @file    rt/src/chtm.c
 * @brief   Time Measurement module code.
 *
 * @addtogroup time_measurement
--- a/os/rt/src/chtrace.c
+++ b/os/rt/src/chtrace.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chtrace.c
+ * @file    rt/src/chtrace.c
 * @brief   Tracer code.
 *
 * @addtogroup trace
--- a/os/rt/src/chvt.c
+++ b/os/rt/src/chvt.c
@ -18,7 +18,7 @@
 */

 /**
- * @file    chvt.c
+ * @file    rt/src/chvt.c
 * @brief   Time and Virtual Timers module code.
 *
 * @addtogroup time