native_client_sdk/src/documentation/index.dox

   1 /** @mainpage c_salt Reference Documentation
   2
   3  This reference documentation describes the c_salt API, which is
   4  an open-source API for browser plugins that layers on
   5  top of the Pepper API and the NPAPI.
   6  You can use the c_salt API
   7  in <a href="http://code.google.com/p/nativeclient-sdk">Native Client</a>
   8  modules to communicate with the Google Chrome browser.
   9  This page has the following contents:
  10
  11   - @ref reading
  12   - @ref modules
  13   - @ref about
  14
  15
  16  @section reading Before you start
  17
  18  This documentation assumes that you have read and understood
  19  the following pages in the Native Client SDK project:
  20
  21  - <a href="http://code.google.com/p/nativeclient-sdk/">Getting started</a>
  22
  23
  24  @section modules API categories
  25
  26 The c_salt API consists of a C++ API in the c_salt namespace.
  27
  28 (Details TBD)...
  29
  30
  31  @section about About this doc
  32
  33  <p>
  34  The tabs at the top of each page take you to the following sections.
  35  </p>
  36
  37  - <b>Main Page</b>: This page
  38  - <a href="modules.html"><b>Modules</b></a>:  Lets you find API by functional area
  39  - <a href="annotated.html"><b>Data Structures</b></a>:
  40       List of classes and data structures in c_salt.
  41  - <a href="files.html"><b>Files</b></a>:
  42       The header files used to generate this documentation,
  43       with file descriptions and links to generated doc.
  44       Don't miss the <a href="globals.html">File member index</a>.
  45
  46  */