andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation cleanup, not finished. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12567 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
Giovanni Di Sirio 2019-01-20 16:23:16 +00:00
parent e15fc5236b
commit ac1e9f31ce
13 changed files with 21 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/hal/Doxyfile_chm
View File

@ -792,7 +792,9 @@ INPUT = ./src \
../../os/hal/include \ ../../os/hal/include \
../../os/hal/lib/peripherals/flash \ ../../os/hal/lib/peripherals/flash \
../../os/hal/lib/peripherals/sensors \ ../../os/hal/lib/peripherals/sensors \
../../os/hal/lib/streams \
../../os/hal/lib/complex/mfs \ ../../os/hal/lib/complex/mfs \
../../os/hal/lib/complex/serial_nor \
../../os/hal/templates \ ../../os/hal/templates \
../../os/hal/templates/osal ../../os/hal/templates/osal

2
doc/hal/Doxyfile_html
View File

@ -792,7 +792,9 @@ INPUT = ./src \
../../os/hal/include \ ../../os/hal/include \
../../os/hal/lib/peripherals/flash \ ../../os/hal/lib/peripherals/flash \
../../os/hal/lib/peripherals/sensors \ ../../os/hal/lib/peripherals/sensors \
../../os/hal/lib/streams \
../../os/hal/lib/complex/mfs \ ../../os/hal/lib/complex/mfs \
../../os/hal/lib/complex/serial_nor \
../../os/hal/templates \ ../../os/hal/templates \
../../os/hal/templates/osal ../../os/hal/templates/osal

4
os/hal/dox/flash.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_FLASH Generic Flash Driver Interface * @defgroup HAL_FLASH Generic NOR Flash Interface
* @brief HAL Generic Flash Driver Interface. * @brief HAL Generic NOR Flash Driver Interface.
* *
* @ingroup HAL_ABSTRACT_PERIPHERALS * @ingroup HAL_ABSTRACT_PERIPHERALS
*/ */

4
os/hal/dox/hal_peripherals.dox
View File

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_ABSTRACT_PERIPHERALS Abstract Peripheral Interfaces * @defgroup HAL_ABSTRACT_PERIPHERALS Peripheral Interfaces
* @brief HAL Abstract Peripheral Interfaces. * @brief HAL Abstract Peripheral Interfaces.
* *
* @ingroup HAL_INTERFACES * @ingroup IO
*/ */

2
os/hal/dox/mfs.dox
View File

@ -15,7 +15,7 @@
*/ */
/** /**
* @defgroup MFS Managed Flash Storage Driver * @defgroup HAL_MFS Managed Flash Storage Driver
* @brief Managed Flash Storage Driver. * @brief Managed Flash Storage Driver.
* @details This module implements a managed flash storage able to store * @details This module implements a managed flash storage able to store
* a finite number of variable-size records. Records are retrieved * a finite number of variable-size records. Records are retrieved

27
os/hal/dox/norflash.dox
View File

@ -15,9 +15,10 @@
*/ */
/** /**
* @defgroup NOR_FLASH Abstract NOR Flash Class * @defgroup HAL_SERIAL_NOR Serial NOR Flash Driver
* @brief Generic NOR Flash interface. * @brief Serial NOR Flash driver.
* @details This module implements a generic class for NOR Flash devices. * @details This module implements a generic driver for serial NOR Flash
* devices.
* *
* @section flash_1 Driver State Machine * @section flash_1 Driver State Machine
* The flash driver implements a state machine internally, not all the driver * The flash driver implements a state machine internally, not all the driver
@ -53,23 +54,5 @@
} }
* @enddot * @enddot
* *
* @section flash_2 Flash Operations. * @ingroup HAL_COMPLEX_DRIVERS
* This driver abstracts a generic PWM timer composed of:
* - A clock prescaler.
* - A main up counter.
* - A comparator register that resets the main counter to zero when the limit
* is reached. An optional callback can be generated when this happens.
* - An array of @p PWM_CHANNELS PWM channels, each channel has an output,
* a comparator and is able to invoke an optional callback when a comparator
* match with the main counter happens.
* .
* A PWM channel output can be in two different states:
* - <b>IDLE</b>, when the channel is disabled or after a match occurred.
* - <b>ACTIVE</b>, when the channel is enabled and a match didn't occur yet
* in the current PWM cycle.
* .
* Note that the two states can be associated to both logical zero or one in
* the @p PWMChannelConfig structure.
*
* @ingroup HAL_INTERFACES
*/ */

2
os/hal/lib/complex/serial_nor/hal_serial_nor.h
View File

@ -18,7 +18,7 @@
* @file serial_nor.h * @file serial_nor.h
* @brief Serial NOR driver header. * @brief Serial NOR driver header.
* *
* @addtogroup SERIAL_NOR * @addtogroup HAL_SERIAL_NOR
* @{ * @{
*/ */

2
os/hal/lib/streams/chprintf.c
View File

@ -23,7 +23,7 @@
* @file chprintf.c * @file chprintf.c
* @brief Mini printf-like functionality. * @brief Mini printf-like functionality.
* *
* @addtogroup chprintf * @addtogroup HAL_CHPRINTF
* @{ * @{
*/ */

2
os/hal/lib/streams/chprintf.h
View File

@ -18,7 +18,7 @@
* @file chprintf.h * @file chprintf.h
* @brief Mini printf-like functionality. * @brief Mini printf-like functionality.
* *
* @addtogroup chprintf * @addtogroup HAL_CHPRINTF
* @{ * @{
*/ */

2
os/hal/lib/streams/memstreams.c
View File

@ -18,7 +18,7 @@
* @file memstreams.c * @file memstreams.c
* @brief Memory streams code. * @brief Memory streams code.
* *
* @addtogroup memory_streams * @addtogroup HAL_MEMORY_STREAMS
* @{ * @{
*/ */

2
os/hal/lib/streams/memstreams.h
View File

@ -18,7 +18,7 @@
* @file memstreams.h * @file memstreams.h
* @brief Memory streams structures and macros. * @brief Memory streams structures and macros.
* @addtogroup memory_streams * @addtogroup HAL_MEMORY_STREAMS
* @{ * @{
*/ */

2
os/hal/lib/streams/nullstreams.c
View File

@ -18,7 +18,7 @@
* @file nullstreams.c * @file nullstreams.c
* @brief Null streams code. * @brief Null streams code.
* *
* @addtogroup null_streams * @addtogroup HAL_NULL_STREAMS
* @{ * @{
*/ */

2
os/hal/lib/streams/nullstreams.h
View File

@ -18,7 +18,7 @@
* @file nullstreams.h * @file nullstreams.h
* @brief Null streams structures and macros. * @brief Null streams structures and macros.
* @addtogroup null_streams * @addtogroup HAL_NULL_STREAMS
* @{ * @{
*/ */