[clutter-box2dmm] Add main page to Doxygen documentation

[David King <davidk src gnome org>]

commit 53fcd4ef418c7b220969e5bd9006e90713d99a4b
Author: David King <davidk openismus com>
Date:   Wed Apr 28 16:58:06 2010 +0200

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

 ChangeLog                       |    9 +++++++++
 clutter-box2d/clutter-box2dmm.h |   33 +++++++++++++++++++++++++++++++++
 doc/Makefile.am                 |    3 ++-
 3 files changed, 44 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 6f4a67d..e756e8e 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2010-04-28  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* doc/Makefile.am: Parse clutter-box2d/clutter-box2dmm.h for
+	documentation.
+	* clutter-box2d/clutter-box2dmm.h: Add main page to Doxygen
+	documentation.
+
 0.9.1:
 
 2010-01-07  Murray Cumming  <murrayc murrayc com>
diff --git a/clutter-box2d/clutter-box2dmm.h b/clutter-box2d/clutter-box2dmm.h
index 6e99c10..d277388 100644
--- a/clutter-box2d/clutter-box2dmm.h
+++ b/clutter-box2d/clutter-box2dmm.h
@@ -20,6 +20,39 @@
 #ifndef LIBCLUTTER_BOX2DMM_H
 #define LIBCLUTTER_BOX2DMM_H
 
+/** @mainpage clutter-box2dmm Reference Manual
+ *
+ * @section description Description
+ *
+ * clutter-box2dmm is a C++ wrapper for clutter-box2d.
+ *
+ * See also the <a href="http://www.clutter-project.org/";>clutter website</a>.
+ *
+ * @section basics Basic Usage
+ * Include the clutter-box2dmm header:
+ * @code
+ * #include <clutter-box2dmm.h>
+ * @endcode
+ * (You may include individual headers, such as @c clutter-box2dmm/box2d.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-box2dmm-0.10`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([CLUTTER_BOX2DMM], [clutter-box2dmm-0.10])
+ * @endcode
+ * Then use the generated @c CLUTTER_BOX2DMM_CFLAGS and @c CLUTTER_BOX2DMM_LIBS
+ * variables in the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(CLUTTER_BOX2DMM_CFLAGS)
+ * program_LDADD = $(CLUTTER_BOX2DMM_LIBS}
+ * @endcode
+ */
+
 /* cluttermm version.  */
 extern const int clutter_box2dmm_major_version;
 extern const int clutter_box2dmm_minor_version;
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ffd682c..07d4711 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -21,6 +21,7 @@ include $(top_srcdir)/clutter-box2d/clutter-box2dmm/filelist.am
 clutter_box2dmm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(CLUTTER_BOX2DMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/clutter-box2d/clutter-box2dmm/,$(clutter_box2dmm_files_h))
+doc_input = $(addprefix $(top_srcdir)/clutter-box2d/clutter-box2dmm/,$(clutter_box2dmm_files_h)) \
+            $(top_srcdir)/clutter-box2d/clutter-box2dmm.h
 
 include $(top_srcdir)/build/doc-reference.am