[pangomm] Add main page to Doxygen documentation

[David King <davidk src gnome org>]

commit ba85f73375edde3be3fdbd8ab087fd9f17334b0e
Author: David King <davidk openismus com>
Date:   Sat Apr 17 19:13:59 2010 +0200

    Add main page to Doxygen documentation
    
    * docs/Makefile.am: Parse pango/pangomm.h for documentation.
    * pango/pangomm.h: Add main page to Doxygen documentation.

 ChangeLog        |    7 +++++++
 docs/Makefile.am |    3 ++-
 pango/pangomm.h  |   35 ++++++++++++++++++++++++++++++++---
 3 files changed, 41 insertions(+), 4 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index a1e9d97..e5986ea 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-23  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* docs/Makefile.am: Parse pango/pangomm.h for documentation.
+	* pango/pangomm.h: Add main page to Doxygen documentation.
+
 2.26.1:
 
 2010-04-16  Murray Cumming  <murrayc murrayc com>
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 3fb9c55..35cc297 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -21,7 +21,8 @@ include $(top_srcdir)/pango/pangomm/filelist.am
 pangomm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(PANGOMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/pango/pangomm/,$(pangomm_files_h))
+doc_input = $(addprefix $(top_srcdir)/pango/pangomm/,$(pangomm_files_h)) \
+            $(top_srcdir)/pango/pangomm.h
 
 docimagesdir = $(libdocdir)/images
 dist_docimages_DATA = images/gtkmm_logo.gif images/top.gif
diff --git a/pango/pangomm.h b/pango/pangomm.h
index 8401c76..47f22de 100644
--- a/pango/pangomm.h
+++ b/pango/pangomm.h
@@ -1,5 +1,3 @@
-/* $Id: pangomm.h 2 2003-01-21 13:41:59Z murrayc $ */
-
 /* pangomm - a C++ wrapper for the GLib toolkit
  *
  * Copyright 2002 Free Software Foundation
@@ -22,6 +20,38 @@
 #ifndef _PANGOMM_H
 #define _PANGOMM_H
 
+/** @mainpage pangomm Reference Manual
+ *
+ * @section description Description
+ *
+ * pangomm is the official C++ interface for the font layout library %Pango.
+ * More information on %Pango can be found at http://www.pango.org/
+ *
+ * @section basics Basic usage
+ *
+ * Include the pangomm header:
+ * @code
+ * #include <pangomm.h>
+ * @endcode
+ * This includes every header installed by pangomm, so can slow down
+ * compilation, but suffices for this simple example. Assuming that your
+ * program source file is @c program.cc, compile it with:
+ * @code
+ * g++ program.cc -o program  `pkg-config --cflags --libs pangomm`
+ * @endcode
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([PANGOMM], [pangomm])
+ * @endcode
+ * Then use the generated @c PANGOMM_CFLAGS and @c PANGOMM_LIBS variables in
+ * the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(PANGOMM_CFLAGS)
+ * program_LDADD = $(PANGOMM_LIBS)
+ * @endcode
+ */
+
+
 #include <pangomm/attrlist.h>
 #include <pangomm/context.h>
 #include <pangomm/coverage.h>
@@ -38,4 +68,3 @@
 #include <pangomm/tabarray.h>
 
 #endif /* _PANGOMM_H */
-