From 49a16ebbca48d8263370fea2e954b0c0302b0da6 Mon Sep 17 00:00:00 2001 From: Daniel Espinosa Date: Thu, 14 May 2015 17:45:30 -0500 Subject: [PATCH] Better documentation for serializable collections --- gxml/SerializableGeeArrayList.vala | 2 +- gxml/SerializableGeeDualKeyMap.vala | 5 +++-- gxml/SerializableGeeTreeMap.vala | 2 +- gxml/libxml-NamedAttrMap.vala | 8 ++++++-- gxml/libxml-NamespaceAttr.vala | 6 +++--- 5 files changed, 14 insertions(+), 9 deletions(-) diff --git a/gxml/SerializableGeeArrayList.vala b/gxml/SerializableGeeArrayList.vala index 68ab79fa..eb8d61ce 100644 --- a/gxml/SerializableGeeArrayList.vala +++ b/gxml/SerializableGeeArrayList.vala @@ -23,7 +23,7 @@ using GXml; using Gee; /** - * A {@link Serializable} objects container. + * Serializable Framework. A {@link Serializable} objects container based on {@link Gee.ArrayList}. * * It is derived It implements {@link Serializable} and {@link SerializableCollection} * interfaces. diff --git a/gxml/SerializableGeeDualKeyMap.vala b/gxml/SerializableGeeDualKeyMap.vala index e210ae66..b6bd29ca 100644 --- a/gxml/SerializableGeeDualKeyMap.vala +++ b/gxml/SerializableGeeDualKeyMap.vala @@ -23,9 +23,10 @@ using GXml; using Gee; /** - * A {@link Serializable} objects container. It uses two keys and value store. + * Serializable Framework. A {@link Serializable} objects container based on Gee interfaces with dual key. * - * It implements {@link Serializable} and {@link SerializableCollection} interfaces. + * It implements {@link Serializable} and {@link SerializableCollection} interfaces, it is iterable as + * other Gee collections. */ public class GXml.SerializableDualKeyMap : Object, Serializable, SerializableCollection { diff --git a/gxml/SerializableGeeTreeMap.vala b/gxml/SerializableGeeTreeMap.vala index c4bc0a23..ef91fd02 100644 --- a/gxml/SerializableGeeTreeMap.vala +++ b/gxml/SerializableGeeTreeMap.vala @@ -21,7 +21,7 @@ */ using GXml; /** - * A {@link Serializable} objects container. + * Serializable Framework. A {@link Serializable} objects container based on {@link Gee.TreeMap}. * * It uses a key and value store implementing {@link Gee.TreeMap} interface. * It implements {@link Serializable} and {@link SerializableCollection} interfaces. diff --git a/gxml/libxml-NamedAttrMap.vala b/gxml/libxml-NamedAttrMap.vala index 2d92ebd3..a7e6b23f 100644 --- a/gxml/libxml-NamedAttrMap.vala +++ b/gxml/libxml-NamedAttrMap.vala @@ -26,9 +26,10 @@ using Gee; namespace GXml { /** - * A class implementing {@link GXml.NamedNodeMap} interface for {@link GXml.xAttr} objects. + * An abstract class used as base class for {@link GXml.NamedAttrMap} class. * - * A collection of {@link GXml.NamedNodeMap} of type {@link GXml.Attr} objects in a {@link GXml.xElement}. + * This is just an auxiliary class to implement {@link Gee.Traversable} + * {@link Gee.Iterable} interfaces. */ public abstract class AbstractNamedAttrMap : Object, Traversable>, @@ -119,6 +120,9 @@ namespace GXml { * A class implementing {@link GXml.NamedNodeMap} interface for {@link GXml.xAttr} objects. * * A collection of {@link GXml.NamedNodeMap} of type {@link GXml.xAttr} objects in a {@link GXml.xElement}. + * + * This class implements {@link Gee.Map}, but requires parent {@link GXml.AbstractNamedAttrMap} class + * in order to implement it. */ public class NamedAttrMap : AbstractNamedAttrMap, Map, NamedNodeMap diff --git a/gxml/libxml-NamespaceAttr.vala b/gxml/libxml-NamespaceAttr.vala index 3160797e..a24c0f4a 100644 --- a/gxml/libxml-NamespaceAttr.vala +++ b/gxml/libxml-NamespaceAttr.vala @@ -24,11 +24,11 @@ namespace GXml { /** - * Represents an XML Namespace Attr node. + * Represents an XML Namespace for a {@link GXml.Node} node. * * These represent - * prefix=uri pairs that define namespaces for XML Elements - * and Attrs. + * prefix=uri pairs that define namespaces for XML {@link GXml.xElements} + * and {@link GXml.xAttr}. */ public class NamespaceAttr : xNode, GXml.Namespace { /** Private properties */ -- GitLab