[gxml] Improved documentation
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] Improved documentation
- Date: Mon, 4 May 2015 19:01:13 +0000 (UTC)
commit 545b5a1dccf2d14aec348cb984f0f83e8bfec2e5
Author: Daniel Espinosa <esodan gmail com>
Date: Mon May 4 12:56:02 2015 -0500
Improved documentation
* Adding identification for GXml generic, Serializable and DOM APIs
gxml/Serializable.vala | 2 +-
gxml/SerializableContainer.vala | 2 +-
gxml/SerializableMapDualKey.vala | 2 +-
gxml/SerializableMapKey.vala | 2 +-
gxml/libxml-NamedNodeMap.vala | 2 +-
gxml/libxml-NodeList.vala | 4 +++-
6 files changed, 8 insertions(+), 6 deletions(-)
---
diff --git a/gxml/Serializable.vala b/gxml/Serializable.vala
index e303906..94f58a4 100644
--- a/gxml/Serializable.vala
+++ b/gxml/Serializable.vala
@@ -22,7 +22,7 @@
namespace GXml {
/**
- * GXml { link GLib.Object} serialization framework main interface to XML files.
+ * 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/SerializableContainer.vala b/gxml/SerializableContainer.vala
index a8b2656..5c6e090 100644
--- a/gxml/SerializableContainer.vala
+++ b/gxml/SerializableContainer.vala
@@ -37,7 +37,7 @@ public abstract class GXml.SerializableContainer : SerializableObjectModel
}
/**
- * Fake interface to be implemented by any collection of { link Serializable} objects.
+ * Serializable Framework. interface to be implemented by any collection of { link Serializable} objects.
*/
public interface GXml.SerializableCollection : Object, Serializable
{
diff --git a/gxml/SerializableMapDualKey.vala b/gxml/SerializableMapDualKey.vala
index 80e65ff..7bac160 100644
--- a/gxml/SerializableMapDualKey.vala
+++ b/gxml/SerializableMapDualKey.vala
@@ -21,7 +21,7 @@
*/
using GXml;
/**
- * Interface to get two keys used to store { link Serializable} objects.
+ * Serializable Framework. Interface to get two keys to be used to store { link Serializable} objects.
*
* This interface must be implemented by classes derived from { link GXml.SerializableDualKeyMap}.
*/
diff --git a/gxml/SerializableMapKey.vala b/gxml/SerializableMapKey.vala
index 592c471..e893b0c 100644
--- a/gxml/SerializableMapKey.vala
+++ b/gxml/SerializableMapKey.vala
@@ -22,7 +22,7 @@
using GXml;
/**
- * Interface to get one key used to store { link Serializable} objects.
+ * Serializable Framework. Interface to get one key to be used to store { link Serializable} objects.
*
* This interface must be implemented by classes derived from { link SerializableTreeMap}
* and { link SerializableHashMap}.
diff --git a/gxml/libxml-NamedNodeMap.vala b/gxml/libxml-NamedNodeMap.vala
index 357b8da..ca114cc 100644
--- a/gxml/libxml-NamedNodeMap.vala
+++ b/gxml/libxml-NamedNodeMap.vala
@@ -26,7 +26,7 @@ using Gee;
namespace GXml {
/**
- * A collection of elements with a named objects.
+ * DOM API. A collection of elements with a named objects.
*/
public interface NamedNodeMap<T> : GLib.Object {
// TODO: consider adding lookup, remove, etc from GLib.HashTable as convenience API
diff --git a/gxml/libxml-NodeList.vala b/gxml/libxml-NodeList.vala
index 0ab6e25..e8ace71 100644
--- a/gxml/libxml-NodeList.vala
+++ b/gxml/libxml-NodeList.vala
@@ -26,7 +26,9 @@ using Gee;
namespace GXml {
/**
- * A live list used to store { link GXml.xNode}s.
+ * DOM API. Interface to access a list of nodes.
+ *
+ * A live list used to store { link GXml.xNode}s.
*
* Usually contains the children of a { link GXml.xNode}, or
* the results of { link GXml.Element.get_elements_by_tag_name}.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]