[gxml/gxml-0.10] Improves on documentation



commit 1f66d5c1e7f0f176ad1bd7dffe6523bfb850d59b
Author: Daniel Espinosa <esodan gmail com>
Date:   Thu Apr 14 18:22:27 2016 -0500

    Improves on documentation

 configure.ac                 |    4 ++--
 gxml/Document.vala           |    4 ++++
 gxml/Enumeration.vala        |    3 +++
 gxml/GHtml.vala              |    3 +++
 gxml/GXmlHashMapAttr.vala    |    3 +++
 gxml/GXmlListChildren.vala   |    3 +++
 gxml/GXmlListNamespaces.vala |    3 +++
 gxml/SerializableDouble.vala |    2 +-
 gxml/SerializableEnum.vala   |    5 ++++-
 gxml/SerializableFloat.vala  |    8 +++++++-
 gxml/libxml-Error.vala       |    2 +-
 11 files changed, 34 insertions(+), 6 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 46a561e..aec90ac 100644
--- a/configure.ac
+++ b/configure.ac
@@ -11,8 +11,8 @@
 
 # Release Version
 m4_define([project_major_version], [0])
-m4_define([project_minor_version], [11])
-m4_define([project_micro_version], [0])
+m4_define([project_minor_version], [10])
+m4_define([project_micro_version], [1])
 m4_define([project_nano_version], [0])
 
 # LT_VERSION
diff --git a/gxml/Document.vala b/gxml/Document.vala
index 4d0d798..73a3a19 100644
--- a/gxml/Document.vala
+++ b/gxml/Document.vala
@@ -20,6 +20,10 @@
  *      Daniel Espinosa <esodan gmail com>
  */
 
+
+/**
+ * Errors for documents handling reading/writing
+ */
 using Gee;
 
 public errordomain GXml.DocumentError {
diff --git a/gxml/Enumeration.vala b/gxml/Enumeration.vala
index 441d87d..0089b6b 100644
--- a/gxml/Enumeration.vala
+++ b/gxml/Enumeration.vala
@@ -183,6 +183,9 @@ namespace GXml {
                        return s;
                }
        }
+       /**
+        * Errors when de/serializing enumerations.
+        */
        public errordomain EnumerationError
        {
                /**
diff --git a/gxml/GHtml.vala b/gxml/GHtml.vala
index 2ebc560..444d501 100644
--- a/gxml/GHtml.vala
+++ b/gxml/GHtml.vala
@@ -25,6 +25,9 @@
 using Gee;
 
 namespace GXml {
+       /**
+        * HML parsing suport. Document handling
+        */
        public class HtmlDocument : GXml.xDocument {
                public static int default_options {
                        get {
diff --git a/gxml/GXmlHashMapAttr.vala b/gxml/GXmlHashMapAttr.vala
index 54b3cf4..837142e 100644
--- a/gxml/GXmlHashMapAttr.vala
+++ b/gxml/GXmlHashMapAttr.vala
@@ -22,6 +22,9 @@
 
 using Gee;
 
+/**
+ * Implementation of { link Gee.AbstractMap} to handle { link Xml.Node} attributes
+ */
 public class GXml.GHashMapAttr : Gee.AbstractMap<string,GXml.Node>
 {
   private GDocument _doc;
diff --git a/gxml/GXmlListChildren.vala b/gxml/GXmlListChildren.vala
index e062404..072b879 100644
--- a/gxml/GXmlListChildren.vala
+++ b/gxml/GXmlListChildren.vala
@@ -22,6 +22,9 @@
 
 using Gee;
 
+/**
+ * A { link Gee.AbstractBidirList} implementation to access { link Xml.Node} collection
+ */
 public class GXml.GListChildren : AbstractBidirList<GXml.Node>
 {
   private GXml.GDocument _doc;
diff --git a/gxml/GXmlListNamespaces.vala b/gxml/GXmlListNamespaces.vala
index f22d6b6..5ef33d7 100644
--- a/gxml/GXmlListNamespaces.vala
+++ b/gxml/GXmlListNamespaces.vala
@@ -22,6 +22,9 @@
 
 using Gee;
 
+/**
+ * A { link Gee.AbstractList} implementation to access { link Xml.Ns} namespaces collection
+ */
 public class GXml.GListNamespaces : Gee.AbstractList<GXml.Node>
 {
   private GDocument _doc;
diff --git a/gxml/SerializableDouble.vala b/gxml/SerializableDouble.vala
index 0fc386e..0ce3739 100644
--- a/gxml/SerializableDouble.vala
+++ b/gxml/SerializableDouble.vala
@@ -22,7 +22,7 @@
 
 using Gee;
 /**
- * Represent any boolean property to be added as a { link GXml.Attribute} to a { link GXml.Element}
+ * Represent any double presition float property to be added as a { link GXml.Attribute} to a { link 
GXml.Element}
  *
  * This object can be used when the property could be removed from serialization, specially if missing
  * on XML have some missing and avoidable.
diff --git a/gxml/SerializableEnum.vala b/gxml/SerializableEnum.vala
index 7d1a292..4589854 100644
--- a/gxml/SerializableEnum.vala
+++ b/gxml/SerializableEnum.vala
@@ -22,6 +22,9 @@
 
 using Gee;
 
+/**
+ * Errors when de/serializing enumerations as a set of string when using { link GXml.SerializableEnum}
+ */
 public errordomain GXml.SerializableEnumError {
   INVALID_VALUE_ERROR,
   PARSE_ERROR
@@ -78,4 +81,4 @@ public class GXml.SerializableEnum : Object, SerializableProperty
   public string get_serializable_property_value () { return _val; }
   public void set_serializable_property_value (string? val) { _val = val; }
   public string to_string () { return _val; }
-}
\ No newline at end of file
+}
diff --git a/gxml/SerializableFloat.vala b/gxml/SerializableFloat.vala
index 6137f7e..4c3f61b 100644
--- a/gxml/SerializableFloat.vala
+++ b/gxml/SerializableFloat.vala
@@ -20,6 +20,12 @@
  *      Daniel Espinosa <esodan gmail com>
  */
 
+/**
+ * Represent any float property to be added as a { link GXml.Attribute} to a { link GXml.Element}
+ *
+ * This object can be used when the property could be removed from serialization, specially if missing
+ * on XML have some missing and avoidable.
+ */
 public class GXml.SerializableFloat : GXml.SerializableDouble
 {
   /**
@@ -36,4 +42,4 @@ public class GXml.SerializableFloat : GXml.SerializableDouble
    * Given float number is parsed to string and then stored.
    */
   public new void set_value (float val) { _val = val.to_string (); }
-}
\ No newline at end of file
+}
diff --git a/gxml/libxml-Error.vala b/gxml/libxml-Error.vala
index b458223..f0b29d3 100644
--- a/gxml/libxml-Error.vala
+++ b/gxml/libxml-Error.vala
@@ -1,6 +1,6 @@
 namespace GXml {
        /**
-        * Errors for parse and writer.
+        * libmxl2 bindings for Errors on parse and write.
         */
        public errordomain Error {
                NOT_SUPPORTED, /* TODO: GET RID OF THIS */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]