ti/dsplib/docs/doxygen/doxygen.h

   1 /*
   2  * This is a little header file which doxygen parses to generate the main
   3  * documentation page
   4  */
   5
   6  /**
   7  * @mainpage DSPLIB API Reference
   8  *  This is the main landing page for the DSPLIB API Reference.  You can navigate by
   9  *  functional category using the links provided below or directly to any module (kernel)
  10  *  or it's assocaited soure file using the tabs above.  You can always return to this page
  11  *  via the "Main Page" tab above.
  12  *
  13  *
  14  * @section introduction Introduction
  15  *  The TI C6000 DSPLIB is an optimized DSP Function Library for C programmers. It includes many
  16  *  C-callable, optimized, general-purpose signal-processing routines. These routines are typically
  17  *  used in computationally-intensive real-time applications where optimal execution speed is critical.
  18  *  By using these routines, you can achieve execution speeds considerably faster than equivalent code
  19  *  written in standard ANSI C language. In addition, by providing ready-to-use DSP functions, TI DSPLIB
  20  *  can significantly shorten your DSP application development time.
  21  *
  22  *  The TI DSPLIB includes commonly used DSP routines. Source code is provided that allows you to
  23  *  modify functions to match your specific needs.
  24  *
  25  *  The routines contained in the library are organized into the following seven different functional
  26  *  areas:
  27  *
  28  *
  29  * @section features Features and Benefits
  30  *  - Natural C Source Code
  31  *  - Optimized C code with Intrinsics
  32  *  - C-callable routines, fully compatible with the TI C6x compiler
  33  *  - Fractional Q.15-format operands supported on some benchmarks
  34  *  - Benchmarks (cycle and code size)
  35  *  - Tested against C model
  36  *  - The provided precompiled library was compiled using Code Generation Tools Version 7.4.2
  37  *
  38  *
  39  * @section modules Modules
  40  *
  41  *  - @ref ADAPTIVEFILTER
  42  *  - @ref CORRELATION
  43  *  - @ref FFT
  44  *  - @ref FILTCONV
  45  *  - @ref MATH
  46  *  - @ref MATRIX
  47  *  - @ref MISC
  48  *
  49  */
  50
  51  /** @defgroup  ADAPTIVEFILTER Adaptive filtering     */
  52  /** @defgroup  CORRELATION Correlation               */
  53  /** @defgroup  FFT Fast Fourier Transform            */
  54  /** @defgroup  FILTCONV Filtering and convolution    */
  55  /** @defgroup  MATH Math                             */
  56  /** @defgroup  MATRIX Matrix                         */
  57  /** @defgroup  MISC Miscellaneous                    */
  58
  59