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