Elm  2
ELM is a library providing generic data structures, OS-independent interface, plugins and XML.
doc.h
1 /*
2  * Main documentation
3  *
4  * This file is part of OTAWA
5  * Copyright (c) 2008-17, IRIT UPS.
6  *
7  * OTAWA is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * OTAWA is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with OTAWA; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 #ifndef ELM_DOC_H_
22 #define ELM_DOC_H_
23 
24 namespace elm {
25 
60 /*
61  * @par Memory Management
62  *
63  * ELM supplies several classes to handle allocation and de-allocation:
64  * @li default allocation scheme (@ref elm::DefaultAllocator),
65  * @li allocate from a list of fixed size (@ref elm::BlockAllocator),
66  * @li stack allocation with backtrack (@ref elm::StackAllocator),
67  * @li semi-automatic specialized garbage collector (@ref elm::AbstractBlockAllocatorWithGC).
68  *
69  * And some cleanup classes or pointer management classes (@ref elm::AutoCleaner, @ref elm::AutoDestructor, @ref AutoPtr).
70  *
71  * @par Other Facilities
72  * @li crash management (@ref elm::CrashHandler, only for Linux),
73  * @li XML and XSLT using the XOM interface (@ref xom),
74  * @li basic exceptions with message (@ref elm::Exception and @ref elm::MessageException),
75  * @li very light test framework (@ref elm::TestCase and @ref elm::TestSet),
76  * @li automatic serialization and unserialization (@ref serial),
77  * @li work-around the C++ initialization fiasco (@ref elm::Initializer),
78  * bit management (@ref elm::BitVector).
79  */
80 
183 namespace meta {
184 
287 } // meta
288 
558 } // elm
559 
560 #endif /* ELM_DOC_H_*/
Definition: adapter.h:26