[gxml] Improving documentation

From: Daniel Espinosa Ortiz <despinosa src gnome org>
To: commits-list gnome org
Cc:
Subject: [gxml] Improving documentation
Date: Thu, 11 May 2017 17:35:32 +0000 (UTC)
commit febb3ca312ded8e1ba6771306ac6ec8027e618c0
Author: Daniel Espinosa <esodan gmail com>
Date:   Thu May 11 12:31:29 2017 -0500

    Improving documentation

 gxml/Attribute.vala                 |    2 +-
 gxml/Document.vala                  |    2 +-
 gxml/DomNode.vala                   |    7 ++++++-
 gxml/GXmlCDATA.vala                 |    2 +-
 gxml/GXmlCharacter.vala             |    2 +-
 gxml/GXmlChildNode.vala             |    3 +++
 gxml/GXmlComment.vala               |    2 +-
 gxml/GXmlDocument.vala              |    3 ++-
 gxml/GXmlDomCollections.vala        |    9 +++++++--
 gxml/GXmlDomEvents.vala             |    6 ++++++
 gxml/GXmlDomRange.vala              |    3 +++
 gxml/GXmlElement.vala               |    3 ++-
 gxml/GXmlHashMapAttr.vala           |    3 ++-
 gxml/GXmlListNamespaces.vala        |    2 +-
 gxml/GXmlNode.vala                  |    2 +-
 gxml/GXmlProcessingInstruction.vala |    3 ++-
 gxml/GXmlText.vala                  |    3 ++-
 gxml/GomAttr.vala                   |    4 +++-
 gxml/GomCollections.vala            |    2 +-
 gxml/GomDocument.vala               |    6 ++++++
 gxml/GomElement.vala                |   10 ++++++++++
 gxml/GomNode.vala                   |    6 ++++++
 gxml/GomText.vala                   |   25 +++++++++++++++++++++++++
 gxml/Node.vala                      |    2 +-
 gxml/Parser.vala                    |    4 +++-
 gxml/Schema.vala                    |    3 +++
 gxml/Serializable.vala              |    2 +-
 gxml/SerializableGeeArrayList.vala  |    5 ++++-
 gxml/SerializableGeeDualKeyMap.vala |    5 ++++-
 gxml/SerializableGeeHashMap.vala    |    5 ++++-
 gxml/SerializableGeeTreeMap.vala    |    5 ++++-
 gxml/SerializableObjectModel.vala   |    4 +++-
 gxml/TAttribute.vala                |    2 +-
 gxml/TCDATA.vala                    |    2 +-
 gxml/TComment.vala                  |    2 +-
 gxml/TDocument.vala                 |    2 +-
 gxml/TElement.vala                  |    2 +-
 gxml/TNamespace.vala                |    2 +-
 gxml/TNode.vala                     |    2 +-
 gxml/TProcessingInstruction.vala    |    2 +-
 gxml/TText.vala                     |    2 +-
 gxml/XPath.vala                     |    7 +++++++
 42 files changed, 136 insertions(+), 34 deletions(-)
---
diff --git a/gxml/Attribute.vala b/gxml/Attribute.vala
index e988fea..f7e5ee4 100644
--- a/gxml/Attribute.vala
+++ b/gxml/Attribute.vala
@@ -22,7 +22,7 @@
 
 using Gee;
 /**
- * Interface to handle XML tags properties.
+ * DOM4 Interface to handle XML tags properties, powered by libxml2 library.
  *
  * Its features relays on {@link GXml.Node} interface inplementation to access
  * {@link GXml.Element} properties.
diff --git a/gxml/Document.vala b/gxml/Document.vala
index 96f5bc8..c10d188 100644
--- a/gxml/Document.vala
+++ b/gxml/Document.vala
@@ -23,7 +23,7 @@
 using Gee;
 
 /**
- * Errors for documents handling reading/writing
+ * Errors for documents handling {@link GXml.Document} reading/writing
  */
 public errordomain GXml.DocumentError {
   INVALID_DOCUMENT_ERROR,
diff --git a/gxml/DomNode.vala b/gxml/DomNode.vala
index e18ec9e..5447c17 100644
--- a/gxml/DomNode.vala
+++ b/gxml/DomNode.vala
@@ -20,6 +20,9 @@
  *      Daniel Espinosa <esodan gmail com>
  */
 
+/**
+ * Base interface for all DOM4 implementations
+ */
 public interface GXml.DomNode : GLib.Object, GXml.DomEventTarget {
        public enum NodeType {
                INVALID = 0,
@@ -163,7 +166,9 @@ public interface GXml.DomNode : GLib.Object, GXml.DomEventTarget {
     return false;
   }
 }
-
+/**
+ * DOM4 error codes.
+ */
 public errordomain GXml.DomError {
        INDEX_SIZE_ERROR = 1,
        DOMSTRING_SIZE_ERROR,//
diff --git a/gxml/GXmlCDATA.vala b/gxml/GXmlCDATA.vala
index 61d357d..653988c 100644
--- a/gxml/GXmlCDATA.vala
+++ b/gxml/GXmlCDATA.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.CDATA} interface, not tied to libxml-2.0 library.
+ * DOM4 Class implemeting {@link GXml.CDATA} interface, powered by libxml2 library.
  */
 public class GXml.GCDATA : GXml.GNode, GXml.CDATA
 {
diff --git a/gxml/GXmlCharacter.vala b/gxml/GXmlCharacter.vala
index d399d91..fac87db 100644
--- a/gxml/GXmlCharacter.vala
+++ b/gxml/GXmlCharacter.vala
@@ -21,7 +21,7 @@
  */
 
 /**
- * Base class for character data
+ * DOM4 Base class for character data, powered by libxml2 library.
  */
 public class GXml.GCharacterData : GXml.GNonDocumentChildNode, GXml.Character,
               GXml.DomCharacterData
diff --git a/gxml/GXmlChildNode.vala b/gxml/GXmlChildNode.vala
index 408c927..f2850fc 100644
--- a/gxml/GXmlChildNode.vala
+++ b/gxml/GXmlChildNode.vala
@@ -20,6 +20,9 @@
  *      Daniel Espinosa <esodan gmail com>
  */
 
+/**
+ * DOM4 class for child nodes, powered by libxml2 library.
+ */
 public class GXml.GChildNode : GXml.GNode,
               GXml.DomChildNode
 {
diff --git a/gxml/GXmlComment.vala b/gxml/GXmlComment.vala
index 897b8bd..d1a8188 100644
--- a/gxml/GXmlComment.vala
+++ b/gxml/GXmlComment.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Comment} interface, not tied to libxml-2.0 library.
+ * DOM4 Class implemeting {@link GXml.Comment} and {@link GXml.DomComment} interface, powered by libxml2 
library.
  */
 public class GXml.GComment : GXml.GCharacterData, GXml.Comment, GXml.DomComment
 {
diff --git a/gxml/GXmlDocument.vala b/gxml/GXmlDocument.vala
index 60317b0..586f0f1 100644
--- a/gxml/GXmlDocument.vala
+++ b/gxml/GXmlDocument.vala
@@ -24,7 +24,8 @@ using Gee;
 using Xml;
 
 /**
- * Class implemeting {@link GXml.Document} interface, not tied to libxml-2.0 library.
+ * DOM4 class implemeting {@link GXml.Document} and {GXml.DomDocument} interface,
+ * powered by libxml-2.0 library.
  *
  * This class use {@link Xml.TextWriter} to write down XML documents using
  * its contained {@link GXml.Node} children or other XML structures.
diff --git a/gxml/GXmlDomCollections.vala b/gxml/GXmlDomCollections.vala
index 56fb556..6d04eb6 100644
--- a/gxml/GXmlDomCollections.vala
+++ b/gxml/GXmlDomCollections.vala
@@ -23,7 +23,7 @@
 using Gee;
 
 /**
- * List of string tokens.
+ * DOM4 List of string tokens, powered by libxml2 library.
  */
 public class GXml.GDomTokenList : Gee.ArrayList<string>, GXml.DomTokenList {
   protected DomElement _element;
@@ -109,6 +109,9 @@ public class GXml.GDomTokenList : Gee.ArrayList<string>, GXml.DomTokenList {
   }
 }
 
+/**
+ * DOM4 Setteable token list, powered by libxml2 library.
+ */
 public class GXml.GDomSettableTokenList : GXml.GDomTokenList, GXml.DomSettableTokenList {
   public string value {
     owned get  { return to_string (); }
@@ -125,7 +128,9 @@ public class GXml.GDomSettableTokenList : GXml.GDomTokenList, GXml.DomSettableTo
   }
 
 }
-
+/**
+ * DOM4 HTML Collection, powered by libxml2 library.
+ */
 public class GXml.GDomHTMLCollection : Gee.ArrayList<GXml.DomElement>,
               GXml.DomHTMLCollection
 {
diff --git a/gxml/GXmlDomEvents.vala b/gxml/GXmlDomEvents.vala
index f457425..f7d0b22 100644
--- a/gxml/GXmlDomEvents.vala
+++ b/gxml/GXmlDomEvents.vala
@@ -20,6 +20,9 @@
  *      Daniel Espinosa <esodan gmail com>
  */
 
+/**
+ * DOM4 An event handler, powered by libxml2 library.
+ */
 public class GXml.GDomEvent : Object, GXml.DomEvent {
        protected string _etype;
        protected DomEventTarget _event_target;
@@ -62,6 +65,9 @@ public class GXml.GDomEvent : Object, GXml.DomEvent {
        }
 }
 
+/**
+ * Custom event handler, powered by libxml2 library.
+ */
 public class GXml.GDomCustomEvent : GXml.GDomEvent {
        protected GLib.Value? _detail;
        public GLib.Value? detail { get { return _detail; } }
diff --git a/gxml/GXmlDomRange.vala b/gxml/GXmlDomRange.vala
index dd0dd4d..af61fa1 100644
--- a/gxml/GXmlDomRange.vala
+++ b/gxml/GXmlDomRange.vala
@@ -21,6 +21,9 @@
  */
 
 // FIXME Range could be a set of nodes or a set of character data
+/**
+ * DOM4 Range implementation, powered by libxml2 library.
+ */
 public class GXml.GDomRange : Object, GXml.DomRange {
        protected DomDocument _document;
        protected DomNode _start_container;
diff --git a/gxml/GXmlElement.vala b/gxml/GXmlElement.vala
index 19a5e74..0d1931b 100644
--- a/gxml/GXmlElement.vala
+++ b/gxml/GXmlElement.vala
@@ -25,7 +25,8 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Element} interface, not tied to libxml-2.0 library.
+ * DOM4 Class implemeting {@link GXml.Element} and {@link GXml.DomElement} interface,
+ * powered by libxml-2.0 library.
  */
 public class GXml.GElement : GXml.GNonDocumentChildNode,
                             GXml.DomParentNode,
diff --git a/gxml/GXmlHashMapAttr.vala b/gxml/GXmlHashMapAttr.vala
index d0345cb..f6859a4 100644
--- a/gxml/GXmlHashMapAttr.vala
+++ b/gxml/GXmlHashMapAttr.vala
@@ -23,7 +23,8 @@
 using Gee;
 
 /**
- * Implementation of {@link Gee.AbstractMap} to handle {@link Xml.Node} attributes
+ * Implementation of {@link Gee.AbstractMap} to handle {@link Xml.Node} attributes,
+ * powered by libxml2 library.
  */
 public class GXml.GHashMapAttr : Gee.AbstractMap<string,GXml.Node>,
                                   GXml.DomNamedNodeMap
diff --git a/gxml/GXmlListNamespaces.vala b/gxml/GXmlListNamespaces.vala
index 40b75a0..2bbcab7 100644
--- a/gxml/GXmlListNamespaces.vala
+++ b/gxml/GXmlListNamespaces.vala
@@ -23,7 +23,7 @@
 using Gee;
 
 /**
- * A {@link Gee.AbstractList} implementation to access {@link Xml.Ns} namespaces collection
+ * A {@link Gee.AbstractList} implementation to access libxml2's {@link Xml.Ns} namespaces collection
  */
 public class GXml.GListNamespaces : Gee.AbstractList<GXml.Namespace>
 {
diff --git a/gxml/GXmlNode.vala b/gxml/GXmlNode.vala
index af1435e..da5623a 100644
--- a/gxml/GXmlNode.vala
+++ b/gxml/GXmlNode.vala
@@ -28,7 +28,7 @@ public errordomain GXml.Error {
        }
 
 /**
- * Base interface providing basic functionalities to all GXml interfaces.
+ * DOM4 Base interface providing basic functionalities to all libxml2 DOM4 implementations.
  */
 public abstract class GXml.GNode : Object,
                       GXml.DomEventTarget,
diff --git a/gxml/GXmlProcessingInstruction.vala b/gxml/GXmlProcessingInstruction.vala
index 7cc2b40..6d7bdd7 100644
--- a/gxml/GXmlProcessingInstruction.vala
+++ b/gxml/GXmlProcessingInstruction.vala
@@ -22,7 +22,8 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.ProcessingInstruction} interface, not tied to libxml-2.0 library.
+ * DOM4 Class implemeting {@link GXml.ProcessingInstruction} and
+ * {@link DomProcessingInstruction} interface, powered by libxml2 library.
  */
 public class GXml.GProcessingInstruction : GXml.GCharacterData,
               GXml.ProcessingInstruction,
diff --git a/gxml/GXmlText.vala b/gxml/GXmlText.vala
index 34ebaff..07edcb9 100644
--- a/gxml/GXmlText.vala
+++ b/gxml/GXmlText.vala
@@ -22,7 +22,8 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Text} interface, not tied to libxml-2.0 library.
+ * DOM4 Class implemeting {@link GXml.Text}
+ * and {@link DomText} interface, powered by libxml2 library.
  */
 public class GXml.GText : GXml.GCharacterData, GXml.Text, GXml.DomText
 {
diff --git a/gxml/GomAttr.vala b/gxml/GomAttr.vala
index 97434e2..bc19273 100644
--- a/gxml/GomAttr.vala
+++ b/gxml/GomAttr.vala
@@ -23,7 +23,9 @@
 using GXml;
 using Gee;
 
-
+/**
+ * DOM4 implemenation of {@link DomAttr}.
+ */
 public class GXml.GomAttr : GXml.GomNode, GXml.DomAttr {
   protected string _namespace_uri;
   public string local_name { owned get { return _local_name; } }
diff --git a/gxml/GomCollections.vala b/gxml/GomCollections.vala
index d96fe0b..8b60ee0 100644
--- a/gxml/GomCollections.vala
+++ b/gxml/GomCollections.vala
@@ -22,7 +22,7 @@
 
 
 /**
- * An interface to keep references to {@link DomElement} in a {@link element}
+ * A DOM4 interface to keep references to {@link DomElement} in a {@link element}
  * child nodes. Only {@link GomObject} are supported.
  */
 public interface GXml.GomCollection : Object
diff --git a/gxml/GomDocument.vala b/gxml/GomDocument.vala
index c45e345..581995e 100644
--- a/gxml/GomDocument.vala
+++ b/gxml/GomDocument.vala
@@ -22,6 +22,12 @@
 
 using GXml;
 
+/**
+ * A DOM4 implementation of {@link DomDocument}, for one step parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ */
 public class GXml.GomDocument : GomNode,
                               DomParentNode,
                               DomNonElementParentNode,
diff --git a/gxml/GomElement.vala b/gxml/GomElement.vala
index fb24d1e..3766859 100644
--- a/gxml/GomElement.vala
+++ b/gxml/GomElement.vala
@@ -22,9 +22,19 @@
 
 using GXml;
 using Gee;
+
 /**
+ * A DOM4 implementation of {@link DomElement}, for one-step-parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ *
  * A GXml Object Model (GOM) implementation of {@link GomElement}.It can be used
  * transparently as {@link DomElement} in a XML tree.
+ *
+ * It also allows delayed parsing, so you can read large documents by parsing
+ * just a XML element node and its attributes but not its childs; save its childs
+ * as a text, for a post-on-step-parsing.
  */
 public class GXml.GomElement : GomNode,
                               DomChildNode,
diff --git a/gxml/GomNode.vala b/gxml/GomNode.vala
index 782faa5..1ae3acc 100644
--- a/gxml/GomNode.vala
+++ b/gxml/GomNode.vala
@@ -23,6 +23,12 @@
 using GXml;
 using Gee;
 
+/**
+ * A DOM4 implementation of {@link DomNode}, for one step parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ */
 public class GXml.GomNode : Object,
                             DomEventTarget,
                             DomNode {
diff --git a/gxml/GomText.vala b/gxml/GomText.vala
index 492d9bd..ef21278 100644
--- a/gxml/GomText.vala
+++ b/gxml/GomText.vala
@@ -22,6 +22,12 @@
 
 using GXml;
 
+/**
+ * A DOM4 implementation of {@link DomCharacterData}, for one step parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ */
 public class GXml.GomCharacterData : GomNode,
                           DomNonDocumentTypeChildNode,
                           DomChildNode,
@@ -67,6 +73,12 @@ public class GXml.GomCharacterData : GomNode,
   }
 }
 
+/**
+ * A DOM4 implementation of {@link DomText}, for one step parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ */
 public class GXml.GomText : GomCharacterData,
                           DomText
 
@@ -81,6 +93,13 @@ public class GXml.GomText : GomCharacterData,
     _node_value = data;
   }
 }
+
+/**
+ * A DOM4 implementation of {@link DomProcessingInstruction}, for one step parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ */
 public class GXml.GomProcessingInstruction : GomCharacterData,
                                             DomProcessingInstruction
 {
@@ -96,6 +115,12 @@ public class GXml.GomProcessingInstruction : GomCharacterData,
   }
 }
 
+/**
+ * A DOM4 implementation of {@link DomComment}, for one step parsing.
+ *
+ * This object avoids pre and post XML parsing, by using a one step parsing
+ * to translate text XML tree to an GObject based tree.
+ */
 public class GXml.GomComment : GomCharacterData,
                               DomComment
 {
diff --git a/gxml/Node.vala b/gxml/Node.vala
index b35da62..268e1da 100644
--- a/gxml/Node.vala
+++ b/gxml/Node.vala
@@ -23,7 +23,7 @@
 using Gee;
 
 /**
- * Base interface providing basic functionalities to all GXml interfaces.
+ * Base interface providing basic functionalities for DOM1 interfaces.
  */
 public interface GXml.Node : Object
 {
diff --git a/gxml/Parser.vala b/gxml/Parser.vala
index a6c8b48..dcb2444 100644
--- a/gxml/Parser.vala
+++ b/gxml/Parser.vala
@@ -20,7 +20,9 @@
  */
 
 using Gee;
-
+/**
+ * Parser Error codes for {@link DomNode} parsing objects
+ */
 public errordomain GXml.ParserError {
   INVALID_DATA_ERROR,
   INVALID_FILE_ERROR,
diff --git a/gxml/Schema.vala b/gxml/Schema.vala
index 57162d2..c64731c 100644
--- a/gxml/Schema.vala
+++ b/gxml/Schema.vala
@@ -33,6 +33,9 @@ public interface GXml.IXsdSchema : GLib.Object, DomElement {
   public abstract IXsdListComplexTypes complex_type_definitions { get; set; }
 }
 
+/**
+ * XSD schema Error codes for {@link IXsdSchema} objects
+ */
 public errordomain GXml.IXsdSchemaError {
   INVALIDATION_ERROR
 }
diff --git a/gxml/Serializable.vala b/gxml/Serializable.vala
index 75aa311..8457478 100644
--- a/gxml/Serializable.vala
+++ b/gxml/Serializable.vala
@@ -24,7 +24,7 @@ using Gee;
 
 namespace GXml {
   /**
-   * Serialization framework. Base interface.
+   * A {@link GXml.Node} Serialization framework. Base interface.
    *
    * Implementors of this interface, could define or override the way you want to 
    * represent your class in a XML file.
diff --git a/gxml/SerializableGeeArrayList.vala b/gxml/SerializableGeeArrayList.vala
index 169cc3f..7b227dc 100644
--- a/gxml/SerializableGeeArrayList.vala
+++ b/gxml/SerializableGeeArrayList.vala
@@ -23,7 +23,10 @@ using GXml;
 using Gee;
 
 /**
- * Serializable Framework. A {@link Serializable} objects container based on {@link Gee.ArrayList}.
+ * {@link GXml.Node} Serializable Framework. A {@link Serializable} objects container
+ * based on {@link Gee.ArrayList}. It requires to dump to a {@link GXml.Document}
+ * or parse a pre-parsed XML tree {@link GXml.Document}. See {@link GXml.GomCollection} to avoid
+ * pre/post parsing processes.
  * 
  * It is derived  It implements {@link Serializable} and {@link SerializableCollection}
  * interfaces.
diff --git a/gxml/SerializableGeeDualKeyMap.vala b/gxml/SerializableGeeDualKeyMap.vala
index 8647212..02d9e11 100644
--- a/gxml/SerializableGeeDualKeyMap.vala
+++ b/gxml/SerializableGeeDualKeyMap.vala
@@ -23,7 +23,10 @@ using GXml;
 using Gee;
 
 /**
- * Serializable Framework. A {@link Serializable} objects container based on Gee interfaces with dual key.
+ * Serializable Framework. A {@link Serializable} objects container
+ * based on Gee interfaces with dual key. It requires to dump to a {@link GXml.Document}
+ * or parse a pre-parsed XML tree {@link GXml.Document}. See {@link GXml.GomCollection} to avoid
+ * pre/post parsing processes.
  * 
  * It implements {@link Serializable} and {@link SerializableCollection} interfaces, it is iterable as
  * other Gee collections.
diff --git a/gxml/SerializableGeeHashMap.vala b/gxml/SerializableGeeHashMap.vala
index 1592e6f..3b50a6d 100644
--- a/gxml/SerializableGeeHashMap.vala
+++ b/gxml/SerializableGeeHashMap.vala
@@ -21,7 +21,10 @@
  */
 using GXml;
 /**
- * Serializable Framework. A {@link Serializable} objects container based on {@link Gee.HashMap}.
+ * Serializable Framework. A {@link Serializable} objects container based
+ * on {@link Gee.HashMap}. It requires to dump to a {@link GXml.Document}
+ * or parse a pre-parsed XML tree {@link GXml.Document}. See {@link GXml.GomCollection} to avoid
+ * pre/post parsing processes.
  * 
  * It uses a key and value store implementing {@link Gee.HashMap} interface.
  * It implements {@link Serializable} and {@link SerializableCollection} interfaces.
diff --git a/gxml/SerializableGeeTreeMap.vala b/gxml/SerializableGeeTreeMap.vala
index e43ace3..53f6b9a 100644
--- a/gxml/SerializableGeeTreeMap.vala
+++ b/gxml/SerializableGeeTreeMap.vala
@@ -21,7 +21,10 @@
  */
 using GXml;
 /**
- * Serializable Framework. A {@link Serializable} objects container based on {@link Gee.TreeMap}.
+ * Serializable Framework. A {@link Serializable} objects container based
+ * on {@link Gee.TreeMap}. It requires to dump to a {@link GXml.Document}
+ * or parse a pre-parsed XML tree {@link GXml.Document}. See {@link GXml.GomCollection} to avoid
+ * pre/post parsing processes.
  * 
  * It uses a key and value store implementing {@link Gee.TreeMap} interface.
  * It implements {@link Serializable} and {@link SerializableCollection} interfaces.
diff --git a/gxml/SerializableObjectModel.vala b/gxml/SerializableObjectModel.vala
index a34115d..8d9d7a5 100644
--- a/gxml/SerializableObjectModel.vala
+++ b/gxml/SerializableObjectModel.vala
@@ -24,7 +24,9 @@ using Gee;
 
 /**
  * Object Model is an {@link Serializable} implementation using {@link Element}
- * to represent {@link GLib.Object} class objects.
+ * to represent {@link GLib.Object} class objects. It requires to dump to a {@link GXml.Document}
+ * or parse a pre-parsed XML tree {@link GXml.Document}. See {@link GXml.GomDocument} to avoid
+ * pre/post parsing processes.
  * 
  * This implementation consider each object as a XML node, represented in GXml 
  * as a {@link GXml.Element} and its properties is represented by {@link GXml.Attribute}.
diff --git a/gxml/TAttribute.vala b/gxml/TAttribute.vala
index cdc846b..1985e12 100644
--- a/gxml/TAttribute.vala
+++ b/gxml/TAttribute.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Attribute} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.Attribute} interface, not tied to libxml-2.0 library.
  */
 public class GXml.TAttribute : GXml.TNode, GXml.Attribute
 {
diff --git a/gxml/TCDATA.vala b/gxml/TCDATA.vala
index 6030000..955c0c2 100644
--- a/gxml/TCDATA.vala
+++ b/gxml/TCDATA.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.CDATA} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.CDATA} interface, not tied to libxml-2.0 library.
  */
 public class GXml.TCDATA : GXml.TNode, GXml.CDATA
 {
diff --git a/gxml/TComment.vala b/gxml/TComment.vala
index d9080c4..3c66058 100644
--- a/gxml/TComment.vala
+++ b/gxml/TComment.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Comment} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.Comment} interface, not tied to libxml-2.0 library.
  */
 public class GXml.TComment : GXml.TNode, GXml.Comment
 {
diff --git a/gxml/TDocument.vala b/gxml/TDocument.vala
index 96f4a08..63949bc 100644
--- a/gxml/TDocument.vala
+++ b/gxml/TDocument.vala
@@ -23,7 +23,7 @@ using Gee;
 using Xml;
 
 /**
- * Class implemeting {@link GXml.Document} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.Document} interface, not tied to libxml-2.0 library.
  *
  * This class use {@link Xml.TextWriter} to write down XML documents using
  * its contained {@link GXml.Node} children or other XML structures.
diff --git a/gxml/TElement.vala b/gxml/TElement.vala
index 2d15244..8c41bbf 100644
--- a/gxml/TElement.vala
+++ b/gxml/TElement.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Element} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.Element} interface, not tied to libxml-2.0 library.
  */
 public class GXml.TElement : GXml.TNode, GXml.Element
 {
diff --git a/gxml/TNamespace.vala b/gxml/TNamespace.vala
index 31680c2..3b29125 100644
--- a/gxml/TNamespace.vala
+++ b/gxml/TNamespace.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Namespace}, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.Namespace}, not tied to libxml-2.0 library.
  */
 public class GXml.TNamespace : GXml.TNode, GXml.Namespace
 {
diff --git a/gxml/TNode.vala b/gxml/TNode.vala
index 4f45178..711fe43 100644
--- a/gxml/TNode.vala
+++ b/gxml/TNode.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Base node abstract class implemeting {@link GXml.Node} interface, not tied to libxml-2.0 library.
+ * DOM1 Base node abstract class implemeting {@link GXml.Node} interface, not tied to libxml-2.0 library.
  */
 public abstract class GXml.TNode : Object, GXml.Node
 {
diff --git a/gxml/TProcessingInstruction.vala b/gxml/TProcessingInstruction.vala
index 912a8f3..540658d 100644
--- a/gxml/TProcessingInstruction.vala
+++ b/gxml/TProcessingInstruction.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.ProcessingInstruction} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.ProcessingInstruction} interface, not tied to libxml-2.0 library.
  */
 public class GXml.TProcessingInstruction : GXml.TNode, GXml.ProcessingInstruction
 {
diff --git a/gxml/TText.vala b/gxml/TText.vala
index 8827320..9598d61 100644
--- a/gxml/TText.vala
+++ b/gxml/TText.vala
@@ -22,7 +22,7 @@
 using Gee;
 
 /**
- * Class implemeting {@link GXml.Text} interface, not tied to libxml-2.0 library.
+ * DOM1 Class implemeting {@link GXml.Text} interface, not tied to libxml-2.0 library.
  */
 public class GXml.TText : GXml.TNode, GXml.Text
 {
diff --git a/gxml/XPath.vala b/gxml/XPath.vala
index a4f3682..23d897c 100644
--- a/gxml/XPath.vala
+++ b/gxml/XPath.vala
@@ -21,6 +21,10 @@
  *      Yannick Inizan <inizan yannick gmail com>
  *      Daniel Espinosa <esodan gmail com>
  */
+
+/**
+ * Object type codes for  {@link XPathObject} objects
+ */
 public enum GXml.XPathObjectType {
   UNDEFINED,
   NODESET,
@@ -34,6 +38,9 @@ public enum GXml.XPathObjectType {
   XSLT_TREE // not implemented
 }
 
+/**
+ * Parser Error codes for {@link XPathObject} objects
+ */
 public errordomain GXml.XPathError {
   EXPRESSION_OK,
   NUMBER_ERROR,
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]