summaryrefslogtreecommitdiff
path: root/glib/glibmm.h
diff options
context:
space:
mode:
authorDavid King <davidk@openismus.com>2010-04-23 17:17:57 +0200
committerMurray Cumming <murrayc@murrayc.com>2010-05-03 23:08:06 +0200
commita02e4b5ec4230a964830abd0e98cda16eafcc3fc (patch)
tree9e74c064d36acf8a85161d7bf42074ab253ba613 /glib/glibmm.h
parent507678af36b9cf651abb1c046ade0a8d28a8464d (diff)
downloadglibmm-a02e4b5ec4230a964830abd0e98cda16eafcc3fc.tar.gz
Further changes to main page documentation
* glib/glibmm.h: Some minor changes to the main page documentation.
Diffstat (limited to 'glib/glibmm.h')
-rw-r--r--glib/glibmm.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/glib/glibmm.h b/glib/glibmm.h
index 0bf2f029..2945add4 100644
--- a/glib/glibmm.h
+++ b/glib/glibmm.h
@@ -25,8 +25,9 @@
* @section description Description
*
* glibmm is the official C++ interface for the popular library %Glib. See also
- * the <em>Programming with gtkmm</em> book for a tutorial on programming with
- * gtkmm and glibmm: http://library.gnome.org/devel/gtkmm-tutorial/stable/
+ * the <a href="http://library.gnome.org/devel/gtkmm-tutorial/stable/">
+ * Programming with gtkmm</a> book for a tutorial on programming with gtkmm and
+ * glibmm.
*
* @section features Features
*
@@ -34,18 +35,19 @@
* - A reference-counting smartpointer for easy memory management.
* - Intermediate types for compatibility with STL containers.
*
- * @section basics Basic usage
+ * @section basics Basic Usage
*
* Include the glibmm header:
* @code
* #include <glibmm.h>
* @endcode
- * This includes every header installed by glibmm, so can slow down
- * compilation, but suffices for this simple example. Assuming that your
- * program source file is @c program.cc, compile it with:
+ * (You may include individual headers, such as @c glibmm/ustring.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 glibmm-2.4`
* @endcode
+ *
* Alternatively, if using autoconf, use the following in @c configure.ac:
* @code
* PKG_CHECK_MODULES([GLIBMM], [glibmm-2.4])