[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [Phonon/4.1] a63b613: start of a mainpage for Phonon docs
From:       Matthias Kretz <kretz () kde ! org>
Date:       2011-01-02 21:58:46
Message-ID: 20110102215846.E7027A612B () git ! kde ! org
[Download RAW message or body]


	A	 Mainpage.dox	 [License: Trivialfile.]

commit a63b613aab94bcae28070318c5f74a6a5c7f7dba
Author: Matthias Kretz <kretz@kde.org>
Date:   Thu Mar 23 14:00:56 2006 +0000

    start of a mainpage for Phonon docs

diff --git a/Mainpage.dox b/Mainpage.dox
new file mode 100644
index 0000000..00ef7ed
--- /dev/null
+++ b/Mainpage.dox
@@ -0,0 +1,28 @@
+/** \file Mainpage.dox
+    \brief Mainpage of the %Phonon API Documentation.
+*/
+/** \mainpage The %Phonon API.
+
+\section phonon_intro Introduction
+%Phonon is the Multimedia API for %KDE. You should evaluate whether %Phonon
+supplies all you need before looking at frameworks like gstreamer or NMM. The
+range of applications goes from full featured media players and capture
+applications to voice/video chats.
+
+\section phonon_examples Examples
+Not yet...
+
+\section phonon_frontend The Frontend API
+ - for simple playback use \ref Phonon::SimplePlayer
+ - add ref to overview of frontend objects
+ - \ref Phonon "The Phonon namespace"
+ - \ref Phonon::Ui "The Phonon::Ui namespace"
+ - \ref Phonon::MediaObject "The central class for playback functionality (MediaObject)"
+
+\section phonon_backend Backend Development
+If you want to write a new backend for %Phonon this is for you:
+ - \ref Phonon::Ifaces
+ - \ref Phonon::Ui::Ifaces
+ - \ref Phonon::Ifaces::Backend
+
+*/
[prev in list] [next in list] [prev in thread] [next in thread]