[libgdamm] Add main page to Doxygen documentation

[David King <davidk src gnome org>]

commit 9c9e61975e9237f771379f41fe3903d6809df1fa
Author: David King <davidk openismus com>
Date:   Tue Apr 27 22:19:18 2010 +0200

    Add main page to Doxygen documentation
    
    * docs/Makefile.am: Parse libgda/libgdamm.h for Doxygen documentation.
    * libgda/libgdamm.h: Add main page to generated documentation.

 ChangeLog         |    7 +++++++
 docs/Makefile.am  |    3 ++-
 libgda/libgdamm.h |   37 +++++++++++++++++++++++++++++++++----
 3 files changed, 42 insertions(+), 5 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 0b2abce..80edbda 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-27  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* docs/Makefile.am: Parse libgda/libgdamm.h for Doxygen documentation.
+	* libgda/libgdamm.h: Add main page to generated documentation.
+
 2010-04-27  David King  <davidk Openismus com>
 
 	Remove Debian packaging
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 3b92b05..54bb5b3 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -21,6 +21,7 @@ include $(top_srcdir)/libgda/libgdamm/filelist.am
 libgdamm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
 
 book_name = $(LIBGDAMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/libgda/libgdamm/,$(libgdamm_files_h))
+doc_input = $(addprefix $(top_srcdir)/libgda/libgdamm/,$(libgdamm_files_h)) \
+            $(top_srcdir)/libgda/libgdamm.h
 
 include $(top_srcdir)/build/doc-reference.am
diff --git a/libgda/libgdamm.h b/libgda/libgdamm.h
index a9a9aa0..b630b9a 100644
--- a/libgda/libgdamm.h
+++ b/libgda/libgdamm.h
@@ -1,4 +1,3 @@
-/* $Id$ */
 /* libgdamm - a C++ wrapper for libgda
  *
  * Copyright 1999-2001 Free Software Foundation
@@ -21,9 +20,39 @@
 #ifndef LIBGDAMM_H
 #define LIBGDAMM_H
 
-//extern "C" {
-//#include <gtk/gtk.h>
-//}
+/** @mainpage libgdamm Reference Manual
+ *
+ * @section description Description
+ *
+ * libgdamm is a C++ wrapper for libgda.
+ *
+ * See also the <a href="http://www.gnome-db.org/";>libgda website</a>.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the libgdamm header:
+ * @code
+ * #include <libgdamm.h>
+ * @endcode
+ * (You may include individual headers, such as @c libgdamm/connection.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 libgdamm-4.0`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([LIBGDAMM], [libgdamm-4.0])
+ * @endcode
+ * Then use the generated @c LIBGDAMM_CFLAGS and @c LIBGDAMM_LIBS variables in
+ * the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(LIBGDAMM_CFLAGS)
+ * program_LDADD = $(LIBGDAMM_LIBS)
+ * @endcode
+ */
 
 /* libgdamm version.  */
 extern const int libgdamm_major_version;