Documentation-related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@13427 27425a3e-05d8-49a3-a47f-9c15f0e5edd8
This commit is contained in:
Giovanni Di Sirio 2020-03-15 13:51:47 +00:00
parent 6efb153e11
commit bb1c6aba63
56 changed files with 58 additions and 59 deletions

View File

@ -803,16 +803,15 @@ INPUT = ./src \
../../os/hal/dox \ ../../os/hal/dox \
../../os/hal/src \ ../../os/hal/src \
../../os/hal/include \ ../../os/hal/include \
../../os/hal/lib/peripherals/flash \
../../os/hal/lib/peripherals/sensors \
../../os/hal/lib/streams \ ../../os/hal/lib/streams \
../../os/hal/lib/complex/mfs \ ../../os/hal/lib/complex/mfs \
../../os/hal/lib/complex/serial_nor \ ../../os/hal/lib/complex/serial_nor \
../../os/hal/templates \ ../../os/hal/templates \
../../os/hal/templates/osal \ ../../os/hal/templates/osal \
../../os/ex/dox \ ../../os/ex/dox \
../../os/ex/Bosch \ ../../os/ex/devices/Bosch \
../../os/ex/ST ../../os/ex/devices/ST \
../../os/ex/include
# This tag can be used to specify the character encoding of the source files # 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 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

View File

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

View File

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

View File

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

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chlib.h * @file oslib/include/chlib.h
* @brief ChibiOS/LIB main include file. * @brief ChibiOS/LIB main include file.
* @details This header includes all the required library headers. This 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. * is meant do be included by @p ch.h not directly by user.

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chpipes.h * @file oslib/include/chpipes.h
* @brief Pipes macros and structures. * @brief Pipes macros and structures.
* *
* @addtogroup oslib_pipes * @addtogroup oslib_pipes

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chpipes.c * @file oslib/src/chpipes.c
* @brief Pipes code. * @brief Pipes code.
* @details Byte pipes. * @details Byte pipes.
* <h2>Operation mode</h2> * <h2>Operation mode</h2>

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chchecks.h * @file rt/include/chchecks.h
* @brief Configuration file checks header. * @brief Configuration file checks header.
* *
* @addtogroup conf_checks * @addtogroup conf_checks

View File

@ -21,7 +21,7 @@
*/ */
/** /**
* @file chcond.h * @file rt/include/chcond.h
* @brief Condition Variables macros and structures. * @brief Condition Variables macros and structures.
* *
* @addtogroup condvars * @addtogroup condvars

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chdynamic.h * @file rt/include/chdynamic.h
* @brief Dynamic threads macros and structures. * @brief Dynamic threads macros and structures.
* *
* @addtogroup dynamic_threads * @addtogroup dynamic_threads

View File

@ -21,7 +21,7 @@
*/ */
/** /**
* @file chevents.h * @file rt/include/chevents.h
* @brief Events macros and structures. * @brief Events macros and structures.
* *
* @addtogroup events * @addtogroup events

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chvt.h * @file rt/include/chvt.h
* @brief Time and Virtual Timers module macros and structures. * @brief Time and Virtual Timers module macros and structures.
* *
* @addtogroup time * @addtogroup time

View File

@ -21,7 +21,7 @@
*/ */
/** /**
* @file chcond.c * @file rt/src/chcond.c
* @brief Condition Variables code. * @brief Condition Variables code.
* *
* @addtogroup condvars * @addtogroup condvars

View File

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

View File

@ -18,7 +18,7 @@
*/ */
/** /**
* @file chdynamic.c * @file rt/src/chdynamic.c
* @brief Dynamic threads code. * @brief Dynamic threads code.
* *
* @addtogroup dynamic_threads * @addtogroup dynamic_threads

View File

@ -21,7 +21,7 @@
*/ */
/** /**
* @file chevents.c * @file rt/src/chevents.c
* @brief Events code. * @brief Events code.
* *
* @addtogroup events * @addtogroup events

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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

View File

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