[libsigc++2] Improvements to main page documentation



commit 164127dc1915f3d817f91ce9dbfb5288442af5b6
Author: David King <davidk openismus com>
Date:   Fri Apr 23 17:34:11 2010 +0200

    Improvements to main page documentation
    
    * sigc++/sigc++.h: Minor improvements.

 ChangeLog       |    6 ++++++
 sigc++/sigc++.h |   11 ++++++-----
 2 files changed, 12 insertions(+), 5 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index e38f353..89cd344 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2010-04-27  David King  <davidk openismus com>
+
+	Improvements to main page documentation
+
+	* sigc++/sigc++.h: Minor improvements.
+
 2010-04-23  David King  <davidk openismus com>
 
 	Add main page to Doxygen documentation
diff --git a/sigc++/sigc++.h b/sigc++/sigc++.h
index df63375..7070f9c 100644
--- a/sigc++/sigc++.h
+++ b/sigc++/sigc++.h
@@ -33,7 +33,7 @@
  * For instance, see @ref adaptors "Adaptors", @ref sigcfunctors "Functors",
  * @ref lambdas "Lambdas", @ref signal "Signals" and @ref slot "Slots".
  *
- * See also the libsigc++ website: http://libsigc.sourceforge.net/
+ * See also <a href="http://libsigc.sourceforge.net/";>the libsigc++ website</a>.
  *
  * @section features Features
  *
@@ -49,18 +49,19 @@
  * - A variety of adaptors to change the callback signature: bind, hide,
  *   retype, compose and lambda call groups
  *
- * @section basics Basic usage
+ * @section basics Basic Usage
  *
  * Include the libsigc++ header:
  * @code
  * #include <sigc++/sigc++.h>
  * @endcode
- * This includes every header installed by libsigc++, 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 sigc++/bind.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 sigc++-2.0`
  * @endcode
+ *
  * Alternatively, if using autoconf, use the following in @c configure.ac:
  * @code
  * PKG_CHECK_MODULES([LIBSIGCXX], [sigc++-2.0])



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