[glibmm] Add main page to Doxygen documentation



commit a912c70fcf94c4a73562de4edcd40ed06dd3bf0a
Author: David King <davidk openismus com>
Date:   Fri Apr 16 16:03:49 2010 +0200

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

 ChangeLog        |    7 +++++++
 docs/Makefile.am |    3 ++-
 glib/glibmm.h    |   25 +++++++++++++++++++++++++
 3 files changed, 34 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 633c229..c3550de 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-16  David King  <davidk openismus com>
+
+	Add main page to Doxygen documentation
+
+	* docs/Makefile.am: Parse glib/glibmm.h for documentation.
+	* glib/glibmm.h: Add main page to Doxygen documentation.
+
 2.24.1:
 
 2010-04-13  José Alburquerque  <jaalburqu svn gnome org>
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 010f501..d48a01b 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -25,7 +25,8 @@ giomm_files_h  = $(filter-out wrap_init.h,$(giomm_files_built_h) $(giomm_files_e
 
 book_name = $(GLIBMM_MODULE_NAME)
 doc_input = $(addprefix $(top_srcdir)/glib/glibmm/,$(glibmm_files_h)) \
-            $(addprefix $(top_srcdir)/gio/giomm/,$(giomm_files_h))
+            $(addprefix $(top_srcdir)/gio/giomm/,$(giomm_files_h)) \
+            $(top_srcdir)/glib/glibmm.h
 
 doctooldir = $(datadir)/$(GLIBMM_MODULE_NAME)/doctool
 dist_doctool_DATA = doc-install.pl doc-postprocess.pl doxygen.css tagfile-to-devhelp2.xsl
diff --git a/glib/glibmm.h b/glib/glibmm.h
index f407817..e2ac007 100644
--- a/glib/glibmm.h
+++ b/glib/glibmm.h
@@ -22,6 +22,31 @@
 #ifndef _GLIBMM_H
 #define _GLIBMM_H
 
+/** @mainpage glibmm Reference Manual
+ *
+ * @section description Description
+ *
+ * glibmm is the official C++ interface for the popular library Glib.
+ *
+ * @section features Features
+ *
+ * - A UTF-8 string class that has the interface of std::string.
+ * - A reference-counting smartpointer for easy memory management.
+ * - Intermediate types for compatibility with STL containers.
+ *
+ * @section license License
+ *
+ * glibmm is free software distributed under the GNU Lesser General Public
+ * License (LGPL).
+ *
+ * @section releases Release Schedule
+ *
+ * glibmm follows the official GNOME Platform Bindings release schedule. This
+ * guarantees API/ABI-stability and new releases on a predictable schedule,
+ * delivering C++ API for the underlying Glib and GNOME APIs as soon as
+ * possible.
+ */
+
 #include <glibmmconfig.h>
 //#include <glibmm/i18n.h> //This must be included by the application, after system headers such as <iostream>.
 #include <glibmm/arrayhandle.h>



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