[libxml++] Documentation main page improvements
- From: David King <davidk src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libxml++] Documentation main page improvements
- Date: Fri, 23 Apr 2010 09:06:11 +0000 (UTC)
commit cac8b503112494b28a6bb10e94a34de1501e4681
Author: David King <davidk openismus com>
Date: Sat Apr 17 18:59:20 2010 +0200
Documentation main page improvements
* libxml++/libxml++.h: Add external links and compilation example.
ChangeLog | 6 ++++++
libxml++/libxml++.h | 31 +++++++++++++++++++++++++------
2 files changed, 31 insertions(+), 6 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index a69ce42..9ec9900 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2010-04-23 David King <davidk openismus com>
+
+ Documentation main page improvements
+
+ * libxml++/libxml++.h: Add external links and compilation example.
+
2010-04-16 David King <davidk openismus com>
Minor documentation update
diff --git a/libxml++/libxml++.h b/libxml++/libxml++.h
index 963764a..e99b580 100644
--- a/libxml++/libxml++.h
+++ b/libxml++/libxml++.h
@@ -11,14 +11,33 @@
*
* @section description Description
*
- * libxml++ is a C++ wrapper for the libxml2 XML parser library. libxml2 and
- * glibmm are required. libxml++ presents a simple C++-like API that can
- * achieve common tasks with less code.
+ * libxml++ is a C++ wrapper for the libxml2 XML parser library. It presents a
+ * simple C++-like API that can achieve common tasks with less code.
*
- * @section use Use
+ * See also the libxml++ website: http://libxmlplusplus.sourceforge.net/
*
- * To use libxml++ in your application, include one of the header files. A
- * @c pkg-config file is provided to simplify compilation.
+ * @section basics Basic usage
+ *
+ * Include the libxml++ header:
+ * @code
+ * #include <libxml++.h>
+ * @endcode
+ * This includes every header installed by libxml++, so can slow down
+ * compilation, but suffices for this simple example. Assuming that your
+ * program source files is @c program.cc, compile it with:
+ * @code
+ * g++ program.cc -o program `pkg-config --cflags --libs libxml++-2.6`
+ * @endcode
+ * Alternatively, if using autoconf, use the following in @c configure.ac:
+ * @code
+ * PKG_CHECK_MODULES([LIBXMLXX], [libxml++-2.6])
+ * @endcode
+ * Then use the generated @c LIBXMLXX_CFLAGS and @c LIBXMLXX_LIBS variables in
+ * the project @c Makefile.am files. For example:
+ * @code
+ * program_CPPFLAGS = $(LIBXMLXX_CFLAGS)
+ * program_LDADD = $(LIBXMLXX_LIBS)
+ * @endcode
*/
#include <libxml++/exceptions/internal_error.h>
#include <libxml++/exceptions/parse_error.h>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]