xref: /haiku/docs/user/support/support_intro.dox (revision 239222b2369c39dc52df52b0a7cdd6cc0a91bc92)
1/*
2 * Copyright 2007, Haiku, Inc. All Rights Reserved.
3 * Distributed under the terms of the MIT License.
4 *
5 * Documentation by:
6 *  Niels Sascha Reedijk <niels.reedijk@gmail.com>
7 */
8
9/*!
10  \page support_intro Introduction to the Support Kit
11
12  The Support Kit provides a handy set of functions and classes that you can
13  use in your applications. Have a look at the overview, or go straight to
14  the complete \link support list of components \endlink of this kit.
15
16  \section Overview
17  - Threading utility classes:
18    - BLocker
19    - BAutolock
20    - \ref TLS.h "Thread Local Storage"
21  - Archiving and IO:
22    - BArchivable
23    - BFlattenable
24    - BDataIO
25      - BPositionIO
26        - BBufferIO
27        - BMemoryIO
28        - BMallocIO
29  - Container classes:
30    - BBlockCache
31    - BList
32    - BString
33  - BStopWatch
34  - \ref support_globals "Global functions"
35  - \ref TypeConstants.h "Common types and constants"
36  - Error codes for all kits
37*/
38
39// Short listing of documents that belong to this module so that people can
40// find these from the module overview.
41// This should become standardized in Doxygen though. There is an item on
42// the todo list on this.
43
44/*!
45  \addtogroup support
46
47  For a better overview, have a look at \ref support_intro .
48*/
49
50