diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2016-01-03 10:53:23 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2016-01-03 10:53:23 +0000 |
| commit | 1a7524add7dabf81895a6e6cb170c2b417da4c18 (patch) | |
| tree | 41e60b63015271c251428ecf59e88f2169c8965c /os/hal/dox | |
| parent | 4c12fb1364261b3e8263a558f14fd483f181195c (diff) | |
| download | ChibiOS-1a7524add7dabf81895a6e6cb170c2b417da4c18.tar.gz ChibiOS-1a7524add7dabf81895a6e6cb170c2b417da4c18.tar.bz2 ChibiOS-1a7524add7dabf81895a6e6cb170c2b417da4c18.zip | |
Documentation-related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8672 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/dox')
| -rw-r--r-- | os/hal/dox/hal_buffers.dox | 20 | ||||
| -rw-r--r-- | os/hal/dox/hal_queues.dox | 2 | ||||
| -rw-r--r-- | os/hal/dox/wdg.dox | 26 |
3 files changed, 47 insertions, 1 deletions
diff --git a/os/hal/dox/hal_buffers.dox b/os/hal/dox/hal_buffers.dox new file mode 100644 index 000000000..fca465572 --- /dev/null +++ b/os/hal/dox/hal_buffers.dox @@ -0,0 +1,20 @@ +/*
+ ChibiOS - Copyright (C) 2006..2015 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_BUFFERS I/O Buffers Queues
+ * @ingroup HAL_INNER_CODE
+ */
diff --git a/os/hal/dox/hal_queues.dox b/os/hal/dox/hal_queues.dox index f1e1f753c..9edfb47eb 100644 --- a/os/hal/dox/hal_queues.dox +++ b/os/hal/dox/hal_queues.dox @@ -15,6 +15,6 @@ */
/**
- * @defgroup HAL_QUEUES I/O Queues
+ * @defgroup HAL_QUEUES I/O Bytes Queues
* @ingroup HAL_INNER_CODE
*/
diff --git a/os/hal/dox/wdg.dox b/os/hal/dox/wdg.dox new file mode 100644 index 000000000..4ca070479 --- /dev/null +++ b/os/hal/dox/wdg.dox @@ -0,0 +1,26 @@ +/*
+ ChibiOS - Copyright (C) 2006..2015 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 WDG WDG Driver
+ * @brief Watchdog Timer Abstraction Layer
+ * @details This module defines an abstract interface for a watchdog
+ * timer.
+ * @pre In order to use the WDG driver the @p HAL_USE_WDG option
+ * must be enabled in @p halconf.h.
+ *
+ * @ingroup HAL_NORMAL_DRIVERS
+ */
|