Documentation fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12569 110e8d01-0319-4d1e-a829-52ad28d1bb01
This commit is contained in:
parent
40f162e046
commit
f55231f5ba
|
@ -15,10 +15,10 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @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 I2C 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
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
/*
|
|
||||||
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 IO_CHANNEL Abstract I/O Channel
|
|
||||||
* @ingroup HAL_INTERFACES
|
|
||||||
*/
|
|
|
@ -1,20 +0,0 @@
|
||||||
/*
|
|
||||||
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_FILES Abstract Files
|
|
||||||
* @ingroup HAL_INTERFACES
|
|
||||||
*/
|
|
|
@ -0,0 +1,60 @@
|
||||||
|
/*
|
||||||
|
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_BLOCKS Blocks
|
||||||
|
* @ingroup HAL_INTERFACES_CLASSES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_INTERFACES Streams
|
||||||
|
* @ingroup HAL_INTERFACES_CLASSES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_STREAMS Abstract Streams Interface
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup IO_CHANNEL Abstract I/O Channel Interface
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_FILES Abstract Files Interface
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_PERSISTENT Abstract Persistent Storage Interface
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_MEMORY_STREAMS Memory Streams Class
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_NULL_STREAMS Null Streams Class
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @defgroup HAL_CHPRINTF Output Formatter Utility
|
||||||
|
* @ingroup HAL_INTERFACES
|
||||||
|
*/
|
|
@ -16,7 +16,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup IO_BLOCK Abstract I/O Block Device
|
* @defgroup IO_BLOCK Abstract I/O Block Device
|
||||||
* @ingroup HAL_INTERFACES
|
* @ingroup HAL_BLOCKS
|
||||||
*
|
*
|
||||||
* @section io_block_1 Driver State Machine
|
* @section io_block_1 Driver State Machine
|
||||||
* The drivers implementing this interface shall implement the following
|
* The drivers implementing this interface shall implement the following
|
||||||
|
|
|
@ -16,5 +16,5 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup HAL_BASE_OBJECT Base Object
|
* @defgroup HAL_BASE_OBJECT Base Object
|
||||||
* @ingroup HAL_INTERFACES
|
* @ingroup HAL_INTERFACES_CLASSES
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
/*
|
|
||||||
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_PERSISTENT Abstract Persistent Storage
|
|
||||||
* @ingroup HAL_INTERFACES
|
|
||||||
*/
|
|
|
@ -1,20 +0,0 @@
|
||||||
/*
|
|
||||||
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_STREAMS Abstract Streams
|
|
||||||
* @ingroup HAL_INTERFACES
|
|
||||||
*/
|
|
|
@ -114,7 +114,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup HAL_INTERFACES Interfaces and Classes
|
* @defgroup HAL_INTERFACES_CLASSES Interfaces and Classes
|
||||||
* @brief HAL Interfaces and Classes.
|
* @brief HAL Interfaces and Classes.
|
||||||
*
|
*
|
||||||
* @ingroup IO
|
* @ingroup IO
|
||||||
|
|
|
@ -24,6 +24,7 @@
|
||||||
* @brief Mini printf-like functionality.
|
* @brief Mini printf-like functionality.
|
||||||
*
|
*
|
||||||
* @addtogroup HAL_CHPRINTF
|
* @addtogroup HAL_CHPRINTF
|
||||||
|
* @details Mini printf-like functionality.
|
||||||
* @{
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue