Documentation-relate fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11978 110e8d01-0319-4d1e-a829-52ad28d1bb01

8 files changed, 83 insertions, 9 deletions

diff --git a/doc/hal/Doxyfile_chm b/doc/hal/Doxyfile_chm
index 6ca8a301b..85e6e877e 100644
--- a/doc/hal/Doxyfile_chm
+++ b/doc/hal/Doxyfile_chm
@@ -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

 

diff --git a/doc/hal/Doxyfile_html b/doc/hal/Doxyfile_html
index 961171e13..26f296ba8 100644
--- a/doc/hal/Doxyfile_html
+++ b/doc/hal/Doxyfile_html
@@ -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

 

diff --git a/os/hal/dox/crypto.dox b/os/hal/dox/crypto.dox
new file mode 100644
index 000000000..9f2ad850c
--- /dev/null
+++ b/os/hal/dox/crypto.dox
@@ -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

+ */

diff --git a/os/hal/dox/hal_objects.dox b/os/hal/dox/hal_objects.dox
new file mode 100644
index 000000000..98450801c
--- /dev/null
+++ b/os/hal/dox/hal_objects.dox
@@ -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

+ */

diff --git a/os/hal/dox/main.dox b/os/hal/dox/main.dox
index 4a34791ba..991fb78e4 100644
--- a/os/hal/dox/main.dox
+++ b/os/hal/dox/main.dox
@@ -114,8 +114,8 @@
  */

 

 /**

- * @defgroup HAL_INTERFACES Interfaces

- * @brief   HAL Interfaces.

+ * @defgroup HAL_INTERFACES Interfaces and Classes

+ * @brief   HAL Interfaces and Classes.

  *

  * @ingroup IO

  */

diff --git a/os/hal/dox/mfs.dox b/os/hal/dox/mfs.dox
new file mode 100644
index 000000000..359cb2f9e
--- /dev/null
+++ b/os/hal/dox/mfs.dox
@@ -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

+ */

diff --git a/os/hal/lib/complex/mfs/mfs.c b/os/hal/lib/complex/mfs/mfs.c
index ba68fb19d..32ae2432a 100644
--- a/os/hal/lib/complex/mfs/mfs.c
+++ b/os/hal/lib/complex/mfs/mfs.c
@@ -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.

diff --git a/os/hal/lib/complex/mfs/mfs.h b/os/hal/lib/complex/mfs/mfs.h
index c1d575a2c..d41dcf9bf 100644
--- a/os/hal/lib/complex/mfs/mfs.h
+++ b/os/hal/lib/complex/mfs/mfs.h
@@ -21,6 +21,7 @@
  * @file    mfs.h

  * @brief   Managed Flash Storage module header.

  *

+ * @addtogroup MFS

  * @{

  */