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

Documentation-related fixes. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@14541 27425a3e-05d8-49a3-a47f-9c15f0e5edd8
This commit is contained in:
Giovanni Di Sirio 2021-06-13 08:47:53 +00:00
parent 606a4c3b59
commit b0db601343
13 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/full_rm/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 20.3.0 PROJECT_NUMBER = 21.6.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
doc/hal/Doxyfile_chm
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/HAL
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 7.1.0 PROJECT_NUMBER = 7.2.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
doc/hal/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/HAL
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 7.1.0 PROJECT_NUMBER = 7.2.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
doc/nil/Doxyfile_chm
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/NIL
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 4.0.0 PROJECT_NUMBER = 4.1.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
doc/nil/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/NIL
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 4.0.0 PROJECT_NUMBER = 4.1.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
doc/rt/Doxyfile_chm
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/RT
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 6.1.0 PROJECT_NUMBER = 7.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
doc/rt/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/RT
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 6.1.0 PROJECT_NUMBER = 7.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a

2
os/common/ports/templates/chcore.c
View File

@ -21,7 +21,7 @@
* @file templates/chcore.c * @file templates/chcore.c
* @brief Port related template code. * @brief Port related template code.
* *
* @addtogroup TEMPLATE_CORE * @addtogroup port_core
* @details Non portable code templates. * @details Non portable code templates.
* @{ * @{
*/ */

2
os/common/ports/templates/chcore.h
View File

@ -23,7 +23,7 @@
* @details This file is a template of the system driver macros provided by * @details This file is a template of the system driver macros provided by
* a port. * a port.
* *
* @addtogroup TEMPLATE_CORE * @addtogroup port_core
* @{ * @{
*/ */

2
os/common/ports/templates/chtypes.h
View File

@ -21,7 +21,7 @@
* @file templates/chtypes.h * @file templates/chtypes.h
* @brief Template port system types. * @brief Template port system types.
* *
* @addtogroup TEMPLATE_CORE * @addtogroup port_types
* @{ * @{
*/ */

11
os/hal/dox/hal_interfaces.dox
View File

@ -54,7 +54,18 @@
* @ingroup HAL_INTERFACES * @ingroup HAL_INTERFACES
*/ */
/**
* @defgroup HAL_BUFFERED_STREAMS Buffered Streams Class
* @ingroup HAL_INTERFACES
*/
/** /**
* @defgroup HAL_CHPRINTF Output Formatter Utility * @defgroup HAL_CHPRINTF Output Formatter Utility
* @ingroup HAL_INTERFACES * @ingroup HAL_INTERFACES
*/ */
/**
* @defgroup HAL_CHSCANF Input Formatter Utility
* @ingroup HAL_INTERFACES
*/

4
os/nil/include/ch.h
View File

@ -80,7 +80,7 @@
* @note It is meant to be used in configuration files as switch. * @note It is meant to be used in configuration files as switch.
*/ */
#if !defined(FALSE) || defined(__DOXYGEN__) #if !defined(FALSE) || defined(__DOXYGEN__)
#define FALSE 0 #define FALSE 0
#endif #endif
/** /**
@ -88,7 +88,7 @@
* @note It is meant to be used in configuration files as switch. * @note It is meant to be used in configuration files as switch.
*/ */
#if !defined(TRUE) || defined(__DOXYGEN__) #if !defined(TRUE) || defined(__DOXYGEN__)
#define TRUE 1 #define TRUE 1
#endif #endif
/** @} */ /** @} */

9
os/rt/dox/rt.dox
View File

@ -59,12 +59,12 @@
*/ */
/** /**
* @defgroup instances OS Instances * @defgroup os_structures OS Types and Structures
* @ingroup os * @ingroup os
*/ */
/** /**
* @defgroup system System Management * @defgroup instances OS Instances
* @ingroup os * @ingroup os
*/ */
@ -88,6 +88,11 @@
* @ingroup kernel * @ingroup kernel
*/ */
/**
* @defgroup system System Management
* @ingroup base
*/
/** /**
* @defgroup mem Memory Alignment * @defgroup mem Memory Alignment
* @ingroup base * @ingroup base