Add ncval-stubout tool
[nativeclient.git] / documentation / modules.dox
blobbd9c66f37c283e12a20d8ed3bf03e684a423016b
1 /**
2  * @defgroup Libraries Libraries
3  * Libraries available to Native Client modules
4  *
5  * @defgroup audio_video Basic Multimedia Interface
6  * @ingroup Libraries
7  * Contains function calls for performing basic audio, video, and event polling.
8  * All functions except nacl_audio_stream() should be called only from the
9  * main thread.
10  *
11  * This API is defined in the header file
12  * <code>nacl/nacl_av.h</code>.
13  *
14  * @defgroup NPAPI NPAPI Extensions
15  * @ingroup Libraries
16  * NPAPI extensions for Native Client applications.
17  * Native Client supports a
18  * <a href="../../../documentation/npapi.html">subset of NPAPI</a>,
19  * plus these extensions.
20  * To learn about NPAPI, see
21  * http://developer.mozilla.org/en/Plugins
22  * and
23  * http://developer.mozilla.org/en/Gecko_Plugin_API_Reference.
24  *
25  * This API is defined in the header file
26  * <code>nacl/nacl_npapi.h</code>.
27  *
28  * <b>Note:</b>
29  * NPAPI support is experimental. If you encounter security issues,
30  * bugs, or missing features, please
31  * <a href="http://code.google.com/p/nativeclient/issues">file an issue</a>.
32  *
33  * @defgroup SRPC SRPC
34  * @ingroup Libraries
35  * Simple RPC
36  *
37  * This API is defined in the header file
38  * <code>nacl/nacl_srpc.h</code>.
39  *
40  * @defgroup Pthread Pthread
41  * @ingroup Libraries
42  * A POSIX-based threads API.
43  *
44  * This API is defined in the header file
45  * <code>pthread.h</code>.
46  *
47  * @defgroup syscalls Service Runtime Calls
48  * A service runtime call is analogous
49  * to a system call, in terms of performance.
50  * For this reason, you should avoid unnecessary service runtime calls.
51  *
52  * This API is defined in the header file
53  * <code>sys/nacl_syscalls.h</code>.
54  */