[glibmm/glibmm-2-24] Further changes to main page documentation
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm/glibmm-2-24] Further changes to main page documentation
- Date: Mon, 3 May 2010 21:08:36 +0000 (UTC)
commit a02e4b5ec4230a964830abd0e98cda16eafcc3fc
Author: David King <davidk openismus com>
Date: Fri Apr 23 17:17:57 2010 +0200
Further changes to main page documentation
* glib/glibmm.h: Some minor changes to the main page documentation.
ChangeLog | 6 ++++++
glib/glibmm.h | 14 ++++++++------
2 files changed, 14 insertions(+), 6 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index eec82f2..1ef78af 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2010-04-27 David King <davidk openismus com>
+
+ Further changes to main page documentation
+
+ * glib/glibmm.h: Some minor changes to the main page documentation.
+
2010-04-23 David King <davidk openismus com>
Improvements to main page documentation
diff --git a/glib/glibmm.h b/glib/glibmm.h
index 0bf2f02..2945add 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])
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]