[gtkglextmm] Add a doxgen mainpage



commit a65460dc2b3456b3daf305ef44d5a42c12722b1d
Author: Simon Wenner <simon wenner ch>
Date:   Sat Jun 5 12:48:00 2010 +0000

    Add a doxgen mainpage
    
    This is needed to get on developer.gnome.org.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=620659

 gtkglext/gtkglmm.h |   36 ++++++++++++++++++++++++++++++++++++
 1 files changed, 36 insertions(+), 0 deletions(-)
---
diff --git a/gtkglext/gtkglmm.h b/gtkglext/gtkglmm.h
index 3d00f2d..fb257b6 100644
--- a/gtkglext/gtkglmm.h
+++ b/gtkglext/gtkglmm.h
@@ -20,6 +20,42 @@
 #ifndef _GTKGLMM_H
 #define _GTKGLMM_H
 
+/** @mainpage gtkglextmm Reference Manual
+ *
+ * @section description Description
+ *
+ * GtkGLExt is an OpenGL extension to <a href="http://www.gtk.org/";>GTK+</a>.
+ * It provides additional GDK objects which support OpenGL rendering in GTK+ and
+ * GtkWidget API add-ons to make GTK+ widgets OpenGL-capable.
+ *
+ * For instance, see Gtk::GL::Widget, Gtk::GL::DrawingArea and Gdk::GL::Window.
+ *
+ * See also the <a href="examples.html">Examples</a> page.
+ *
+ * @section basics Basic Usage
+ *
+ * Include the gtkglextmm header:
+ * @code
+ * #include <gtkglmm.h>
+ * @endcode
+ *
+ * If your source file is @c program.cc, you can compile it with:
+ * @code
+ * g++ program.cc -o program `pkg-config --cflags --libs gtkglextmm-1.2`
+ * @endcode
+ *
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([GTKGLEXTMM], [gtkglextmm-1.2])
+ * @endcode
+ * Then use the generated @c GTKGLEXTMM_CFLAGS and @c GTKGLEXTMM_LIBS variables
+ * in the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(GTKGLEXTMM_CFLAGS)
+ * program_LDADD = $(GTKGLEXTMM_LIBS)
+ * @endcode
+ */
+
 #include <gdkglmm.h>
 
 #include <gtkmm/gl/defs.h>


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