[gtkmm] Add main page to Doxygen documentation



commit 97c1b7865c894e13def3f3b657fd1d14ade688e8
Author: David King <davidk openismus com>
Date:   Fri Apr 16 15:25:21 2010 +0200

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

 ChangeLog        |    7 +++++++
 docs/Makefile.am |    3 ++-
 gtk/gtkmm.h      |   39 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 48 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index f9e051d..60019ae 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 gtk/gtkmm.h for documentation.
+	* gtk/gtkmm.h: Add main page to Doxygen documentation.
+
 2.20.2:
 
 2010-04-13  José Alburquerque  <jaalburqu svn gnome org>
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 1539508..700aa17 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -29,7 +29,8 @@ gtkmm_files_h = $(gtkmm_files_built_h) $(filter-out wrap_init.h,$(gtkmm_files_ex
 book_name = $(GTKMM_MODULE_NAME)
 doc_input = $(addprefix $(top_srcdir)/atk/atkmm/,$(atkmm_files_h)) \
             $(addprefix $(top_srcdir)/gdk/gdkmm/,$(gdkmm_files_h)) \
-            $(addprefix $(top_srcdir)/gtk/gtkmm/,$(gtkmm_files_h))
+            $(addprefix $(top_srcdir)/gtk/gtkmm/,$(gtkmm_files_h)) \
+	    $(top_srcdir)/gtk/gtkmm.h
 
 docimagesdir = $(libdocdir)/images
 dist_docimages_DATA = images/gtkmm_logo.gif images/top.gif
diff --git a/gtk/gtkmm.h b/gtk/gtkmm.h
index d2116b9..2d25b9f 100644
--- a/gtk/gtkmm.h
+++ b/gtk/gtkmm.h
@@ -21,6 +21,45 @@
 #ifndef _GTKMM_H
 #define _GTKMM_H
 
+/** @mainpage gtkmm Reference Manual
+ *
+ * @section description Description
+ *
+ * gtkmm is the official C++ interface for the popular GUI library GTK+.
+ * Highlights include typesafe callbacks, and a comprehensive set of widgets
+ * that are easily extensible via inheritance.
+ *
+ * @section features Features
+ *
+ * - Use inheritance to derive custom widgets.
+ * - Type-safe signal handlers, in standard C++.
+ * - Polymorphism.
+ * - Use of Standard C++ Library, including strings, containers, and iterators.
+ * - Full internationalisation with UTF8.
+ * - Complete C++ memory management.
+ *   - Object composition.
+ *   - Automatic deallocation of dynamically allocated widgets.
+ * - Full use of C++ namespaces.
+ * - No macros.
+ * - Cross-platform: Linux (gcc), FreeBSD (gcc), NetBSD (gcc), Solaris (gcc,
+ *   Forte), Win32 (gcc, MSVC++ .Net 2003), MacOS X (gcc), others.
+ * - Free software and free of cost for both Open Source and proprietary
+ *   development.
+ * - Discussed, designed and implemented in public.
+ *
+ * @section license License
+ *
+ * gtkmm is free software distributed under the GNU Lesser General Public
+ * License (LGPL).
+ *
+ * @section releases Release Schedule
+ *
+ * gtkmm 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 GTK+ and GNOME APIs as soon as
+ * possible.
+ */
+
 /* Gtkmm version.  */
 extern const int gtkmm_major_version;
 extern const int gtkmm_minor_version;



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