[gxml] Adding documentation for different classes

[Daniel Espinosa Ortiz <despinosa src gnome org>]

commit d3927c8a91a3ce21db3038c1a2e0185e9c0c360a
Author: Daniel Espinosa <esodan gmail com>
Date:   Thu May 14 16:46:06 2015 -0500

    Adding documentation for different classes

 gxml/ProcessingInstruction.vala   |    2 +-
 gxml/Serialization.vala           |    2 +-
 gxml/TwAttribute.vala             |    3 +++
 gxml/TwCDATA.vala                 |    3 +++
 gxml/TwComment.vala               |    3 +++
 gxml/TwDocument.vala              |    6 ++++++
 gxml/TwElement.vala               |    3 +++
 gxml/TwNamespace.vala             |    3 +++
 gxml/TwNode.vala                  |    3 +++
 gxml/TwProcessingInstruction.vala |    3 +++
 gxml/TwText.vala                  |    3 +++
 gxml/libxml-NamedAttrMap.vala     |    8 ++++----
 12 files changed, 36 insertions(+), 6 deletions(-)
---
diff --git a/gxml/ProcessingInstruction.vala b/gxml/ProcessingInstruction.vala
index 6604281..477f45e 100644
--- a/gxml/ProcessingInstruction.vala
+++ b/gxml/ProcessingInstruction.vala
@@ -23,7 +23,7 @@
 using Gee;
 
 /**
- * Base interface providing basic functionalities to all GXml interfaces.
+ * Interface for XML Processing Instruction sections.
  */
 public interface GXml.ProcessingInstruction : Object, GXml.Node
 {
diff --git a/gxml/Serialization.vala b/gxml/Serialization.vala
index 147ca5c..f49f693 100644
--- a/gxml/Serialization.vala
+++ b/gxml/Serialization.vala
@@ -76,7 +76,7 @@ namespace GXml {
 
        /**
         * Serializes and deserializes { link GLib.Object}s to and from
-        * { link GXml.xNode}.
+        * { link GXml.xNode}, using { link SerializableJson} method.
         *
         * Serialization can automatically serialize a variety of public
         * properties.  { link GLib.Object}s can also implement the
diff --git a/gxml/TwAttribute.vala b/gxml/TwAttribute.vala
index bffebce..b7fd661 100644
--- a/gxml/TwAttribute.vala
+++ b/gxml/TwAttribute.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.Attribute} interface, not tied to libxml-2.0 library.
+ */
 public class GXml.TwAttribute : GXml.TwNode, GXml.Attribute
 {
   public TwAttribute (GXml.Document d, string name, string value)
diff --git a/gxml/TwCDATA.vala b/gxml/TwCDATA.vala
index a93d42d..fcb5546 100644
--- a/gxml/TwCDATA.vala
+++ b/gxml/TwCDATA.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.CDATA} interface, not tied to libxml-2.0 library.
+ */
 public class GXml.TwCDATA : GXml.TwNode, GXml.CDATA
 {
   private string _str = null;
diff --git a/gxml/TwComment.vala b/gxml/TwComment.vala
index 7ad94a7..3f97e64 100644
--- a/gxml/TwComment.vala
+++ b/gxml/TwComment.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.Comment} interface, not tied to libxml-2.0 library.
+ */
 public class GXml.TwComment : GXml.TwNode, GXml.Comment
 {
   private string _str = "";
diff --git a/gxml/TwDocument.vala b/gxml/TwDocument.vala
index b6114cf..5fe699e 100644
--- a/gxml/TwDocument.vala
+++ b/gxml/TwDocument.vala
@@ -22,6 +22,12 @@
 using Gee;
 using Xml;
 
+/**
+ * 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} childs or other XML structures.
+ */
 public class GXml.TwDocument : GXml.TwNode, GXml.Document
 {
   GXml.Element _root = null;
diff --git a/gxml/TwElement.vala b/gxml/TwElement.vala
index 85c8fec..b99e3bf 100644
--- a/gxml/TwElement.vala
+++ b/gxml/TwElement.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.Element} interface, not tied to libxml-2.0 library.
+ */
 public class GXml.TwElement : GXml.TwNode, GXml.Element
 {
   private string _content = null;
diff --git a/gxml/TwNamespace.vala b/gxml/TwNamespace.vala
index 705632c..195c475 100644
--- a/gxml/TwNamespace.vala
+++ b/gxml/TwNamespace.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.Namespace}, not tied to libxml-2.0 library.
+ */
 public class GXml.TwNamespace : GXml.TwNode, GXml.Namespace
 {
   private string _uri = null;
diff --git a/gxml/TwNode.vala b/gxml/TwNode.vala
index c3c98dd..5e32a6e 100644
--- a/gxml/TwNode.vala
+++ b/gxml/TwNode.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Base node abstract class implemeting { link GXml.Node} interface, not tied to libxml-2.0 library.
+ */
 public abstract class GXml.TwNode : Object, GXml.Node
 {
   protected Gee.HashMap<string,GXml.Node> _attrs = new Gee.HashMap<string,GXml.Node> ();
diff --git a/gxml/TwProcessingInstruction.vala b/gxml/TwProcessingInstruction.vala
index eb594a7..1932d4c 100644
--- a/gxml/TwProcessingInstruction.vala
+++ b/gxml/TwProcessingInstruction.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.ProcessingInstruction} interface, not tied to libxml-2.0 library.
+ */
 public class GXml.TwProcessingInstruction : GXml.TwNode, GXml.ProcessingInstruction
 {
   private string _target = "";
diff --git a/gxml/TwText.vala b/gxml/TwText.vala
index cd3f513..5b8d347 100644
--- a/gxml/TwText.vala
+++ b/gxml/TwText.vala
@@ -21,6 +21,9 @@
 
 using Gee;
 
+/**
+ * Class implemeting { link GXml.Text} interface, not tied to libxml-2.0 library.
+ */
 public class GXml.TwText : GXml.TwNode, GXml.Text
 {
   private string _str = null;
diff --git a/gxml/libxml-NamedAttrMap.vala b/gxml/libxml-NamedAttrMap.vala
index 577b2f4..2d92ebd 100644
--- a/gxml/libxml-NamedAttrMap.vala
+++ b/gxml/libxml-NamedAttrMap.vala
@@ -26,9 +26,9 @@ using Gee;
 
 namespace GXml {
        /**
-        * A class implementing { link NamedNodeMap} interface for { link Attr} objects.
+        * A class implementing { link GXml.NamedNodeMap} interface for { link GXml.xAttr} objects.
         * 
-        * A collection of { link NamedNodeMap} of type { link Attr} objects in a { link xElement}.
+        * A collection of { link GXml.NamedNodeMap} of type { link GXml.Attr} objects in a { link 
GXml.xElement}.
         */
        public abstract class AbstractNamedAttrMap : Object,
                Traversable<Entry<string,GXml.Attribute>>,
@@ -116,9 +116,9 @@ namespace GXml {
                }
        }
                /**
-        * A class implementing { link NamedNodeMap} interface for { link Attr} objects.
+        * A class implementing { link GXml.NamedNodeMap} interface for { link GXml.xAttr} objects.
         * 
-        * A collection of { link NamedNodeMap} of type { link Attr} objects in a { link xElement}.
+        * A collection of { link GXml.NamedNodeMap} of type { link GXml.xAttr} objects in a { link 
GXml.xElement}.
         */
        public class NamedAttrMap : AbstractNamedAttrMap, Map<string,GXml.Attribute>,
                NamedNodeMap<xAttr?>