summaryrefslogtreecommitdiff
path: root/glib/glibmm.h
diff options
context:
space:
mode:
authorDavid King <davidk@openismus.com>2010-04-16 16:03:49 +0200
committerDavid King <davidk@openismus.com>2010-04-16 16:03:49 +0200
commita912c70fcf94c4a73562de4edcd40ed06dd3bf0a (patch)
tree348aa9b90042539aeb9ffc8d748e9eaff09fe2aa /glib/glibmm.h
parentcdc9d48629cd3d8104f2fbed857635f251633203 (diff)
downloadglibmm-a912c70fcf94c4a73562de4edcd40ed06dd3bf0a.tar.gz
Add main page to Doxygen documentation
* docs/Makefile.am: Parse glib/glibmm.h for documentation. * glib/glibmm.h: Add main page to Doxygen documentation.
Diffstat (limited to 'glib/glibmm.h')
-rw-r--r--glib/glibmm.h25
1 files changed, 25 insertions, 0 deletions
diff --git a/glib/glibmm.h b/glib/glibmm.h
index f4078172..e2ac0072 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>