From 5b03233f8d19a1257130aa5ea9bcf22f4e65df05 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 8 Dec 2014 10:49:39 +0000 Subject: [PATCH] HAL documentation build works now. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7561 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- doc/hal/Doxyfile_chm | 11 +++++------ os/hal/dox/dac.dox | 30 ++++++++++++++++++++++++++++++ os/hal/dox/hal_queues.dox | 24 ++++++++++++++++++++++++ os/hal/dox/st.dox | 28 ++++++++++++++++++++++++++++ os/hal/include/hal_queues.h | 2 +- os/hal/src/hal_queues.c | 2 +- 6 files changed, 89 insertions(+), 8 deletions(-) create mode 100644 os/hal/dox/dac.dox create mode 100644 os/hal/dox/hal_queues.dox create mode 100644 os/hal/dox/st.dox diff --git a/doc/hal/Doxyfile_chm b/doc/hal/Doxyfile_chm index a33b69ff6..b862b3ef3 100644 --- a/doc/hal/Doxyfile_chm +++ b/doc/hal/Doxyfile_chm @@ -25,7 +25,7 @@ DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = ChibiOS/RT +PROJECT_NAME = ChibiOS/HAL # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or @@ -644,11 +644,10 @@ WARN_LOGFILE = # with spaces. INPUT = ./src \ - ../../os/rt/dox \ - ../../os/rt/src \ - ../../os/rt/include \ - ../../os/rt/templates \ - ../../test/rt + ../../os/hal/dox \ + ../../os/hal/src \ + ../../os/hal/include \ + ../../os/hal/templates # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 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 . +*/ + +/** + * @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 . +*/ + +/** + * @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 . +*/ + +/** + * @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