diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-08-30 07:17:22 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-08-30 07:17:22 +0000 |
| commit | c7b1157dc9f3ae577d592ab3207a84e64140eabe (patch) | |
| tree | 6be9fbbf0ec524905e64e44f05e09ef85452d29d /os/various | |
| parent | 397ccffac55ffd139d0e3e82add83e51413c1347 (diff) | |
| download | ChibiOS-c7b1157dc9f3ae577d592ab3207a84e64140eabe.tar.gz ChibiOS-c7b1157dc9f3ae577d592ab3207a84e64140eabe.tar.bz2 ChibiOS-c7b1157dc9f3ae577d592ab3207a84e64140eabe.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1134 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/various')
| -rw-r--r-- | os/various/ch.cpp | 2 | ||||
| -rw-r--r-- | os/various/ch.hpp | 2 | ||||
| -rw-r--r-- | os/various/various.dox | 49 |
3 files changed, 51 insertions, 2 deletions
diff --git a/os/various/ch.cpp b/os/various/ch.cpp index 6e338630e..6efb38f7b 100644 --- a/os/various/ch.cpp +++ b/os/various/ch.cpp @@ -19,7 +19,7 @@ /**
* @file ch.cpp
* @brief C++ wrapper code.
- * @addtogroup CPlusPlusLibrary
+ * @addtogroup cpp_library
* @{
*/
diff --git a/os/various/ch.hpp b/os/various/ch.hpp index b13e8db6d..f0055a174 100644 --- a/os/various/ch.hpp +++ b/os/various/ch.hpp @@ -20,7 +20,7 @@ /**
* @file ch.hpp
* @brief C++ wrapper classes and definitions.
- * @addtogroup CPlusPlusLibrary
+ * @addtogroup cpp_library
* @{
*/
diff --git a/os/various/various.dox b/os/various/various.dox new file mode 100644 index 000000000..63872e2de --- /dev/null +++ b/os/various/various.dox @@ -0,0 +1,49 @@ +/*
+ ChibiOS/RT - Copyright (C) 2006-2007 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 utilities_library Utilities Library
+ * @brief Utilities Library.
+ * @details This is a collection of useful library code that is not part of
+ * the base kernel services.
+ * <h2>Notes</h2>
+ * The library code does not follow the same naming convention of the
+ * system APIs in order to make very clear that it is not "core" code.<br>
+ * The main difference is that library code is not formally tested in the
+ * test suite but through usage in the various demo applications.
+ */
+
+/**
+ * @defgroup cpp_library C++ Wrapper
+ * @brief C++ wrapper module.
+ * @details This module allows to use the ChibiOS/RT functionalities
+ * from C++ as classes and objects rather the traditional "C" APIs.
+ *
+ * @ingroup utilities_library
+ */
+
+/**
+ * @defgroup event_timer Periodic Events Timer
+ * @brief Periodic Event Timer.
+ * @details This timer generates an event at regular intervals. The
+ * listening threads can use the event to perform time related activities.
+ * Multiple threads can listen to the same timer.
+ *
+ * @ingroup utilities_library
+ */
|