[gxml] Added examples to GomArrayList and GomHashMap
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] Added examples to GomArrayList and GomHashMap
- Date: Thu, 26 Jan 2017 18:06:20 +0000 (UTC)
commit 61e615d72f1750a9d28770e6b348c3f0812c6aeb
Author: Daniel Espinosa <esodan gmail com>
Date: Thu Jan 26 11:45:15 2017 -0600
Added examples to GomArrayList and GomHashMap
gxml/GomCollections.vala | 35 ++++++++++++++++++++++++++++++++++-
1 files changed, 34 insertions(+), 1 deletions(-)
---
diff --git a/gxml/GomCollections.vala b/gxml/GomCollections.vala
index 260ebc2..3ee70b4 100644
--- a/gxml/GomCollections.vala
+++ b/gxml/GomCollections.vala
@@ -263,6 +263,22 @@ public abstract class GXml.BaseCollection : Object {
/**
* A class impementing {@link GomCollection} to store references to
* child {@link DomElement} of {@link element}, using an index.
+ *
+ * {{{
+ * public class YourObject : GomElement {
+ * [Description (nick="::Name")]
+ * public string name { get; set; }
+ * }
+ * public class YourList : GomArrayList {
+ * construct {
+ * try { initialize (typeof (YourObject)); }
+ * catch (GLib.Error e) {
+ * warning ("Initialization error for collection type: %s : %s"
+ * .printf (get_type ().name(), e.message));
+ * }
+ * }
+ * }
+ * }}}
*/
public class GXml.GomArrayList : GXml.BaseCollection, GomCollection {
public override bool validate_add (int index, DomElement element) throws GLib.Error {
@@ -276,7 +292,24 @@ public class GXml.GomArrayList : GXml.BaseCollection, GomCollection {
/**
* A class impementing {@link GomCollection} to store references to
* child {@link DomElement} of {@link element}, using an attribute in
- * items as key.
+ * items as key. If key is not defined in node, it is not added; but
+ * keeps it as a child node of actual {@link GomCollection.element}.
+ *
+ * {{{
+ * public class YourObject : GomElement {
+ * [Description (nick="::Name")]
+ * public string name { get; set; }
+ * }
+ * public class YourList : GomHashMap {
+ * construct {
+ * try { initialize_with_key (typeof (YourObject,"Name")); }
+ * catch (GLib.Error e) {
+ * warning ("Initialization error for collection type: %s : %s"
+ * .printf (get_type ().name(), e.message));
+ * }
+ * }
+ * }
+ * }}}
*/
public class GXml.GomHashMap : GXml.BaseCollection, GXml.GomCollection {
/**
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]