haiku/docs/user/support/support_intro.dox
Niels Sascha Reedijk 89e18a513c * Take a document on compatibility from the Haiku website (experimenting with pages) - Originally written by Ingo and updated by others, I have permission from Ingo.
* book.dox Rework a bit of the structure
* midi2/support Separate the overview (or Introduction) from the list of elements in a module.
* support Wrote initial documentation for Beep/BufferIO/DataIO
* Stub for article on archiving.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@20307 a95241bf-73f2-0310-859d-f6bbb57e9c96
2007-03-02 13:36:32 +00:00

54 lines
1.2 KiB
Plaintext

/*!
\page support_intro Introduction to the Support Kit
The Support Kit provides a handy set of functions and classes that you can
use in your applications. Have a look at the overview, or go straight to
the complete \link support list of components \endlink of this kit.
\section Overview
<ul>
<li>Threading utility classes:</li>
<ul>
<li>BLocker</li>
<li>BAutolock</li>
<li>Thread Local Storage</li>
</ul>
<li>Archiving and IO:</li>
<ul>
<li>BArchivable (\link support_archiving tutorial\endlink)</li>
<li>BFlattenable</li>
<li>BDataIO</li>
<ul>
<li>BPositionIO</li>
<ul>
<li>BBufferIO</li>
<li>BMemoryIO</li>
<li>BMallocIO</li>
</ul>
</ul>
</ul>
<li>Container classes:</li>
<ul>
<li>BBlockCache</li>
<li>BList</li>
<li>BString</li>
</ul>
<li>BStopWatch</li>
<li>\ref support_globals "Global functions"</li>
<li>\ref TypeConstants.h "Common types and constants"</li>
<li>Error codes for all kits</li>
</ul>
*/
// Short listing of documents that belong to this module so that people can
// find these from the module overview.
// This should become standardized in Doxygen though. There is an item on
// the todo list on this.
/*!
\addtogroup support
For a better overview, have a look at \ref support_intro .
*/