[goocanvasmm] Add main page to Doxygen documentation

[David King <davidk src gnome org>]

commit 8be1f2b8db0652170de50e31e78f820d92c091d8
Author: David King <davidk openismus com>
Date:   Fri Apr 23 17:04:21 2010 +0200

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

 ChangeLog               |    7 +++++++
 doc/Makefile.am         |    5 +++--
 goocanvas/goocanvasmm.h |   35 +++++++++++++++++++++++++++++++----
 3 files changed, 41 insertions(+), 6 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 1f0e951..5690736 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-23  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* doc/Makefile.am: Parse goocanvas/goocanvasmm.h for documentation.
+	* goocanvas/goocanvasmm.h: Add main page to Doxygen documentation.
+
 0.15.2:
 
 2009-09-18  Daniel Elstner  <danielk openismus com>
diff --git a/doc/Makefile.am b/doc/Makefile.am
index b9109d1..3f3b4dc 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
-## Copyright (c) 2009  Joe Hacker <joe example com>
+## Copyright (c) 2009, 2010 Openismus GmbH
 ##
 ## This file is part of goocanvasmm.
 ##
@@ -21,6 +21,7 @@ include $(top_srcdir)/goocanvas/goocanvasmm/filelist.am
 goocanvasmm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(GOOCANVASMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/goocanvas/goocanvasmm/,$(goocanvasmm_files_h))
+doc_input = $(addprefix $(top_srcdir)/goocanvas/goocanvasmm/,$(goocanvasmm_files_h)) \
+            $(top_srcdir)/goocanvas/goocanvasmm.h
 
 include $(top_srcdir)/build/doc-reference.am
diff --git a/goocanvas/goocanvasmm.h b/goocanvas/goocanvasmm.h
index 37e13ea..88b3f41 100644
--- a/goocanvas/goocanvasmm.h
+++ b/goocanvas/goocanvasmm.h
@@ -1,4 +1,3 @@
-/* $Id: goocanvasmm.h,v 1.4 2005/08/23 15:43:32 murrayc Exp $ */
 /* goocanvasmm - a C++ wrapper for libgoocanvas
  *
  * Copyright 1999-2001 Free Software Foundation
@@ -21,9 +20,37 @@
 #ifndef LIBGOOCANVASMM_H
 #define LIBGOOCANVASMM_H
 
-//extern "C" {
-//#include <gtk/gtk.h>
-//}
+/** @mainpage goocanvasmm Reference Manual
+ *
+ * @section description Description
+ *
+ * goocanvasmm is a C++ binding for goocanvas. See also
+ * <a href="http://live.gnome.org/GooCanvas";>the goocanvas website</a> for a
+ * description of goocanvas.
+ *
+ * @section basics Basic Usage
+ * Include the goocanvasmm header:
+ * @code
+ * #include <goocanvasmm.h>
+ * @endcode
+ * (You may include individual headers, such as goocanvasmm/rect.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 goocanvasmm-1.0`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([GOOCANVASMM], [goocanvasmm-1.0])
+ * @endcode
+ * Then use the generated @c GOOCANVASMM_CFLAGS and @c GOOCANVASMM_LIBS
+ * variables in the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(GOOCANVASMM_CFLAGS)
+ * program_LDADD = $(GOOCANVASMM_LIBS)
+ * @endcode
+ */
 
 /* goocanvasmm version.  */
 extern const int goocanvasmm_major_version;