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

Documentation-relate fixes. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11978 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
Giovanni Di Sirio 2018-04-29 08:16:10 +00:00
parent ca4302fcca
commit 3de1c4b3fe
8 changed files with 83 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
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
# control system is used.
PROJECT_NUMBER = 6.0.0
PROJECT_NUMBER = 6.0.1
# 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
@ -792,6 +792,7 @@ INPUT = ./src \
../../os/hal/include \
../../os/hal/lib/peripherals/flash \
../../os/hal/lib/peripherals/sensors \
../../os/hal/lib/complex/mfs \
../../os/hal/templates \
../../os/hal/templates/osal

3
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
# control system is used.
PROJECT_NUMBER = 6.0.0
PROJECT_NUMBER = 6.0.1
# 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
@ -792,6 +792,7 @@ INPUT = ./src \
../../os/hal/include \
../../os/hal/lib/peripherals/flash \
../../os/hal/lib/peripherals/sensors \
../../os/hal/lib/complex/mfs \
../../os/hal/templates \
../../os/hal/templates/osal

25
os/hal/dox/crypto.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 CRYPTO Crypto Driver
* @brief Generic Crypto Driver.
* @details This module implements a generic Cryptography driver.
* @pre In order to use the I2C driver the @p HAL_USE_CRY option
* must be enabled in @p halconf.h.
*
* @ingroup HAL_NORMAL_DRIVERS
*/

20
os/hal/dox/hal_objects.dox Normal file
View File

@ -0,0 +1,20 @@
/*
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_BASE_OBJECT Base Object
* @ingroup HAL_INTERFACES
*/

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

@ -114,8 +114,8 @@
*/
/**
* @defgroup HAL_INTERFACES Interfaces
* @brief HAL Interfaces.
* @defgroup HAL_INTERFACES Interfaces and Classes
* @brief HAL Interfaces and Classes.
*
* @ingroup IO
*/

30
os/hal/dox/mfs.dox Normal file
View File

@ -0,0 +1,30 @@
/*
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 MFS Managed Flash Storage Driver
* @brief Managed Flash Storage Driver.
* @details This module implements a managed flash storage able to store
* a finite number of variable-size records. Records are retrieved
* by their index number.<br>
* The driver is automatically performs:
* - Wear leveling.
* - Auto repair after power loss.
* - Garbage collection in order to remove erased data.
* .
*
* @ingroup HAL_COMPLEX_DRIVERS
*/

6
os/hal/lib/complex/mfs/mfs.c
View File

@ -30,7 +30,7 @@
* banks (where possible) caused by power loss during operations.
* Both operations are transparent to the user.
*
* @addtogroup mfs
* @addtogroup MFS
* @{
*/
@ -422,9 +422,6 @@ static mfs_error_t mfs_bank_write_header(MFSDriver *mfsp,
* - MFS_BANK_OK
* .
*
* @param[in] foundcb callback to be called for each found record or @p NULL
* @param[in] endcb callback to be called after scanning or @p NULL
*
* @return The operation status.
*
* @notapi
@ -777,7 +774,6 @@ static mfs_error_t mfs_try_mount(MFSDriver *mfsp) {
* @brief Configures and activates a MFS driver.
*
* @param[in] mfsp pointer to the @p MFSDriver object
* @param[in] config pointer to the configuration
* @return The operation status.
* @retval MFS_NO_ERROR if the operation has been successfully completed.
* @retval MFS_WARN_GC if the operation triggered a garbage collection.

1
os/hal/lib/complex/mfs/mfs.h
View File

@ -21,6 +21,7 @@
* @file mfs.h
* @brief Managed Flash Storage module header.
*
* @addtogroup MFS
* @{
*/