diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2014-12-08 10:49:39 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2014-12-08 10:49:39 +0000 |
| commit | 5b03233f8d19a1257130aa5ea9bcf22f4e65df05 (patch) | |
| tree | eab4ccf15f89022d360d27c48b8d8d13ca1a0b83 /os/hal | |
| parent | c78228082b4e5b845a9c5553ab9e52766b468ab9 (diff) | |
| download | ChibiOS-5b03233f8d19a1257130aa5ea9bcf22f4e65df05.tar.gz ChibiOS-5b03233f8d19a1257130aa5ea9bcf22f4e65df05.tar.bz2 ChibiOS-5b03233f8d19a1257130aa5ea9bcf22f4e65df05.zip | |
HAL documentation build works now.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7561 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal')
| -rw-r--r-- | os/hal/dox/dac.dox | 30 | ||||
| -rw-r--r-- | os/hal/dox/hal_queues.dox | 24 | ||||
| -rw-r--r-- | os/hal/dox/st.dox | 28 | ||||
| -rw-r--r-- | os/hal/include/hal_queues.h | 2 | ||||
| -rw-r--r-- | os/hal/src/hal_queues.c | 2 |
5 files changed, 84 insertions, 2 deletions
diff --git a/os/hal/dox/dac.dox b/os/hal/dox/dac.dox new file mode 100644 index 000000000..e40514867 --- /dev/null +++ b/os/hal/dox/dac.dox @@ -0,0 +1,30 @@ +/*
+ ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013,2014 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/HAL
+
+ ChibiOS/HAL is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup DAC DAC Driver
+ * @brief Generic DAC driver.
+ * @details This module implements a generic DAC (Digital to Analog Converter)
+ * driver.
+ * @pre In order to use the MAC driver the @p HAL_USE_DAC option
+ * must be enabled in @p halconf.h.
+ *
+ * @ingroup HAL_NORMAL_DRIVERS
+ */
diff --git a/os/hal/dox/hal_queues.dox b/os/hal/dox/hal_queues.dox new file mode 100644 index 000000000..7d1852838 --- /dev/null +++ b/os/hal/dox/hal_queues.dox @@ -0,0 +1,24 @@ +/*
+ ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013,2014 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/HAL
+
+ ChibiOS/HAL is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup HAL_QUEUES I/O Queues
+ * @ingroup HAL_INNER_CODE
+ */
diff --git a/os/hal/dox/st.dox b/os/hal/dox/st.dox new file mode 100644 index 000000000..40b2f359f --- /dev/null +++ b/os/hal/dox/st.dox @@ -0,0 +1,28 @@ +/*
+ ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,
+ 2011,2012,2013,2014 Giovanni Di Sirio.
+
+ This file is part of ChibiOS/HAL
+
+ ChibiOS/HAL is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 3 of the License, or
+ (at your option) any later version.
+
+ ChibiOS/RT is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @defgroup ST ST Driver
+ * @brief Generic System Tick driver.
+ * @details This module implements a system tick timer in order to support
+ * the underlying operating system.
+ *
+ * @ingroup HAL_NORMAL_DRIVERS
+ */
diff --git a/os/hal/include/hal_queues.h b/os/hal/include/hal_queues.h index 0bf2628b6..b9516c984 100644 --- a/os/hal/include/hal_queues.h +++ b/os/hal/include/hal_queues.h @@ -22,7 +22,7 @@ * @file hal_queues.h
* @brief I/O Queues macros and structures.
*
- * @addtogroup io_queues
+ * @addtogroup HAL_QUEUES
* @{
*/
diff --git a/os/hal/src/hal_queues.c b/os/hal/src/hal_queues.c index d607a44c8..657de96f2 100644 --- a/os/hal/src/hal_queues.c +++ b/os/hal/src/hal_queues.c @@ -22,7 +22,7 @@ * @file hal_queues.c
* @brief I/O Queues code.
*
- * @addtogroup io_queues
+ * @addtogroup HAL_QUEUES
* @details Queues are mostly used in serial-like device drivers.
* Serial device drivers are usually designed to have a lower side
* (lower driver, it is usually an interrupt service routine) and an
|