RTC. Doxy file added.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/rtc_dev@3273 35acf78f-673a-0410-8e92-d51de3d6d3f4
master
barthess 2011-08-31 15:30:25 +00:00
parent 7fd48a4a3f
commit 6cc29ee5c8
1 changed files with 32 additions and 0 deletions

32
os/hal/dox/rtc.dox Normal file
View File

@ -0,0 +1,32 @@
/*
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
2011 Giovanni Di Sirio.
This file is part of ChibiOS/RT.
ChibiOS/RT 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 RTC RTC Driver
* @brief Real Time Clock Abstraction Layer
* @details This module defines an abstract interface for Real Time Clock cell.
* If you do not need callback functionality than disable
* @p RTC_SUPPORTS_CALLBACKS option in @p halconf.h.
*
* @pre In order to use the RTC driver the @p HAL_USE_RTC option
* must be enabled in @p halconf.h.
*
* @ingroup IO
*/