Improved ST/MEMS documentation. Completely fixed Bug #915

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11448 35acf78f-673a-0410-8e92-d51de3d6d3f4

9 files changed, 19 insertions, 13 deletions

diff --git a/os/ex/ST/hts221.h b/os/ex/ST/hts221.h
index 8915ebea6..9f47aaea4 100644
--- a/os/ex/ST/hts221.h
+++ b/os/ex/ST/hts221.h
@@ -354,7 +354,7 @@ typedef struct {
 #define _hts221_hygrometer_methods_alone

                  

 /**

- * @brief   @p HTS221 hygrometer subsystem specific methods.

+ * @brief   @p HTS221 hygrometer subsystem specific methods with inherited ones.

  */

 #define _hts221_hygrometer_methods                                          \

   _base_hygrometer_methods                                                  \

@@ -367,7 +367,7 @@ typedef struct {
 #define _hts221_thermometer_methods_alone

  

 /**

- * @brief @p HTS221 compass subsystem specific methods.

+ * @brief @p HTS221 compass subsystem specific methods with inherited ones.

  */

 #define _hts221_thermometer_methods                                         \

   _base_thermometer_methods                                                 \

@@ -407,10 +407,10 @@ struct HTS221ThermometerVMT {
                                  HTS221_THERMO_NUMBER_OF_AXES];

 

 /**

- * @extends BaseGyroscope

+ * @extends BaseHygrometer

  *

  * @brief   HTS221 3-axis barometer class.

- * @details This class extends @p BaseGyroscope by adding physical

+ * @details This class extends @p BaseHygrometer by adding physical

  *          driver implementation.

  */

 struct HTS221Driver {

diff --git a/os/ex/ST/l3gd20.h b/os/ex/ST/l3gd20.h
index 4cb264e70..84dc2a412 100644
--- a/os/ex/ST/l3gd20.h
+++ b/os/ex/ST/l3gd20.h
@@ -481,7 +481,7 @@ typedef struct {
   msg_t (*set_full_scale)(void *instance, l3gd20_fs_t fs);

 
 /**
- * @brief   @p L3GD20 specific methods.
+ * @brief   @p L3GD20 gyroscope subsystem specific methods with inherited ones.
  */
 #define _l3gd20_gyroscope_methods                                           \
   _base_gyroscope_methods                                                   \
diff --git a/os/ex/ST/lis302dl.h b/os/ex/ST/lis302dl.h
index d90998e6a..a80e32fe7 100644
--- a/os/ex/ST/lis302dl.h
+++ b/os/ex/ST/lis302dl.h
@@ -330,7 +330,8 @@ typedef struct {
    

    

 /**

- * @brief   @p LIS302DL specific methods.

+ * @brief   @p LIS302DL accelerometer subsystem specific methods with inherited 

+ *          ones.

  */

 #define _lis302dl_accelerometer_methods                                     \

   _base_accelerometer_methods                                               \

diff --git a/os/ex/ST/lis3dsh.h b/os/ex/ST/lis3dsh.h
index b83dc73ed..12b6dd6bf 100644
--- a/os/ex/ST/lis3dsh.h
+++ b/os/ex/ST/lis3dsh.h
@@ -471,7 +471,8 @@ typedef struct {
   

   

 /**

- * @brief   @p LIS3DSH specific methods.

+ * @brief   @p LIS3DSH accelerometer subsystems specific methods with inherited 

+ *          ones.

  */

 #define _lis3dsh_accelerometer_methods                                      \

   _base_accelerometer_methods                                               \

diff --git a/os/ex/ST/lis3mdl.h b/os/ex/ST/lis3mdl.h
index 8f3745bb7..de3c35eed 100644
--- a/os/ex/ST/lis3mdl.h
+++ b/os/ex/ST/lis3mdl.h
@@ -431,7 +431,7 @@ typedef struct {
   msg_t (*set_full_scale)(void *instance, lis3mdl_fs_t fs);

   

 /**

- * @brief   @p LIS3MDL specific methods.

+ * @brief   @p LIS3MDL compass subsystem specific methods with inherited ones.

  */

 #define _lis3mdl_compass_methods                                            \

   _base_compass_methods                                                     \

diff --git a/os/ex/ST/lps25h.h b/os/ex/ST/lps25h.h
index c99af55df..519d8e846 100644
--- a/os/ex/ST/lps25h.h
+++ b/os/ex/ST/lps25h.h
@@ -386,7 +386,7 @@ typedef struct {
 #define _lps25h_barometer_methods_alone

 

 /**

- * @brief @p LPS25H barometer subsystem specific methods.

+ * @brief @p LPS25H barometer subsystem specific methods with inherited ones.

  */

 #define _lps25h_barometer_methods                                           \

   _base_barometer_methods                                                   \

diff --git a/os/ex/ST/lsm303dlhc.h b/os/ex/ST/lsm303dlhc.h
index 35f258fe8..168746398 100644
--- a/os/ex/ST/lsm303dlhc.h
+++ b/os/ex/ST/lsm303dlhc.h
@@ -578,7 +578,8 @@ typedef struct {
   msg_t (*set_full_scale)(void *instance, lsm303dlhc_acc_fs_t fs);

                  

 /**

- * @brief @p LSM303DLHC accelerometer subsystem specific methods.

+ * @brief   @p LSM303DLHC accelerometer subsystem specific methods with 

+ *          inherited ones.

  */

 #define _lsm303dlhc_accelerometer_methods                                   \

   _base_accelerometer_methods                                               \

@@ -592,7 +593,7 @@ typedef struct {
   msg_t (*set_full_scale)(void *instance, lsm303dlhc_comp_fs_t fs);

  

 /**

- * @brief @p LSM303DLHC compass subsystem specific methods.

+ * @brief @p LSM303DLHC compass subsystem specific methods with inherited ones.

  */

 #define _lsm303dlhc_compass_methods                                         \

   _base_compass_methods                                                     \

diff --git a/os/ex/ST/lsm6ds0.h b/os/ex/ST/lsm6ds0.h
index e1d52883b..59abeb336 100644
--- a/os/ex/ST/lsm6ds0.h
+++ b/os/ex/ST/lsm6ds0.h
@@ -685,7 +685,8 @@ typedef struct {
   

   

 /**

- * @brief   @p LSM6DS0 accelerometer subsystem specific methods.

+ * @brief   @p LSM6DS0 accelerometer subsystem specific methods with inherited 

+ *          ones.

  */

 #define _lsm6ds0_accelerometer_methods                                      \

   _base_accelerometer_methods                                               \

@@ -700,7 +701,7 @@ typedef struct {
   

   

 /**

- * @brief   @p LSM6DS0 gyroscope subsystem specific methods.

+ * @brief   @p LSM6DS0 gyroscope subsystem specific methods with inherited ones.

  */

 #define _lsm6ds0_gyroscope_methods                                          \

   _base_gyroscope_methods                                                   \

diff --git a/readme.txt b/readme.txt
index 62ced9c97..b37d92457 100644
--- a/readme.txt
+++ b/readme.txt
@@ -166,6 +166,8 @@
        dependencies and configuration directories. This makes possible

        to have multiple non-conflicting makefiles in the same project.

        Updated the various platform.mk implementing "smart build" mode.

+- EX:  Improved MEMS drivers (bug #915)(backported to 17.6.4).

+- HAL: Improved peripheral classes (bug #915)(backported to 17.6.4).

 - HAL: Fixed more instances of bug #843 (bug #914)(backported to 17.6.4

        and 16.1.10).

 - HAL: Fixed Clock selection for SDMMC2 missing in STM32F7 HAL (bug #913).