[gxml] Fixing documentation and removing warnings
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] Fixing documentation and removing warnings
- Date: Thu, 11 May 2017 16:07:29 +0000 (UTC)
commit 66b0b970f4e02f933fe8def5dc3390a3ebb2adae
Author: Daniel Espinosa <esodan gmail com>
Date: Thu May 11 11:05:18 2017 -0500
Fixing documentation and removing warnings
gxml/DomElement.vala | 1 -
gxml/GomCollections.vala | 15 ++++++---------
gxml/GomObject.vala | 2 +-
gxml/TDocument.vala | 1 -
gxml/XParser.vala | 16 ++++++++--------
5 files changed, 15 insertions(+), 20 deletions(-)
---
diff --git a/gxml/DomElement.vala b/gxml/DomElement.vala
index fb0038c..35c30f4 100644
--- a/gxml/DomElement.vala
+++ b/gxml/DomElement.vala
@@ -54,7 +54,6 @@ public interface GXml.DomElement : GLib.Object,
* as prefix. For default namespaces, use xmlns as name without prefix. Namespace
* URI will be the one provided as value.
*
- * @param namespace attribute namespace
* @param name a prefixed attribute name or xmlns for default namespace declaration
* @param value a value for the attribute or URI for namespace declaration
*/
diff --git a/gxml/GomCollections.vala b/gxml/GomCollections.vala
index 53e1b57..d96fe0b 100644
--- a/gxml/GomCollections.vala
+++ b/gxml/GomCollections.vala
@@ -436,9 +436,6 @@ public class GXml.GomHashMap : GXml.BaseCollection, GXml.GomCollection {
/**
* Inteface to be implemented by {@link GomElement} derived classes
* in order to provide a strings to be used in {@link GomHashPairedMap} as keys.
- *
- * If {@link GomHashPairedMap} has set its {@link GomHashMap.attribute_primary_key}
- * and {@link GomHashMap.attribute_secondary_key} its value has precedence over these methods.
*/
public interface GXml.MappeableElementPairKey : Object, DomElement {
public abstract string get_map_primary_key ();
@@ -657,9 +654,9 @@ public interface GXml.MappeableElementThreeKey : Object, DomElement {
/**
* A class impementing {@link GomCollection} to store references to
* child {@link DomElement} of {@link GomCollection.element}, using three attributes in
- * items as primary and secondary keys or {@link MappeableElementThreeKey.get_map_primary_key},
- * {@link MappeableElementPairKey.get_map_secondary_key}
- * and {@link MappeableElementPairKey.get_map_third_key}
+ * items as primary, secondary tertiary keys or {@link MappeableElementThreeKey.get_map_pkey},
+ * {@link MappeableElementThreeKey.get_map_skey}
+ * and {@link MappeableElementThreeKey.get_map_tkey}
* methods if {@link MappeableElementThreeKey} are implemented
* by items to be added. All keys should be defined in node, otherwise
* it is not added; but keeps it as a child node of actual
@@ -669,9 +666,9 @@ public interface GXml.MappeableElementThreeKey : Object, DomElement {
* and implements {@link MappeableElementThreeKey}, you should set
* {@link attribute_primary_key}, {@link attribute_secondary_key}
* and {@link attribute_third_key}
- * to null in order to use returned value of {@link MappeableElementThreeKey.get_map_primary_key},
- * {@link MappeableElementPairKey.get_map_secondary_key}
- * and {@link MappeableElementPairKey.get_map_third_key}
+ * to null in order to use returned value of {@link MappeableElementThreeKey.get_map_pkey},
+ * {@link MappeableElementThreeKey.get_map_skey}
+ * and {@link MappeableElementThreeKey.get_map_tkey}
* as keys.
*
* {{{
diff --git a/gxml/GomObject.vala b/gxml/GomObject.vala
index e53a852..f5f3088 100644
--- a/gxml/GomObject.vala
+++ b/gxml/GomObject.vala
@@ -43,7 +43,7 @@ public interface GXml.GomObject : GLib.Object,
*
* If {@link parse_children} is true this will hold a string with all childrens
* for this {@link GomElement}. It is set to null if {@link parse_children} is false
- * and {@link read_children} is called.
+ * and {@link parse_children} is called.
*/
public abstract string unparsed { get; set; }
/**
diff --git a/gxml/TDocument.vala b/gxml/TDocument.vala
index 221ffc4..96f4a08 100644
--- a/gxml/TDocument.vala
+++ b/gxml/TDocument.vala
@@ -467,7 +467,6 @@ public class GXml.TDocument : GXml.TNode, GXml.Document
* NOTE: Unless a bug on parsing is fixed, don't use this function, you will get
* unexpected tree parsing
*/
- [Deprecated (since="0.16")]
public delegate ReadType ReadTypeFunc (GXml.Node node, TextReader tr);
/**
* Read a {@link GXml.Document} from a {@link GLib.File}, parsing is controller
diff --git a/gxml/XParser.vala b/gxml/XParser.vala
index 5c3a2af..6b3dd60 100644
--- a/gxml/XParser.vala
+++ b/gxml/XParser.vala
@@ -209,32 +209,32 @@ public class GXml.XParser : Object, GXml.Parser {
* Check if current node has childs.
*/
public bool current_is_empty_element () {
- if (tr == null)
- throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
+ if (tr == null) return false;
+ // TODO: throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
return tr.is_empty_element () == 1;
}
/**
* Check if current node found by parser, is a {@link DomElement}
*/
public bool current_is_element () {
- if (tr == null)
- throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
+ if (tr == null) return false;
+ // TODO: throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
return (tr.node_type () == Xml.ReaderType.ELEMENT);
}
/**
* Check if current node found by parser, is a {@link DomDocument}
*/
public bool current_is_document() {
- if (tr == null)
- throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
+ if (tr == null) return false;
+ // TODO: throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
return (tr.node_type () == Xml.ReaderType.DOCUMENT);
}
/**
* Returns current node's local name, found by parser.
*/
public string current_node_name () {
- if (tr == null)
- throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
+ if (tr == null) return "";
+ // TODO: throw new ParserError.INVALID_DATA_ERROR (_("Internal Error: No TextReader was set"));
return tr.const_local_name ();
}
/**
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]