Add cmake target to generate API docs and write some basic API docs where needed.
[qtgstreamer:qtgstreamer.git] / src / main.dox
1 /*! \mainpage QtGstreamer API Reference
2  *
3  * \section introduction Introduction
4  * QtGstreamer provides C++ bindings for <a href="http://www.gstreamer.net">GStreamer</a>
5  * with a Qt-style API, plus some helper classes for integrating GStreamer better in
6  * <a href="http://qt.nokia.com">Qt</a> applications.
7  */
8
9 /*! \namespace QGlib
10  * \brief Wrappers for Glib and GObject classes
11  *
12  * This namespace provides wrapper classes for objects from the Glib and GObject libraries,
13  * plus some helper classes that provide the foundations for building C++/Qt bindings for
14  * GObject-based libraries.
15  */
16
17 /*! \namespace QGst
18  * \brief Wrappers for GStreamer classes
19  *
20  * This namespace provides wrapper classes for GStreamer objects.
21  */
22
23 /*! \example echo/main.cpp
24  * This is a trivial example which echoes the microphone input to the output
25  */
26
27 /*! \example player/main.cpp
28  * This is an example audio player using QtGstreamer
29  */