andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HAL documentation build works now. 

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7561 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
gdisirio 2014-12-08 10:49:39 +00:00
parent c78228082b
commit 5b03233f8d
6 changed files with 89 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/hal/Doxyfile_chm
View File

@ -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

30
os/hal/dox/dac.dox Normal file
View File

@ -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
*/

24
os/hal/dox/hal_queues.dox Normal file
View File

@ -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
*/

28
os/hal/dox/st.dox Normal file
View File

@ -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
*/

2
os/hal/include/hal_queues.h
View File

@ -22,7 +22,7 @@
* @file hal_queues.h
* @brief I/O Queues macros and structures.
*
* @addtogroup io_queues
* @addtogroup HAL_QUEUES
* @{
*/

2
os/hal/src/hal_queues.c
View File

@ -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