GNOME.org
 

[libxml++] Documentation: Improvements.

commit 7369f66b32003e9382565d333fde2a5986a976ee
Author: Murray Cumming <murrayc murrayc com>
Date:   Tue May 4 17:19:50 2010 +0200

    Documentation: Improvements.
    
    * libxml++/libxml++.h: Expand the main page text, linking to the tutorial
        and to important classes.
    * libxml++/parsers/domparser.h:
    * libxml++/schema.h: Correct the class descriptions.
    * libxml++/parsers/textreader.h: Add a class description.
    * libxml++/nodes/element.h:
    * libxml++/nodes/node.h:
    * libxml++/parsers/saxparser.h:
    * libxml++/validators/schemavalidator.h:
        Correct @newin2p2* to @newin{2,*} now that we use mm-common.

 ChangeLog                             |   25 ++++++++++++++++++++-----
 libxml++/libxml++.h                   |   12 +++++++++---
 libxml++/nodes/element.h              |    6 +++---
 libxml++/nodes/node.h                 |    4 ++--
 libxml++/parsers/domparser.h          |    2 +-
 libxml++/parsers/saxparser.h          |    2 +-
 libxml++/parsers/textreader.h         |   24 ++++++++++++++----------
 libxml++/schema.h                     |    4 ++--
 libxml++/validators/schemavalidator.h |    4 ++--
 9 files changed, 54 insertions(+), 29 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 1a5db18..244eb27 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,18 @@
+2010-05-04  Murray Cumming  <murrayc murrayc com>
+
+	Documentation: Improvements.
+
+	* libxml++/libxml++.h: Expand the main page text, linking to the tutorial
+    and to important classes.
+	* libxml++/parsers/domparser.h:
+	* libxml++/schema.h: Correct the class descriptions.
+	* libxml++/parsers/textreader.h: Add a class description.
+	* libxml++/nodes/element.h:
+	* libxml++/nodes/node.h:
+	* libxml++/parsers/saxparser.h:
+	* libxml++/validators/schemavalidator.h:
+    Correct @newin2p2* to @newin{2,*} now that we use mm-common.
+
 2010-04-27  David King  <davidk openismus com>
 
 	Further documentation main page improvements
@@ -21,7 +36,7 @@
 
     .pc file: Add datarootdir.
 
-	* libxml++-2.6.pc.in: Add datarootdir and datadir, as in the gtkmm .pc.in 
+	* libxml++-2.6.pc.in: Add datarootdir and datadir, as in the gtkmm .pc.in
     file, because I started seeing this warning when running autogen.sh in Glom:
     Variable 'datarootdir' not defined in '/opt/gnome228/lib/pkgconfig/libxml++-2.6.pc'
 
@@ -35,13 +50,13 @@
 
     Stop exceptions when using std::cout and UTF-8.
 
-	* examples/*/main.cc: Initialize the global C and C++ locale to prevent 
+	* examples/*/main.cc: Initialize the global C and C++ locale to prevent
     exceptions when ouputing a ustring (with non-ASCII UTF-8) to std::cout.
-    We don't see this problem when writing gtkmm apps because gtk_init() (via 
+    We don't see this problem when writing gtkmm apps because gtk_init() (via
     Gtk::Main) initializes the C locale correctly.
 
-    Thanks to Daniel Elstner for the solution (he will document it properly 
-    in the Glib::ustring API reference) and to Nic Reveles and others for 
+    Thanks to Daniel Elstner for the solution (he will document it properly
+    in the Glib::ustring API reference) and to Nic Reveles and others for
     noticing the problem.
 
 2010-03-30  David King  <davidk openismus com>
diff --git a/libxml++/libxml++.h b/libxml++/libxml++.h
index c198136..011631d 100644
--- a/libxml++/libxml++.h
+++ b/libxml++/libxml++.h
@@ -11,11 +11,17 @@
  *
  * @section description Description
  *
- * libxml++ is a C++ wrapper for the libxml2 XML parser library. It presents a
+ * libxml++ is a C++ wrapper for the <a href="http://xmlsoft.org/";>libxml2</a> XML parser and builder library. It presents a
  * simple C++-like API that can achieve common tasks with less code.
  *
- * See also <a href="http://libxmlplusplus.sourceforge.net/";>the libxml++
- * website</a>.
+ * See also the <a href="http://library.gnome.org/devel/libxml++-tutorial/stable/";>libxml++ Tutorial</a> and the <a href="http://libxmlplusplus.sourceforge.net/";>libxml++ website</a>.
+ *
+ * @section features Features
+ *
+ * - xmlpp::DomParser: A DOM-style parser.
+ * - xmlpp::SaxParser: A SAX-style parser.
+ * - xmlpp::TextReader: An XmlTextReader-style parser.
+ * - A hiererachy of xmlpp::Node classes.
  *
  * @section basics Basic Usage
  *
diff --git a/libxml++/nodes/element.h b/libxml++/nodes/element.h
index a64efd7..d8b88d1 100644
--- a/libxml++/nodes/element.h
+++ b/libxml++/nodes/element.h
@@ -52,7 +52,7 @@ public:
    * @param ns_prefix Namespace prefix. 
    * @return The text value of the attribute, or an empty string if no such attribute was found.
    *
-   * @newin2p20
+   * @newin{2,20}
    */
   Glib::ustring get_attribute_value(const Glib::ustring& name, 
                                     const Glib::ustring& ns_prefix = Glib::ustring()) const;
@@ -96,7 +96,7 @@ public:
 
   /** Add a new text node after the specified existing child node.
    *
-   * @newin2p24
+   * @newin{2,24}
    *
    * @param previous_sibling An existing child node.
    * @param content The text. This should be unescaped - see ContentNode::set_content().
@@ -106,7 +106,7 @@ public:
 
   /** Add a new text node before the specified existing child node.
    *
-   * @newin2p24
+   * @newin{2,24}
    *
    * @param next_sibling An existing child node.
    * @param content The text. This should be unescaped - see ContentNode::set_content().
diff --git a/libxml++/nodes/node.h b/libxml++/nodes/node.h
index f3f4ac2..088da4e 100644
--- a/libxml++/nodes/node.h
+++ b/libxml++/nodes/node.h
@@ -117,7 +117,7 @@ public:
 
   /** Add a child element to this node after the specified existing child node.
    *
-   * @newin2p24
+   * @newin{2,24}
    *
    * @param previous_sibling An existing child node.
    * @param name The new node name
@@ -129,7 +129,7 @@ public:
 
   /** Add a child element to this node before the specified existing child node.
    *
-   * @newin2p24
+   * @newin{2,24}
    *
    * @param next_sibling An existing child node.
    * @param name The new node name
diff --git a/libxml++/parsers/domparser.h b/libxml++/parsers/domparser.h
index cf8b926..8d6c296 100644
--- a/libxml++/parsers/domparser.h
+++ b/libxml++/parsers/domparser.h
@@ -13,7 +13,7 @@
 
 namespace xmlpp {
 
-/** XML DOM parser.
+/** DOM XML parser.
  *
  */
 class DomParser : public Parser
diff --git a/libxml++/parsers/saxparser.h b/libxml++/parsers/saxparser.h
index f68750a..6c30440 100644
--- a/libxml++/parsers/saxparser.h
+++ b/libxml++/parsers/saxparser.h
@@ -121,7 +121,7 @@ public:
 
   /** Parse a chunk of data.
    *
-   * @newin2p24
+   * @newin{2,24}
    *
    * This lets you pass a document in small chunks, e.g. from a network
    * connection. The on_* virtual functions are called each time the chunks
diff --git a/libxml++/parsers/textreader.h b/libxml++/parsers/textreader.h
index 55af7a4..1f730cd 100644
--- a/libxml++/parsers/textreader.h
+++ b/libxml++/parsers/textreader.h
@@ -22,6 +22,10 @@ extern "C"
 namespace xmlpp
 {
 
+/** A TextReader-style XML parser
+ * A reader that provides fast, non-cached, forward-only access to XML data,
+ * in the style of .Net's <a href="http://msdn.microsoft.com/en-us/library/system.xml.xmltextreader.aspx";>XmlTextReader</a> class.
+ */
 class TextReader: NonCopyable
 {
   public:
@@ -65,31 +69,31 @@ class TextReader: NonCopyable
     };
 
   typedef unsigned int size_type;
-                        
+
   public:
     /**
      * Wraps a TextReader object from an underlying libxml object. The TextReader
      * takes ownership of cobj.
-     * @param cobj The underlying libxml xmlTextReader object. 
+     * @param cobj The underlying libxml xmlTextReader object.
      */
     TextReader(struct _xmlTextReader* cobj);
-    
+
     /**
      * Creates a new TextReader object to parse a file or URI.
      * @param URI The URI to read.
      */
     TextReader(const Glib::ustring& URI);
-    
+
     /**
-     * Creates a new TextReader object which parses in memory data. 
+     * Creates a new TextReader object which parses in memory data.
      * @param data The data to parse.
      * @param size The number of bytes in data.
      * @param uri The base URI of the file.
-     */ 
+     */
     TextReader(const unsigned char* data, size_type size, const Glib::ustring& uri = Glib::ustring());
-    		   
+
     ~TextReader();
-    
+
     /** Moves the position of the current instance to the next node in the stream, exposing its properties.
      * @return true if the node was read successfully, false if there is no more nodes to read.
      */
@@ -99,7 +103,7 @@ class TextReader: NonCopyable
      * @return A Glib::ustring containing the XML content, or and empty Glib::ustring if the current node is neither an element nor attribute, or has no child nodes.
      */
     Glib::ustring read_inner_xml();
-    
+
     /** Reads the current node and its contents, including child nodes and markup.
      * @return A Glib::ustring containing the XML content, or an empty Glib::ustring if the current node is neither an element nor attribute.
      */
@@ -144,7 +148,7 @@ class TextReader: NonCopyable
      * @return true if defaulted, false otherwise.
      */
     bool is_default() const;
-    
+
     /** Check if the current node is empty
      * @return true if empty, false otherwise.
      */
diff --git a/libxml++/schema.h b/libxml++/schema.h
index b7df05a..3f56059 100644
--- a/libxml++/schema.h
+++ b/libxml++/schema.h
@@ -21,9 +21,9 @@ extern "C" {
 namespace xmlpp
 {
 
-/** Represents XML Schema.
+/** Represents an XML Schema.
  *
- * @newin2p24
+ * @newin{2,24}
  */
 class Schema : NonCopyable
 {
diff --git a/libxml++/validators/schemavalidator.h b/libxml++/validators/schemavalidator.h
index a1f15a6..c3aa7c9 100644
--- a/libxml++/validators/schemavalidator.h
+++ b/libxml++/validators/schemavalidator.h
@@ -21,9 +21,9 @@ extern "C" {
 
 namespace xmlpp {
 
-/** XML DOM parser.
+/** Schema Validator
  *
- * @newin2p24
+ * @newin{2,24}
  */
 class SchemaValidator : public Validator
 {
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]