[cluttermm] Add main page to Doxygen documentation

[David King <davidk src gnome org>]

commit c893184668eafaadccb9bd4d9d43bafa9ee7571a
Author: David King <davidk openismus com>
Date:   Tue Apr 27 22:41:18 2010 +0200

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

 ChangeLog           |    7 +++++++
 clutter/cluttermm.h |   33 +++++++++++++++++++++++++++++++++
 doc/Makefile.am     |    3 ++-
 3 files changed, 42 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index e9396da..64b23c4 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-27  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* doc/Makefile.am: Parse clutter/cluttermm.h for documentation.
+	* clutter/cluttermm.h: Add main page to Doxygen documentation.
+
 2010-04-19  Murray Cumming  <murrayc murrayc com>
 
 	Actor, Animation: Updated signals and propeties for clutter 1.2.
diff --git a/clutter/cluttermm.h b/clutter/cluttermm.h
index 8c73561..7c0eda7 100644
--- a/clutter/cluttermm.h
+++ b/clutter/cluttermm.h
@@ -19,6 +19,39 @@
 #ifndef CLUTTERMM_H_INCLUDED
 #define CLUTTERMM_H_INCLUDED
 
+/** @mainpage cluttermm Reference Manual
+ *
+ * @section description Description
+ *
+ * cluttermm is a C++ wrapper for clutter.
+ *
+ * See also the <a href="http://www.clutter-project.org/";>clutter website</a>.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the cluttermm header:
+ * @code
+ * #include <cluttermm.h>
+ * @endcode
+ * (You may include individual headers, such as @c cluttermm/actor.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 cluttermm-1.0`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([CLUTTERMM], [cluttermm-1.0])
+ * @endcode
+ * Then use the generated @c CLUTTERMM_CFLAGS and @c CLUTTERMM_LIBS variables
+ * in the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(CLUTTERMM_CFLAGS)
+ * program_LDADD = $(CLUTTERMM_LIBS)
+ * @endcode
+ */
+
 #include <glibmm.h>
 #include <cluttermmconfig.h>
 #include <cluttermm/actor.h>
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 629509a..d3629f0 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -21,6 +21,7 @@ include $(top_srcdir)/clutter/cluttermm/filelist.am
 cluttermm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(CLUTTERMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/clutter/cluttermm/,$(cluttermm_files_h))
+doc_input = $(addprefix $(top_srcdir)/clutter/cluttermm/,$(cluttermm_files_h)) \
+            $(top_srcdir)/clutter/cluttermm.h
 
 include $(top_srcdir)/build/doc-reference.am