Move the examples documentation in a separate file.

1 files changed, 34 insertions, 0 deletions

diff --git a/examples/examples.dox b/examples/examples.dox
new file mode 100644
index 0000000..f983c18
--- /dev/null
+++ b/examples/examples.dox
@@ -0,0 +1,34 @@
+/*
+    Copyright (C) 2011 Collabora Ltd.
+      @author George Kiagiadakis <george.kiagiadakis@collabora.co.uk>
+
+    This library is free software; you can redistribute it and/or modify
+    it under the terms of the GNU Lesser General Public License as published
+    by the Free Software Foundation; either version 2.1 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/*! \example player/main.cpp
+ * This is an example audio player using QtGStreamer
+ */
+
+/*! \example appsink-src/main.cpp
+ * This example demonstrates how to use QGst::Utils::ApplicationSource and
+ * QGst::Utils::ApplicationSink to create a custom source and sink respectively.
+ *
+ * In this example, we have two pipelines, one pipeline that gets data from a file,
+ * decodes the audio stream and sends the audio buffers to appsink, and a second
+ * pipeline that gets data from appsrc and pushes them to an audio sink. Appsink
+ * from the first pipeline is linked with appsrc from the second pipeline in our
+ * code, by listening to appsink's newBuffer() signal, getting the buffer
+ * and pushing it to appsrc with the pushBuffer() method. The result is a choppy
+ * audio player.
+ */