documentation/index.dox

   1 /** \mainpage Native Client API Reference Documentation
   2
   3  This reference documentation describes the APIs
   4  that untrusted Native Client (NaCl) modules can use.
   5  For additional documentation and information
   6  about Native Client, see the
   7  <a href="../../../README.html">README</a>.
   8
   9  On this page:
  10  <ul>
  11  <li> @ref modules </li>
  12  <li> @ref locations </li>
  13  <li> @ref about </li>
  14  </ul>
  15
  16  \section modules API categories
  17
  18  The Native Client APIs fall into three general categories:
  19
  20  <ul>
  21    <li> Standard APIs that are supported but not documented here
  22      <ul>
  23        <li> <a href="http://sourceware.org/newlib/libc.html">Newlib C library</a></li>
  24        <li> <a href="http://sourceware.org/newlib/libm.html">Newlib math library</a></li>
  25        <li> <a href="http://gcc.gnu.org/libstdc++/">GNU standard C++ library</a></li>
  26        <li> A subset of
  27             <a href="https://developer.mozilla.org/en/Gecko_Plugin_API_Reference">NPAPI</a>;
  28             for information on the differences, see
  29             <a href="../../../documentation/npapi.html">NPAPI Support</a>
  30             </li>
  31      </ul>
  32    </li>
  33    <li> <a href="group___libraries.html">Libraries</a>
  34         defined by Native Client
  35      <ul>
  36        <li> <a href="group__audio__video.html">Basic Multimedia Interface</a> -
  37        A basic audio/video library</li>
  38        <li> <a href="group___n_p_a_p_i.html">NPAPI Extensions</a> -
  39        Native Client extensions to NPAPI</li>
  40        <li> <a href="group___s_r_p_c.html">SRPC</a> -
  41        Simple RPC </li>
  42        <li> <a href="group___pthread.html">Pthread</a> -
  43        A thread library based on POSIX threads </li>
  44      </ul>
  45    </li>
  46    <li> <a href="group__syscalls.html">Service Runtime Calls</a>
  47         supported by Native Client
  48    </li>
  49  </ul>
  50
  51  \section locations SDK file locations
  52
  53  <p>
  54  The Native Client SDK is under
  55  <code>nacl/googleclient/third_party/nacl_sdk</code>.
  56  The APIs you can use are defined in <code>.h</code> files under
  57  <code>nacl/googleclient/third_party/nacl_sdk/<em>platform</em>/sdk/nacl-sdk/nacl/include/</code>
  58  &mdash; for example,
  59  <code>nacl/googleclient/third_party/nacl_sdk/linux/sdk/nacl-sdk/nacl/include/nacl/nacl_av.h</code>.
  60  The SDK tools are under
  61  <code>nacl/googleclient/third_party/nacl_sdk/<em>platform</em>/sdk/nacl-sdk/bin/</code>
  62  &mdash; for example,
  63  <code>nacl/googleclient/third_party/nacl_sdk/mac/sdk/nacl-sdk/bin/nacl-gcc</code>.
  64  </p>
  65
  66  \section about About this doc
  67
  68  <p>
  69  The tabs at the top of each page
  70  take you to the following sections:
  71  </p>
  72
  73  <ul>
  74  <li> <b>Main Page</b> - This page </li>
  75  <li> <a href="modules.html"><b>Modules</b></a> -
  76       Lets you find API by functional area
  77       &mdash; for example,
  78       <a href="group___libraries.html">Libraries</a> or
  79       <a href="group__syscalls.html">Service Runtime Calls</a>.
  80       </li>
  81  <li> <a href="annotated.html"><b>Data Structures</b></a> -
  82       List of data structures in Native Client.
  83       </li>
  84  <li> <a href="files.html"><b>Files</b></a> -
  85       The header files used to generate this documentation.
  86       Includes file descriptions, links to generated doc,
  87       and links to each header file.
  88       Don't miss the <a href="globals.html">File member index</a>.
  89       </li>
  90  </ul>
  91
  92  */