doc: Add doxygen tags information.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2728 38d2e660-2303-0410-9eaa-f027e97ec537

diff --git a/README.bertos b/README.bertos
index 65e2e532f2025fb3d67e48dada1857919aca95da..5abaa06dce362e39fb971cc637280fc446018878 100644 (file)
--- a/README.bertos
+++ b/README.bertos
@@ -1,9 +1,16 @@
-/*
- * This document is automatically processed by Doxygen (http://www.doxygen.org/).
- * Don't remove special formatting tags.
- */
 /*!
 
+\if DEVELOPER_NOTE_ON
+
+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.
+\endif
+
+
+
 \mainpage
 
 \section overview Overview

diff --git a/STATUS b/STATUS
index a9ff2e83519985480989baf2a19d86a1d05d0d72..9bafa3bd9a7e87afc666db6ef2c4e5318f3e8d75 100644 (file)
--- a/STATUS
+++ b/STATUS
@@ -1,8 +1,26 @@
-/*
- * This document is automatically processed by Doxygen (http://www.doxygen.org/).
- * Don't remove special formatting tags.
- */
-/*!
+/*!
+\if DEVELOPER_NOTE_ON
+
+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.
+
+Doxygen supports a LaTeX-like syntax to write documentation; use that syntax to make changes to this file.
+You can find a reference here: http://www.stack.nl/~dimitri/doxygen/manual.html, inside the section 'Special commands'.
+
+For tables, use ONLY the html formatting tags that you can find in the previous page in the section 'HTML commands'. This way
+we'll always be able to generate valid documentation for every language supported by Doxygen.
+
+Remember to use Doxygen tags sparingly inside source code.
+
+\endif
+
+
+
+
+
+
+ 
 \page dev_status BeRTOS Development Status
 
 If you are looking for the list of BeRTOS ports or a detailed overview of all modules completeness and stability this is the right place.