[gstreamermm] Add a main page to the Doxygen documentation.

[José Alburquerque <jaalburqu src gnome org>]

commit 27f3347623b94eb693d19440e61a053194a7ab0c
Author: José Alburquerque <jaalburqu svn gnome org>
Date:   Sun May 23 23:39:08 2010 -0400

    	Add a main page to the Doxygen documentation.
    
    	* docs/Makefile.am:
    	* gstreamer/gstreamermm.h: Add a main page to the Doxygen docs as in
    	other *mm modules.

 ChangeLog               |    8 ++++++++
 docs/Makefile.am        |    3 ++-
 gstreamer/gstreamermm.h |   47 +++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 57 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 3f54e19..c3150b2 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2010-05-23  José Alburquerque  <jaalburqu svn gnome org>
+
+	Add a main page to the Doxygen documentation.
+
+	* docs/Makefile.am:
+	* gstreamer/gstreamermm.h: Add a main page to the Doxygen docs as in
+	other *mm modules.
+
 2010-05-07  José Alburquerque  <jaalburqu svn gnome org>
 
 	Media Player Example: Use the m_* prefix for member variables.
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 42699bf..9ab4b52 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -18,6 +18,7 @@ include $(top_srcdir)/gstreamer/gstreamermm/filelist.am
 
 book_name = $(GSTREAMERMM_MODULE_NAME)
 doc_input = $(addprefix $(top_srcdir)/gstreamer/gstreamermm/,$(files_built_h)) \
-	    $(addprefix $(top_srcdir)/gstreamer/gstreamermm/,$(files_extra_h))
+	    $(addprefix $(top_srcdir)/gstreamer/gstreamermm/,$(files_extra_h)) \
+	    $(top_srcdir)/gstreamer/gstreamermm.h
 
 include $(top_srcdir)/build/doc-reference.am
diff --git a/gstreamer/gstreamermm.h b/gstreamer/gstreamermm.h
index e0e3e20..29b8253 100644
--- a/gstreamer/gstreamermm.h
+++ b/gstreamer/gstreamermm.h
@@ -1,6 +1,53 @@
 #ifndef _GSTREAMERMM_H_
 #define _GSTREAMERMM_H_
 
+/** @mainpage gstreamermm Reference Manual
+ *
+ * @section description Description
+ *
+ * gstreamermm provides C++ bindings for the <a
+ * href="http://gstreamer.freedesktop.org";>GStreamer streaming multimedia
+ * library</a>.  With gstreamermm it is possible to develop applications that
+ * work with multimedia in C++.
+ *
+ * @section features Features
+ *
+ * gstreamermm is developed over <a
+ * href="http://www.gtkmm.org/index.shtml";>glibmm</a>, <a
+ * href="http://libsigc.sourceforge.net/";>libsigc++</a> and <a
+ * href="http://libxmlplusplus.sourceforge.net/";>libxml++</a> and the
+ * functionalities they provide.  This means that, among other things,
+ * referencing and unreferencing of GObjects is handled automatically via
+ * glibmm's automatic pointer class, Glib:RefPtr<>, and libsigc++'s slots are
+ * used for callbacks and signals.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the gstreamermm header:
+ * @code
+ * #include <gstreamermm.h>
+ * @endcode
+ * (You may include individual headers, such as @c gstreamermm/pipeline.h
+ * instead.)
+ *
+ * If your source file is @c program.cc, you can compile it with:
+ * @code
+ * g++ program.cc -o program  `pkg-config --cflags --libs gstreamermm-0.10`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([GSTREAMERMM], [gstreamermm-0.10])
+ * @endcode
+ * Then use the generated @c GSTREAMERMM_CFLAGS and @c GSTREAMERMM_LIBS
+ * variables in the
+ * project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(GSTREAMERMM_CFLAGS)
+ * program_LDADD = $(GSTREAMERMM_LIBS)
+ * @endcode
+ */
+
 #include <gstreamermm/init.h>
 #include <gstreamermm/version.h>