[clutter-gtkmm] Add main page to Doxygen documentation

[David King <davidk src gnome org>]

commit a04ecd5d8ef75550ad24a1617b737c9f0b267e1d
Author: David King <davidk openismus com>
Date:   Wed Apr 28 16:34:32 2010 +0200

    Add main page to Doxygen documentation
    
    * doc/Makefile.am: Parse clutter-gtk/clutter-gtkmm.h for documentation.
    * clutter-gtk/clutter-gtkmm.h: Add main page to Doxygen documentation.

 ChangeLog                   |    7 +++++++
 clutter-gtk/clutter-gtkmm.h |   34 ++++++++++++++++++++++++++++++++++
 doc/Makefile.am             |    3 ++-
 3 files changed, 43 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 993794e..634f5af 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-28  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* doc/Makefile.am: Parse clutter-gtk/clutter-gtkmm.h for documentation.
+	* clutter-gtk/clutter-gtkmm.h: Add main page to Doxygen documentation.
+
 2010-04-05  Murray Cumming  <murrayc murrayc com>
 
   Build with a more recent clutter-gtk.
diff --git a/clutter-gtk/clutter-gtkmm.h b/clutter-gtk/clutter-gtkmm.h
index 27b0940..55583da 100644
--- a/clutter-gtk/clutter-gtkmm.h
+++ b/clutter-gtk/clutter-gtkmm.h
@@ -20,6 +20,40 @@
 #ifndef LIBCLUTTER_GTKMM_H
 #define LIBCLUTTER_GTKMM_H
 
+/** @mainpage clutter-gtkmm Reference Manual
+ *
+ * @section description Description
+ *
+ * clutter-gtkmm is a C++ wrapper for clutter-gtk.
+ *
+ * See also the <a href="http://www.clutter-project.org/";>clutter website</a>.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the clutter-gtkmm header:
+ * @code
+ * #include <clutter-gtkmm.h>
+ * @endcode
+ * (You may include individual headers, such as @c clutter-gtkmm/viewport.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 clutter-gtkmm-1.0`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([CLUTTER_GTKMM], [clutter-gtkmm-1.0])
+ * @endcode
+ * Then use the generated @c CLUTTER_GTKMM_CFLAGS and @c CLUTTER_GTKMM_LIBS
+ * variables in the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(CLUTTER_GTKMM_CFLAGS)
+ * program_LDADD = $(CLUTTER_GTKMM_LIBS)
+ * @endcode
+ */
+
 #include <cluttermm.h>
 #include <clutter-gtkmmconfig.h>
 #include <clutter-gtkmm/embed.h>
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 0aa09c2..b9660c4 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -21,6 +21,7 @@ include $(top_srcdir)/clutter-gtk/clutter-gtkmm/filelist.am
 clutter_gtkmm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(CLUTTER_GTKMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/clutter-gtk/clutter-gtkmm/,$(clutter_gtkmm_files_h))
+doc_input = $(addprefix $(top_srcdir)/clutter-gtk/clutter-gtkmm/,$(clutter_gtkmm_files_h)) \
+            $(top_srcdir)/clutter-gtk/clutter-gtkmm.h
 
 include $(top_srcdir)/build/doc-reference.am