From ca0dfb083920cf47cd5ca91bda4e31eeb09f68dd Mon Sep 17 00:00:00 2001 From: bernie Date: Fri, 13 Aug 2004 03:22:49 +0000 Subject: [PATCH] Use Doxygen to generate DevLib's frontpage. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@137 38d2e660-2303-0410-9eaa-f027e97ec537 --- README | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README b/README index 6ce5bf36..25a848b7 100755 --- a/README +++ b/README @@ -1,6 +1,12 @@ +/* + * This document is automatically processed by Doxygen (http://www.doxygen.org/). + * Don't remove special formatting tags. + */ +/*! -Overview -======== +\mainpage + +\section overview Overview DevLib is a collection of small reusable components designed by Develer for internal use in many embedded and portable applications. @@ -14,8 +20,7 @@ definitely not an OS, altough some of its components can be combined together to form a multitasking kernel with some IPC functionality. -Scope (or lack thereof) -======================= +\section scope Scope (or lack thereof) There is no consistent scope or design guide-line for the components of DevLib, altough there is a common coding and documentation style. @@ -29,8 +34,7 @@ dependant on others to avoid code duplication, but most of the times you can configure out features you don't need. -Redistribution -============== +\section redist Redistribution DevLib is a collection of independent works originally written by several different contributors. Unless otherwise noted, all material @@ -41,3 +45,4 @@ by Develer, said parts are subject to the same licensing terms covering the specific project, with the exception of clauses granting exclusive rights. +*/ -- 2.25.1