[libxml++] Minor documentation update
- From: David King <davidk src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libxml++] Minor documentation update
- Date: Fri, 16 Apr 2010 12:27:43 +0000 (UTC)
commit 08069a72c868d14aeff5d1e73331fb672a6fcbf4
Author: David King <davidk openismus com>
Date: Fri Apr 16 14:26:50 2010 +0200
Minor documentation update
* docs/index.html: Link to latest gnome.org resources.
* libxml++/libxml++.h: Add minimal documentation for main page.
ChangeLog | 7 +++++++
docs/index.html | 6 +++---
libxml++/libxml++.h | 13 +++++++++++++
3 files changed, 23 insertions(+), 3 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index bb6655f..a69ce42 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2010-04-16 David King <davidk openismus com>
+
+ Minor documentation update
+
+ * docs/index.html: Link to latest gnome.org resources.
+ * libxml++/libxml++.h: Add minimal documentation for main page.
+
2010-04-06 Murray Cumming <murrayc murrayc com>
.pc file: Add datarootdir.
diff --git a/docs/index.html b/docs/index.html
index d45d52c..a4b82c6 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -30,13 +30,13 @@ libxml++ is a C++ wrapper for the <a href="http://www.xmlsoft.org">libxml</a> XM
</ul>
<h2>Documentation</h2>
-<p>The short <a href="docs/manual/html/index.html">manual</a> gives an overview of the libxml++ API. You can also browse online the <a href="docs/reference/html/hierarchy.html">reference documentation</a>.
+<p>The short <a href="manual/html/index.html">manual</a> gives an overview of the libxml++ API. You can also browse online the <a href="http://library.gnome.org/devel/libxml++/stable/">reference documentation</a>.
</p>
</ul>
<h2>Development</h2>
-<p>Libxml++ uses the GNOME <a href="http://svn.gnome.org/viewvc/libxml%2B%2B/">Subversion repository</a>.</p>
-<p>Bugs and patches are tracked in GNOME's bugzilla. Here is a list of <a href="http://bugzilla.gnome.org/browse.cgi?product=libxml%2B%2B">open bugs</a>. Add new bugs <a href="http://bugzilla.gnome.org/enter_bug.cgi?product=libxml%2B%2B">here</a>.</p>
+<p>Libxml++ uses the GNOME <a href="http://git.gnome.org/browse/libxml++/">git repository</a>.</p>
+<p>Bugs and patches are tracked in GNOME's bugzilla. Here is a list of <a href="https://bugzilla.gnome.org/browse.cgi?product=libxml%2B%2B">open bugs</a>. Add new bugs <a href="https://bugzilla.gnome.org/enter_bug.cgi?product=libxml%2B%2B">here</a>.</p>
<p>
The <a href="http://sourceforge.net/mail/?group_id=12999">mailing list</a> is hosted on
<a href="http://sourceforge.net/projects/libxmlplusplus/">sourceforge</a>.</p>
diff --git a/libxml++/libxml++.h b/libxml++/libxml++.h
index f9f48ea..963764a 100644
--- a/libxml++/libxml++.h
+++ b/libxml++/libxml++.h
@@ -7,6 +7,19 @@
#ifndef __LIBXMLCPP_H
#define __LIBXMLCPP_H
+/** @mainpage libxml++ Reference Manual
+ *
+ * @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.
+ *
+ * @section use Use
+ *
+ * To use libxml++ in your application, include one of the header files. A
+ * @c pkg-config file is provided to simplify compilation.
+ */
#include <libxml++/exceptions/internal_error.h>
#include <libxml++/exceptions/parse_error.h>
#include <libxml++/parsers/domparser.h>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]