PASDK-258:Merge remote-tracking branch 'origin/dev_pasdk_frank_pasdk258Alpha4Release'
[processor-sdk/performance-audio-sr.git] / psdk_cust / libarch_k2g_1_0_1_0 / docs / doxygen / mainpage.dox
1 /*
2  * This is a little header file which doxygen parses to generate the main
3  * documentation page
4  */
6 /*! \mainpage LibArch API Reference
7  *
8  * @section introduction Introduction
9  * Library Architecture and Framework provides an abstraction layer for multi-core 
10  * DSP library development. It abstracts out from libraries the platform dependent 
11  * complexities including:
12  *    - Memory management 
13  *    - Data transfers (internal memory and external memory)
14  *    - Cache configuration
15  * 
16  * The Library Architecture and Framework API can be used by library developers 
17  * as well as library integrators for fast development of portable software, by
18  * eliminating the need to deal with platform- or OS-dependent complexities 
19  * mentioned above. 
20  * 
21  * \image html libarch_block_diagram.jpg
22  *
23  * @section modules Modules
24  * This release provides API in three modules, each corresponding to one area of 
25  * abstracted complexity listed above. Refer to links below for detailed documentation
26  * of each module:
27  *
28  *  - @ref libarch_memmgt
29  *  - @ref libarch_cachecfg
30  *  - @ref libarch_datatrans
31  *
32  */