doc: Properly use comment blocks instead of other hacks.
[bertos.git] / README.bertos
index 7c7cfb122126f275737767c7cadcfa92ac188b79..7986d20fc3ec0003ae20bf235219f2c2099b6c07 100644 (file)
@@ -1,8 +1,14 @@
-/*
- * This document is automatically processed by Doxygen (http://www.doxygen.org/).
- * Don't remove special formatting tags.
- */
 /*!
+<!--
+
+This document is automatically processed by Doxygen (http://www.doxygen.org/).
+Don't remove special formatting tags.
+This section won't be processed unless enabled.
+
+See STATUS for further information and tips about Doxygen tags.
+-->
+
+
 
 \mainpage
 
@@ -74,6 +80,8 @@ The modules are sorted in subdirectories by their category:
 The top-level directory contains a few support headers that are meant to be
 usable by any C/C++ embedded or hosted application.
 
+See the \ref dev_status page for information about the various drivers.
+
 \section license License
 
 BeRTOS is provided under the term of the GNU General Public License