From: lottaviano Date: Thu, 2 Jul 2009 10:15:04 +0000 (+0000) Subject: doc: Add doxygen tags information. X-Git-Tag: 2.2.0~240 X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=943539779aa9509626c0c7a825c600d9a949839f;p=bertos.git 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 65e2e532..5abaa06d 100644 --- 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 a9ff2e83..9bafa3bd 100644 --- 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.