root/branches/libffado-2.0/doc/mainpage.dox

Revision 1192, 0.9 kB (checked in by ppalmers, 16 years ago)

remove development docs that are (partly) outdated. remove some other stale code.

Line 
1 /*
2  * This is the main page of the FFADO reference manual, built using
3  * doxygen.
4  */
5
6 /**
7 @mainpage FFADO - Free Firewire (pro-)Audio Drivers for Linux
8
9 @author Pieter Palmers <pieter.palmers@ffado.org>
10
11 @section intro Introduction
12
13 FFADO is intended as an intermediate layer between the Linux1394 kernel/userspace layer, and the various audio API's (ALSA, jack, ...) present.
14
15 \note Certain parts of the documentation can be outdated. This documentation is also auto-generated, and it can occur that unused classes and interfaces appear in the documentation.
16
17 @see <http://www.ffado.org>
18
19 @section library Client side library
20
21 FFADO presents an interface that can be used to implement backends for various audio
22 API's. Currently the best support is for the JACK backend. It is also intended to implement configuration applications like mixer controls etc..
23
24 The library API's external C interface is defined in:
25         - @ref ffado.h "<libffado/ffado.h>"
26
27 */
Note: See TracBrowser for help on using the browser.