doxygen/main.h

Go to the documentation of this file.
00001 // Copyright 2006 Benedikt Böhm <hollow@gentoo.org>
00002 //
00003 // This program is free software; you can redistribute it and/or modify
00004 // it under the terms of the GNU General Public License as published by
00005 // the Free Software Foundation; either version 2 of the License, or
00006 // (at your option) any later version.
00007 //
00008 // This program is distributed in the hope that it will be useful,
00009 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00011 // GNU General Public License for more details.
00012 //
00013 // You should have received a copy of the GNU General Public License
00014 // along with this program; if not, write to the
00015 // Free Software Foundation, Inc.,
00016 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00017 
00018 /*!
00019  * @mainpage lucid Documentation
00020  *
00021  * The lucid library combines a lot of useful functions i wrote for my
00022  * projects. There are a lot of custom functions for strings,
00023  * doubly-linked lists, bitmaps and flag lists, input/output, cryptogrpahic
00024  * digests, and tcp connections.
00025  *
00026  * Some of these functions, especially string and list functions, are
00027  * completely self-contained and do not rely on libc. This makes integration
00028  * in foreign projects as easy as possible.
00029  *
00030  * On the other hand, functions for input/output or chroot are just wrappers
00031  * around libc library functions, but may still be usefull to others as well.
00032  *
00033  * The size of functions range from a few hundred bytes to about 30K.
00034  *
00035  * @section why Why another library?
00036  *
00037  * This library was written for my own projects. As the number of foreign
00038  * libraries i included grew, i have collected all functions i needed - and
00039  * meanwhile most of them reimplemented - and made an own library.
00040  *
00041  * @section status Current Status
00042  *
00043  * Actually 4 projects (libvserver, vcd, vstatd, vwrappers) are using lucid now,
00044  * so an own shared library was necessary. The library contains a test suite for
00045  * the most important functions. Functions not explicitely tested are either
00046  * tested implicitely by other functions and a test may be written in the
00047  * future, or the function is so simple that you can just hope it works ;)
00048  *
00049  * @section doc Documentation
00050  *
00051  * All function are documented with an inline source browser for easy learning
00052  * and reference. To get an overview of function families please start at the
00053  * Modules page. Experienced users may look up information in the Globals, Data
00054  * Fields or File List.
00055  *
00056  * Also take a look at the \ref examples "Examples" and read the
00057  * \ref license "License".
00058  *
00059  * @section bugs Bugs, Patches, Wishes
00060  *
00061  * If you have found a bug in lucid that was not discovered by the test suite,
00062  * or if you have any suggestion, wishes or patches for the future of lucid,
00063  * please contact me at hollow[at]gentoo.org
00064  *
00065  * @{
00066  */

Generated on Sun Dec 3 17:45:53 2006 for lucid by  doxygen 1.5.1