[gconfmm] Added doxygen main page, though it is not used yet.



commit 66321afc0b7bf55d28b4471fdb6195b67e6764cb
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Jun 3 14:07:53 2010 +0200

    Added doxygen main page, though it is not used yet.
    
    * gconf/gconfmm.h: Added a main page, though this does not seem to be
    used yet, probably because gconfmm does not use mm-common yet.

 ChangeLog       |    7 +++++++
 gconf/gconfmm.h |   32 ++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 0 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 114dc67..79722a6 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-06-03  Murray Cumming  <murrayc murrayc com>
+
+	Added doxygen main page, though it is not used yet.
+
+	* gconf/gconfmm.h: Added a main page, though this does not seem to be 
+	used yet, probably because gconfmm does not use mm-common yet.
+
 2.28.0:
 
 2009-03-27  Murray Cumming  <murrayc murrayc com>
diff --git a/gconf/gconfmm.h b/gconf/gconfmm.h
index fcd7854..be8ad3d 100644
--- a/gconf/gconfmm.h
+++ b/gconf/gconfmm.h
@@ -21,6 +21,38 @@
 #ifndef GCONFMM_H
 #define GCONFMM_H
 
+/** @mainpage gconfmm Reference Manual
+ *
+ * @section description Description
+ *
+ * gconfmm is the official C++ interface for the %GConf client API for 
+ * storing and retrieving configuration data. See Gnome::Conf::Client.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the gconfmm header:
+ * @code
+ * #include <gconfmm.h>
+ * @endcode
+ * (You may include individual headers, such as @c gconfmm/client.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 gconfmm-2.6`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([GCONFMM], [gconfmm-2.4])
+ * @endcode
+ * Then use the generated @c GCONFMM_CFLAGS and @c GCONFMM_LIBS variables in the
+ * project Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(GCONFMM_CFLAGS)
+ * program_LDADD = $(GCONFMM_LIBS)
+ * @endcode
+ */
+ 
 /* gconfmm version.  */
 extern const int gconfmm_major_version;
 extern const int gconfmm_minor_version;



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]