From f3c59270de92e7424bcdd5a8966e026dc6689008 Mon Sep 17 00:00:00 2001 From: roccomarco Date: Sat, 1 Jul 2017 21:48:27 +0000 Subject: Improved ChibiOS\EX documentation (Still incomplete) git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@10281 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/ex/dox/accelerometer.dox | 22 ++++++++++++++++++++++ os/ex/dox/barometer.dox | 22 ++++++++++++++++++++++ os/ex/dox/compass.dox | 22 ++++++++++++++++++++++ os/ex/dox/gyro.dox | 20 ++------------------ os/ex/dox/hygrometer.dox | 22 ++++++++++++++++++++++ os/ex/dox/sensor.dox | 22 ++++++++++++++++++++++ os/ex/dox/thermometer.dox | 22 ++++++++++++++++++++++ 7 files changed, 134 insertions(+), 18 deletions(-) create mode 100644 os/ex/dox/accelerometer.dox create mode 100644 os/ex/dox/barometer.dox create mode 100644 os/ex/dox/compass.dox create mode 100644 os/ex/dox/hygrometer.dox create mode 100644 os/ex/dox/sensor.dox create mode 100644 os/ex/dox/thermometer.dox (limited to 'os/ex') diff --git a/os/ex/dox/accelerometer.dox b/os/ex/dox/accelerometer.dox new file mode 100644 index 000000000..a4c3df805 --- /dev/null +++ b/os/ex/dox/accelerometer.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2016 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_ACCELEROMETER Generic Accelerometer Interface + * @brief HAL Generic Accelerometer Interface. + * + * @ingroup HAL_PERIPHERAL_INTERFACES + */ diff --git a/os/ex/dox/barometer.dox b/os/ex/dox/barometer.dox new file mode 100644 index 000000000..d5e543558 --- /dev/null +++ b/os/ex/dox/barometer.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2016 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_BAROMETER Generic Barometer Interface + * @brief HAL Generic Barometer Interface. + * + * @ingroup HAL_PERIPHERAL_INTERFACES + */ diff --git a/os/ex/dox/compass.dox b/os/ex/dox/compass.dox new file mode 100644 index 000000000..489bd2e95 --- /dev/null +++ b/os/ex/dox/compass.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2016 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_COMPASS Generic Compass Interface + * @brief HAL Generic Compass Interface. + * + * @ingroup HAL_PERIPHERAL_INTERFACES + */ diff --git a/os/ex/dox/gyro.dox b/os/ex/dox/gyro.dox index da0fce44e..ff3b90cbf 100644 --- a/os/ex/dox/gyro.dox +++ b/os/ex/dox/gyro.dox @@ -15,24 +15,8 @@ */ /** - * @defgroup HAL HAL - * @brief Hardware Abstraction Layer. - * @details Under ChibiOS the set of the various device driver interfaces - * is called the HAL subsystem: Hardware Abstraction Layer. The HAL is the - * abstract interface between ChibiOS applications and hardware. - * - * @section hal_interfaces HAL Interfaces - * An interface is a binary structure allowing the access to a service - * using virtual functions. This allows to create drivers that can be - * accessed using a common interface. - * The concept of interface is commonly found in object-oriented languages - * like Java or C++, their meaning in ChibiOS/HAL is exactly the same. - * - */ - -/** - * @defgroup HAL_GYROSCOPE Generic Gyroscope Interfaces - * @brief HAL Generic Gyroscope Interfaces. + * @defgroup HAL_GYROSCOPE Generic Gyroscope Interface + * @brief HAL Generic Gyroscope Interface. * * @ingroup HAL_PERIPHERAL_INTERFACES */ diff --git a/os/ex/dox/hygrometer.dox b/os/ex/dox/hygrometer.dox new file mode 100644 index 000000000..b87312b88 --- /dev/null +++ b/os/ex/dox/hygrometer.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2016 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_HYGROMETER Generic Hygrometer Interface + * @brief HAL Generic Hygrometer Interface. + * + * @ingroup HAL_PERIPHERAL_INTERFACES + */ diff --git a/os/ex/dox/sensor.dox b/os/ex/dox/sensor.dox new file mode 100644 index 000000000..6d1ac2747 --- /dev/null +++ b/os/ex/dox/sensor.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2016 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_SENSORS Generic Sensor Interface + * @brief HAL Generic Sensor Interface. + * + * @ingroup HAL_PERIPHERAL_INTERFACES + */ diff --git a/os/ex/dox/thermometer.dox b/os/ex/dox/thermometer.dox new file mode 100644 index 000000000..5230d4918 --- /dev/null +++ b/os/ex/dox/thermometer.dox @@ -0,0 +1,22 @@ +/* + ChibiOS - Copyright (C) 2006..2016 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_THERMOMETER Generic Thermometer Interface + * @brief HAL Generic Thermometer Interface. + * + * @ingroup HAL_PERIPHERAL_INTERFACES + */ -- cgit v1.2.3