From a6511826eaf526d39fce213ea500ec7e9138cbdb Mon Sep 17 00:00:00 2001 From: lottaviano Date: Tue, 29 Sep 2009 12:19:45 +0000 Subject: [PATCH 1/1] doc: Add snapshot doxyfile and mainpage. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2990 38d2e660-2303-0410-9eaa-f027e97ec537 --- Doxyfile-snapshot | 42 +++++++++++++++++++ Mainpage.snapshot | 103 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 145 insertions(+) create mode 100644 Doxyfile-snapshot create mode 100644 Mainpage.snapshot diff --git a/Doxyfile-snapshot b/Doxyfile-snapshot new file mode 100644 index 00000000..07100ba2 --- /dev/null +++ b/Doxyfile-snapshot @@ -0,0 +1,42 @@ +# Doxyfile 1.5.9 + +@INCLUDE = Doxyfile-common + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/reference + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = *.h \ + Mainpage.snapshot \ + *.c + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = doc/TracHeader.html + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + diff --git a/Mainpage.snapshot b/Mainpage.snapshot new file mode 100644 index 00000000..b20936de --- /dev/null +++ b/Mainpage.snapshot @@ -0,0 +1,103 @@ +/*! + + + +\mainpage + +This documentation is generated from BeRTOS SVN. As such, it may contain modules +and/or additional documentation not present in official releases. + +\section overview Overview + +BeRTOS is a real-time operating system designed for building applications +for embedded systems, like reference boards, test boards, or custom boards. + +It has a modular structure: its components can be used in very different +environments, from 8-bit processor to Linux and Win32 hosted application +(for debug purpose), using a wide range of compilers. + +\section history History and Motivation + +BeRTOS was born as a extremely modular, highly optimized and fine-tuned +operating system for embedded programming. +As a result, each module has its own scope and can be used alone or in +cooperation with other modules. +It's even possible to use most of the drivers without activating the kernel module. + +We have grown it following our guidelines: simplicity and beauty. +These guidelines made it possible to evolve it in a full-featured real +time operating system, with more modularity than many other embedded OSes, +without giving up reliability and performace. + +To achieve the highest possible reusability, most BeRTOS components are +designed for fine-grained modularity and minimal external dependencies. +Most non-essential features can be configured out for applications with small +memory footprint requirements. + +\section features Features + + - multitasking kernel with IPC, semaphores, priority levels; + - a comprehensive set of generic drivers for a wide range of devices, + which can be easily customized to the actual hardware: timer, serial, + adc, ntc, pwm, stepper motors, dc motors, lcd, keyboards, buzzer, eeprom; + - full graphic subsystem for simple displays, with font support, bitmaps, + clipping, text formatting, interactive menus; + - simple console with command parser; + - readline-like support for command history; + - entropy generator and random numbers generator optimized for embedded + systems; + - checksumming and hashing functions (CRC, MD2); + - full hash-table implementation with double-hashing collision resolution; + - XMODEM protocol implementation; + - RLE compression algorithm; + +\section structure Directory Structure + +The modules are sorted in subdirectories by their category: + + - app/ : demo applications; + - bertos/algo/ : algorithms; + - bertos/cfg/ : configuration stuff; + - bertos/drv/ : hardware drivers; + - bertos/dt/ : experimental object oriented gui toolkit; + - bertos/emul/ : Qt-based emulator framework for embedded applications; + - bertos/fonts/ : fonts; + - bertos/fs/ : file system related stuff; + - bertos/gfx/ : general purpose graphics routines; + - bertos/gui/ : widgets for simple displays; + - bertos/hw/ : hardware-specific declarations; + - bertos/icons/ : conversion tool from image TXT format to LCD bitmap; + - bertos/kern/ : multitasking kernel; + - bertos/mware/ : algorithms, other standalone code; + - bertos/struct/ : containers and other data structures; + - bertos/os/ : OS-abstraction layers for hosted environments; + - doc/ : documentation; + +The top-level directory contains a few support headers that are meant to be +usable by any C/C++ embedded or hosted application. + +\section license License + +BeRTOS is provided under the term of the GNU General Public License +(see LICENSE.GPL) with following exception: + +\verbatim + +As a special exception, you may use this file as part of a free software +library without restriction. Specifically, if other files instantiate +templates or use macros or inline functions from this file, or you compile +this file and link it with other files to produce an executable, this +file does not by itself cause the resulting executable to be covered by +the GNU General Public License. This exception does not however +invalidate any other reasons why the executable file might be covered by +the GNU General Public License. + +\endverbatim + +*/ -- 2.25.1