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@13428 27425a3e-05d8-49a3-a47f-9c15f0e5edd8
This commit is contained in:
Giovanni Di Sirio 2020-03-15 16:42:38 +00:00
parent bb1c6aba63
commit 3dc0a9f88c
17 changed files with 98 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/ex/Doxyfile_chm
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/EX
# 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 = 1.1.0 PROJECT_NUMBER = 1.1.1
# 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/ex/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = ChibiOS/EX
# 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 = 1.1.0 PROJECT_NUMBER = 1.1.1
# 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/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 = 0.0.0 PROJECT_NUMBER = 20.3.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-stm32f3/Doxyfile_html
View File

@ -38,7 +38,7 @@ PROJECT_NAME = "ChibiOS/HAL for STM32F3xx"
# 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 = 5.0.0 PROJECT_NUMBER = 7.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/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.0.0 PROJECT_NUMBER = 7.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/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.0.0 PROJECT_NUMBER = 7.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_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 = 3.2.0 PROJECT_NUMBER = 4.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/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 = 3.2.0 PROJECT_NUMBER = 4.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_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.0.0 PROJECT_NUMBER = 6.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_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.0.0 PROJECT_NUMBER = 6.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

8
os/hal/dox/hal_crypto.dox
View File

@ -15,10 +15,10 @@
*/ */
/** /**
* @defgroup TRNG TRNG Driver * @defgroup CRYPTO Crypto Driver
* @brief Generic True Random Numbers Generator Driver. * @brief Generic Crypto Driver.
* @details This module implements a generic TRNG driver. * @details This module implements a generic Cryptography driver.
* @pre In order to use the TRNG driver the @p HAL_USE_TRNG option * @pre In order to use the crypto driver the @p HAL_USE_CRY option
* must be enabled in @p halconf.h. * must be enabled in @p halconf.h.
* *
* @ingroup HAL_NORMAL_DRIVERS * @ingroup HAL_NORMAL_DRIVERS

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

@ -19,7 +19,7 @@
* @brief Generic DAC Driver. * @brief Generic DAC Driver.
* @details This module implements a generic DAC (Digital to Analog Converter) * @details This module implements a generic DAC (Digital to Analog Converter)
* driver. * driver.
* @pre In order to use the MAC driver the @p HAL_USE_DAC option * @pre In order to use the DAC driver the @p HAL_USE_DAC option
* must be enabled in @p halconf.h. * must be enabled in @p halconf.h.
* *
* @ingroup HAL_NORMAL_DRIVERS * @ingroup HAL_NORMAL_DRIVERS

25
os/hal/dox/hal_efl.dox Normal file
View File

@ -0,0 +1,25 @@
/*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
/**
* @defgroup HAL_EFL EFL Driver
* @brief Generic Embedded Flash Driver.
* @details This module implements a generic embedded flash driver.
* @pre In order to use the EFL driver the @p HAL_USE_EFL option
* must be enabled in @p halconf.h.
*
* @ingroup HAL_NORMAL_DRIVERS
*/

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

@ -15,8 +15,8 @@
*/ */
/** /**
* @defgroup HAL_FLASH Generic NOR Flash Interface * @defgroup HAL_FLASH Generic Flash Interface
* @brief HAL Generic NOR Flash Driver Interface. * @brief HAL Generic Flash Driver Interface.
* *
* @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

50
os/hal/dox/hal_trng.dox
View File

@ -1,25 +1,25 @@
/* /*
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. you may not use this file except in compliance with the License.
You may obtain a copy of the License at You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
/** /**
* @defgroup CRYPTO Crypto Driver * @defgroup TRNG TRNG Driver
* @brief Generic Crypto Driver. * @brief Generic True Random Numbers Generator Driver.
* @details This module implements a generic Cryptography driver. * @details This module implements a generic TRNG driver.
* @pre In order to use the crypto driver the @p HAL_USE_CRY option * @pre In order to use the TRNG driver the @p HAL_USE_TRNG option
* must be enabled in @p halconf.h. * must be enabled in @p halconf.h.
* *
* @ingroup HAL_NORMAL_DRIVERS * @ingroup HAL_NORMAL_DRIVERS
*/ */

17
os/nil/dox/nil.dox
View File

@ -34,7 +34,22 @@
*/ */
/** /**
* @defgroup NIL_KERNEL API * @defgroup NIL_KERNEL Base API
* @ingroup NIL
*/
/**
* @defgroup NIL_SEMAPHORES Semaphores
* @ingroup NIL
*/
/**
* @defgroup NIL_EVENTS Events
* @ingroup NIL
*/
/**
* @defgroup NIL_MESSAGES Synchronous Messages
* @ingroup NIL * @ingroup NIL
*/ */

15
os/oslib/dox/lib.dox
View File

@ -48,6 +48,16 @@
* @ingroup oslib_synchronization * @ingroup oslib_synchronization
*/ */
/**
* @defgroup oslib_delegates Delegate Threads
* @ingroup oslib_synchronization
*/
/**
* @defgroup oslib_jobs_queues Jobs Queues
* @ingroup oslib_synchronization
*/
/** /**
* @defgroup oslib_memory Memory Management * @defgroup oslib_memory Memory Management
* @details Memory Management services. * @details Memory Management services.
@ -79,6 +89,11 @@
* @ingroup oslib_complex * @ingroup oslib_complex
*/ */
/**
* @defgroup oslib_objchaches Objects Caches
* @ingroup oslib_complex
*/
/** /**
* @defgroup oslib_objects_factory Dynamic Objects Factory * @defgroup oslib_objects_factory Dynamic Objects Factory
* @ingroup oslib_complex * @ingroup oslib_complex