[gxml] Fixed documentation generation
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] Fixed documentation generation
- Date: Wed, 28 Oct 2015 19:32:30 +0000 (UTC)
commit dd9a897f6ccd97ff5591275ed00bd3727d5a3fef
Author: Daniel Espinosa <esodan gmail com>
Date: Sun Oct 25 15:53:53 2015 -0600
Fixed documentation generation
docs/valadoc/gtk-doc/Makefile.am | 7 ++--
gxml/Element.vala | 2 +-
gxml/Enumeration.vala | 29 ++++++++---------
gxml/Node.vala | 6 ++--
gxml/Serializable.vala | 33 +++++++-------------
gxml/SerializableBool.vala | 4 +-
gxml/SerializableDouble.vala | 2 +-
gxml/SerializableEnum.vala | 2 +-
gxml/SerializableFloat.vala | 2 +-
gxml/SerializableInt.vala | 4 +-
gxml/SerializableJson.vala | 2 +-
gxml/SerializableObjectModel.vala | 2 +-
gxml/SerializableProperty.vala | 38 ++++++++--------------
gxml/SerializableValueList.vala | 4 +-
gxml/libxml-CharacterData.vala | 2 +-
gxml/libxml-Document.vala | 14 ++++----
gxml/libxml-Element.vala | 61 ++++++++++++++++++-------------------
gxml/libxml-NamespaceAttr.vala | 2 +-
gxml/libxml-Node.vala | 14 ++++----
gxml/libxml-NodeList.vala | 2 +-
20 files changed, 104 insertions(+), 128 deletions(-)
---
diff --git a/docs/valadoc/gtk-doc/Makefile.am b/docs/valadoc/gtk-doc/Makefile.am
index 426d030..ac8df66 100644
--- a/docs/valadoc/gtk-doc/Makefile.am
+++ b/docs/valadoc/gtk-doc/Makefile.am
@@ -36,7 +36,6 @@ gxml-gtk-doc:
all: gxml-gtk-doc
-clean-local: clean-local-gtk-doc
-.PHONY: clean-local-gtk-doc
-clean-local-gtk-doc:
- -rm -rf gtk-doc
+clean-local:
+ rm -rf gtk-doc
+ rm -rf gxml
diff --git a/gxml/Element.vala b/gxml/Element.vala
index 8eeeb70..7ce9cd3 100644
--- a/gxml/Element.vala
+++ b/gxml/Element.vala
@@ -53,7 +53,7 @@ public interface GXml.Element : Object, GXml.Node
* by calling this method. Is a good practice to call this function, even if
* current implemention doesn't requires it.
*
- * This function is useful when using { link GXml.TextWriter} implementations.
+ * This function is useful when using { link Xml.TextWriter} implementations.
*/
public virtual void finalize_attr () { return; }
/**
diff --git a/gxml/Enumeration.vala b/gxml/Enumeration.vala
index 77a63e6..0b7838d 100644
--- a/gxml/Enumeration.vala
+++ b/gxml/Enumeration.vala
@@ -43,8 +43,8 @@ namespace GXml {
*
* Returns: an string representing an enumeration's value.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
- * @param val: an integer to parse an enum value of type @enumeration.
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param val an integer to parse an enum value of type @enumeration.
*/
public static string get_nick (Type enumeration, int val) throws GLib.Error
{
@@ -56,8 +56,8 @@ namespace GXml {
*
* Returns: an string representing an enumeration's value.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
- * @param val: an integer to parse an enum value of type @param enumeration.
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param val an integer to parse an enum value of type @param enumeration.
*/
public static string get_nick_camelcase (Type enumeration, int val) throws GLib.Error
{
@@ -68,10 +68,10 @@ namespace GXml {
*
* Returns: an string representing an enumeration's value.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
- * @param val: an integer to parse an enum value of type @enumeration.
- * @param use_nick: makes to returns value's nick name in { link GLib.EnumClass}
- * @param camelcase: makes to returns value's nick name in { link GLib.EnumClass}
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param val an integer to parse an enum value of type @enumeration.
+ * @param use_nick makes to returns value's nick name in { link GLib.EnumClass}
+ * @param camelcase makes to returns value's nick name in { link GLib.EnumClass}
* as camel case representation. If @use_nick is set this take no effect.
*/
public static string get_string (Type enumeration, int val,
@@ -102,9 +102,8 @@ namespace GXml {
*
* Returns: an { link GLib.EnumValue} representing an enumeration's value.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
- * @param val: a string to parse an enum value of type @param enumeration.
- * @param camelcase: makes to returns value's nick name in { link GLib.EnumClass}
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param val a string to parse an enum value of type @param enumeration.
* as camel case representation. If @use_nick is set this take no effect.
*/
public static EnumValue? parse (Type enumeration, string val)
@@ -133,7 +132,7 @@ namespace GXml {
*
* Returns: an array of { link GLib.EnumValue} representing an enumeration.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
*/
public static unowned EnumValue[] to_array (Type enumeration)
requires (enumeration.is_a (Type.ENUM))
@@ -147,8 +146,8 @@ namespace GXml {
*
* Returns: a { link GLib.EnumValue} or null if fails.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
- * @param val: an integer in a valid range in the enumeration.
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param val an integer in a valid range in the enumeration.
*/
public static EnumValue? parse_integer (Type enumeration, int val)
{
@@ -166,7 +165,7 @@ namespace GXml {
*
* Returns: an array of strings representing an enumeration.
*
- * @param enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
+ * @param enumeration a { link GLib.Type} of type { link GLib.Type.ENUM}
*/
public static string[] to_string_array (Type enumeration) throws GLib.Error
requires (enumeration.is_a (Type.ENUM))
diff --git a/gxml/Node.vala b/gxml/Node.vala
index 95bd31e..32ea2c6 100644
--- a/gxml/Node.vala
+++ b/gxml/Node.vala
@@ -92,9 +92,9 @@ public interface GXml.Node : Object
* Just { link GXml.Element} objects are supported. For attributes, use
* { link GXml.Element.set_attr} method, passing source's name and value as arguments.
*
- * @param doc: a { link GXml.Document} owning destiny node
- * @param node: a { link GXml.Element} to copy nodes to
- * @param source: a { link GXml.Element} to copy nodes from, it could be holded by different { link
GXml.Document}
+ * @param doc a { link GXml.Document} owning destiny node
+ * @param node a { link GXml.Element} to copy nodes to
+ * @param source a { link GXml.Element} to copy nodes from, it could be holded by different { link
GXml.Document}
*/
public static bool copy (GXml.Document doc, GXml.Node node, GXml.Node source, bool deep)
{
diff --git a/gxml/Serializable.vala b/gxml/Serializable.vala
index e606365..0543adc 100644
--- a/gxml/Serializable.vala
+++ b/gxml/Serializable.vala
@@ -78,7 +78,7 @@ namespace GXml {
* method in order to return true, your implementation or the ones in GXml, will
* store all unknown attributes on deserialization and must serialize
* again back to the XML file. Even you are allowed to get this unknown objects
- * by iterating on { link unknown_serializable_property} collection, if you know
+ * by iterating on { link unknown_serializable_properties} collection, if you know
* attribute's name, use it to retrieve it.
*
* This property is ignored on serialisation.
@@ -101,7 +101,7 @@ namespace GXml {
* method in order to return true, your implementation or the ones in GXml, will
* store all unknown properties and nodes on deserialization and must serialize
* again back to the XML file. Even you are allowed to get this unknown objects
- * by iterating on { link unknown_serializable_property} hash table.
+ * by iterating on { link Serializable.unknown_serializable_nodes} hash table.
*
* This property is ignored on serialisation.
*/
@@ -115,7 +115,7 @@ namespace GXml {
* true in order to use this property.
*
* This property is ignored by default. Implementors must implement
- * { link serialize_use_xml_node_value} to return { link true} and add a
+ * { link serialize_use_xml_node_value} to return true and add a
* set and get function to get/set this value, in order to use your own API.
*
* This property is ignored on serialisation.
@@ -126,15 +126,7 @@ namespace GXml {
* Used to set specific namespace for an { link GXml.Element}.
*
* By default no namspace prefix is added to { link GXml.Element} on serialized. Implementors
- * must consider { link Serializable.serialize_set_namespace} proterty value
- * to discover if this node should have a namespace.
- *
- * { link GXml.Element} namespace should be added before to serialize any
- * property.
- *
- * This property should have a format "prefix|url".
- *
- * This property is ignored on serialisation.
+ * must consider override this methodk if this node should have a namespace.
*/
public abstract bool set_namespace (GXml.Node node);
//public abstract Namespace @namespace { get; set; default = null; }
@@ -177,7 +169,7 @@ namespace GXml {
* This method must call serialize_property() recursivally on all properties
* to serialize.
*
- * @param doc an { link GXml.Document} object to serialize to.
+ * @param node an { link GXml.Node} object to serialize to.
*/
public abstract GXml.Node? serialize (GXml.Node node) throws GLib.Error;
@@ -278,7 +270,7 @@ namespace GXml {
*
* For instance, if an object has private data fields
* that are not installed public properties, but that
- * should be serialized, find_property can be defined
+ * should be serialized, { link GLib.ObjectClass.find_property} can be defined
* to return a { link GLib.ParamSpec} for non-installed
* properties. Other { link GXml.Serializable} functions
* should be consistent with it.
@@ -342,8 +334,6 @@ namespace GXml {
get_class ().find_property("unknown-serializable-nodes"));
ignored_serializable_properties.set ("serialized-xml-node-value",
get_class ().find_property("serialized-xml-node-value"));
- ignored_serializable_properties.set ("serialize-set-namespace",
- get_class ().find_property("serialize_set_namespace"));
}
}
@@ -413,7 +403,7 @@ namespace GXml {
* handle this case as a virtual property, supported
* by the other { link GXml.Serializable} functions.
*
- * @param spec is usually obtained from { link list_properties} or { link find_property}.
+ * @param spec is usually obtained from { link list_serializable_properties} or { link
GLib.ObjectClass.find_property}.
*
* @param spec The property we're retrieving as a string
*/
@@ -478,7 +468,7 @@ namespace GXml {
* Call this method before use standard Serializable or implementator ones.
*
* @param str a string to get attribute from
- * @param dest a { link GObject.Value} describing attribute to deserialize
+ * @param dest a { link GLib.Value} describing attribute to deserialize
*/
public abstract bool transform_from_string (string str, ref GLib.Value dest)
throws GLib.Error;
@@ -593,16 +583,15 @@ namespace GXml {
* Some specialized classes, like derived from { link Serializable} class
* implementator, can provide custome transformations.
*
- * Returns: { link true} if transformation was handled, { link false} otherwise.
- *
* Implementors:
* To be overrided by derived classes of implementators to provide custome
* transformations. Declare it as virtual if you want derived classes of
* implementators to provide custome transformations.
* Call this method before use standard Serializable or implementator ones.
*
- * @param val: a { link GLib.Value} to get attribute from
- * @param str: a string describing attribute to deserialize
+ * @param val a { link GLib.Value} to get attribute from
+ * @param str a string describing attribute to deserialize
+ * @return true if transformation was handled, false otherwise.
*/
public abstract bool transform_to_string (GLib.Value val, ref string str)
throws GLib.Error;
diff --git a/gxml/SerializableBool.vala b/gxml/SerializableBool.vala
index 17fb971..4e6a669 100644
--- a/gxml/SerializableBool.vala
+++ b/gxml/SerializableBool.vala
@@ -22,7 +22,7 @@
using Gee;
/**
- * Represent any boolean property to be added as a { link GXml.Attr} to a { link GXml.Element}
+ * Represent any boolean property to be added as a { link GXml.Attribute} to a { link GXml.Element}
*
*/
public class GXml.SerializableBool : SerializableObjectModel, SerializableProperty
@@ -31,7 +31,7 @@ public class GXml.SerializableBool : SerializableObjectModel, SerializableProper
/**
* Parse the stored value, from the XML property, to a { link int}. This parsing
* may is different from the actual stored string. If can't be parsed to a valid
- * boolean, this method will always return { link false}
+ * boolean, this method will always return false.
*/
public bool get_value () {
if (_val.down () == "true") return true;
diff --git a/gxml/SerializableDouble.vala b/gxml/SerializableDouble.vala
index c777879..4966f64 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.Attr} to a { link GXml.Element}
+ * Represent any boolean property to be added as a { link GXml.Attribute} to a { link GXml.Element}
*
*/
public class GXml.SerializableDouble : SerializableObjectModel, SerializableProperty
diff --git a/gxml/SerializableEnum.vala b/gxml/SerializableEnum.vala
index bd6a507..c93c9e7 100644
--- a/gxml/SerializableEnum.vala
+++ b/gxml/SerializableEnum.vala
@@ -29,7 +29,7 @@ public errordomain GXml.SerializableEnumError {
/**
* Represent any value as string but a list of enum values by default to select from.
- * property to be added as a { link GXml.Attr} to a { link GXml.Element}.
+ * property to be added as a { link GXml.Attribute} to a { link GXml.Element}.
*
* This class makes easy to create enumerations with its representation to string,
* but limited to the actual values of the enumeration, making it flexible for
diff --git a/gxml/SerializableFloat.vala b/gxml/SerializableFloat.vala
index 63e597d..6137f7e 100644
--- a/gxml/SerializableFloat.vala
+++ b/gxml/SerializableFloat.vala
@@ -26,7 +26,7 @@ public class GXml.SerializableFloat : GXml.SerializableDouble
* Parse the stored value, from the XML property, to a { link int}. This parsing
* may is different from the actual stored string.
*
- * The stored value, is parsed using { lilnk GLib.ascii_strtod} and then
+ * The stored value, is parsed using to double value and then
* casted to an float before return, this make flexible on stored values
* in XML and parsed without errors, but they could defere from the value
* returned by this method.
diff --git a/gxml/SerializableInt.vala b/gxml/SerializableInt.vala
index 9a4b121..e405db9 100644
--- a/gxml/SerializableInt.vala
+++ b/gxml/SerializableInt.vala
@@ -22,7 +22,7 @@
using Gee;
/**
- * Represent any boolean property to be added as a { link GXml.Attr} to a { link GXml.Element}
+ * Represent any boolean property to be added as a { link GXml.Attribute} to a { link GXml.Element}
*/
public class GXml.SerializableInt : GXml.SerializableDouble
{
@@ -30,7 +30,7 @@ public class GXml.SerializableInt : GXml.SerializableDouble
* Parse the stored value, from the XML property, to a { link int}. This parsing
* may is different from the actual stored string.
*
- * The stored value, is parsed using { lilnk GLib.ascii_strtod} and then
+ * The stored value, is parsed as double value and then
* casted to an integer before return, this make flexible on stored values
* in XML and parsed without errors, but they could defere from the value
* returned by this method.
diff --git a/gxml/SerializableJson.vala b/gxml/SerializableJson.vala
index 6f7a7db..1ce2fd3 100644
--- a/gxml/SerializableJson.vala
+++ b/gxml/SerializableJson.vala
@@ -54,7 +54,7 @@
*
* { link xElement} have two properties with object type and object id.
*
- * It uses a set children { link xElement} for each Object property with two { link Attr},
+ * It uses a set children { link xElement} for each Object property with two { link GXml.Attribute},
* one for its type and one for its name; property's value is set as the property
* { link xElement}'s content text.
*/
diff --git a/gxml/SerializableObjectModel.vala b/gxml/SerializableObjectModel.vala
index 3465148..84c79d1 100644
--- a/gxml/SerializableObjectModel.vala
+++ b/gxml/SerializableObjectModel.vala
@@ -27,7 +27,7 @@ using Gee;
* to represent { link GLib.Object} class objects.
*
* This implementation consider each object as a XML node, represented in GXml
- * as a { link GXml.Element} and its properties is represented by { link GXml.Attr}.
+ * as a { link GXml.Element} and its properties is represented by { link GXml.Attribute}.
* Each property, if it is a { link Serializable} object, is represented as child
* { link Element}.
*
diff --git a/gxml/SerializableProperty.vala b/gxml/SerializableProperty.vala
index 6c94f58..6fdf6a1 100644
--- a/gxml/SerializableProperty.vala
+++ b/gxml/SerializableProperty.vala
@@ -22,13 +22,7 @@
using Gee;
/**
- * Represent any property to be added as a { link GXml.Attr} to a { link GXml.Element}
- *
- * On implementations of { link GXml.Serializable}, consider to detect if the object to
- * serialize/deserialize is of kind { link GXml.SerializableProperty} and call
- * { link GXml.Serializable.serialize_property} instead of { link GXml.Serializable.serialize}
- * to fill automatically { link GXml.SerializableProperty.serializable_property_name} and
- * { link GXml.SerializableProperty.serializable_property_value}.
+ * Represent any property to be added as a { link GXml.Attribute} to a { link GXml.Element}
*
* The actual value stored and returned by { link GXml.SerializableProperty.get_serializable_property_value}
* is the actual string in the XML property, this means may the value could differ from the spected value
@@ -36,17 +30,17 @@ using Gee;
* retured values.
*
* Implementations of { link GXml.SerializableProperty}, could be used to provide more flexibility
- * when parsing { link GXml.Attr} properties values and to exclude to be serialized if they have not
+ * when parsing { link GXml.Attribute} properties values and to exclude to be serialized if they have not
* been created in the holding objects.
*/
public interface GXml.SerializableProperty : Object, Serializable
{
/**
- * Value to be set to a { link GXml.Attr}, to be added to a { link GXml.Element}
+ * Value to be set to a { link GXml.Attribute}, to be added to a { link GXml.Element}
*/
public abstract string get_serializable_property_value ();
/**
- * Set value to be set to a { link GXml.Attr}, to be added to a { link GXml.Element}
+ * Set value to be set to a { link GXml.Attribute}, to be added to a { link GXml.Element}
*
* If value is set to @null then the property will be ignored by default and no
* property will be set to given { link GXml.Element}.
@@ -57,32 +51,29 @@ public interface GXml.SerializableProperty : Object, Serializable
*/
public abstract void set_serializable_property_value (string? val);
/**
- * Tryies to deserialize from a { link GXml.Node} searching a { link GXml.Attr}
- * with the name returned by { link GXml.SerializableProperty.get_serializable_property_name},
- * if not set, then { link GLib.ParamSpec} name should used. If { param nick} is set to true,
+ * Tryies to deserialize from a { link GXml.Node} searching a { link GXml.Attribute}
+ * with the name provided in @param prop or its nick if @nick is true,
+ * if not set, then { link GLib.ParamSpec} name should used. If @param nick is set to true,
* then { link GLib.ParamSpec} nick is used as name.
*/
public virtual bool deserialize_property (GXml.Node property_node, ParamSpec prop, bool nick)
throws GLib.Error
{ return default_serializable_property_deserialize_property (property_node, prop, nick); }
/**
- * Serialization method to add a { link GXml.Attr} to a { link GXml.Element}, using { link ParamSpec}
- * name or nick, if { param nick} is set to true, as the attribute's name.
+ * Serialization method to add a { link GXml.Attribute} to a { link GXml.Element}, using { link
GLib.ParamSpec}
+ * name or nick, if @param nick is set to true, as the attribute's name.
*
- * If { link GXml.SerializableProperty.get_serializable_property_value} returns { link null}
+ * If { link GXml.SerializableProperty.get_serializable_property_value} returns null
* given { link GXml.Node} should not be modified.
*/
public virtual GXml.Node? serialize_property (GXml.Node property_node, ParamSpec prop, bool nick)
throws GLib.Error
{ return default_serializable_property_serialize_property (property_node, prop,nick); }
/**
- * Default serialization method to add a { link GXml.Attr} to a { link GXml.Element}
+ * Default serialization method to add a { link GXml.Attribute} to a { link GXml.Element}
*
- * If { link GXml.SerializableProperty.get_serializable_property_value} returns { link null}
+ * If { link GXml.SerializableProperty.get_serializable_property_value} returns null
* given { link GXml.Node} is not modified.
- *
- * Implementators should override { link Serializable.serialize_property} to call
- * this method on serialization.
*/
public GXml.Node? default_serializable_property_serialize_property (GXml.Node element,
GLib.ParamSpec prop, bool nick)
@@ -106,9 +97,8 @@ public interface GXml.SerializableProperty : Object, Serializable
return element;
}
/**
- * Tryies to deserialize from a { link GXml.Node} searching a { link GXml.Attr}
- * with the name returned by { link GXml.SerializableProperty.get_serializable_property_name},
- * if not set { link GLib.ParamSpec} name is used.
+ * Tryies to deserialize from a { link GXml.Node} searching a { link GXml.Attribute}
+ * with the name in @param prop or from its nick if @nick is true.
*/
public bool default_serializable_property_deserialize_property (GXml.Node property_node,
ParamSpec prop, bool nick)
diff --git a/gxml/SerializableValueList.vala b/gxml/SerializableValueList.vala
index 32b00bd..c66b21f 100644
--- a/gxml/SerializableValueList.vala
+++ b/gxml/SerializableValueList.vala
@@ -23,7 +23,7 @@
using Gee;
/**
* Represent any value as string but a list of options by default to select from.
- * property to be added as a { link GXml.Attr} to a { link GXml.Element}.
+ * property to be added as a { link GXml.Attribute} to a { link GXml.Element}.
*
* All values are stored in an array to get access to it by its position using
* { link SerializableValueList.get_value_at}.
@@ -87,7 +87,7 @@ public class GXml.SerializableValueList : SerializableObjectModel, SerializableP
* Get an array of string values in list.
*
* If no values were defined at construction time and
- * no values were added this return { link null}
+ * no values were added this return null
*/
public virtual string[] get_values_array () {
return get_values ().to_array ();
diff --git a/gxml/libxml-CharacterData.vala b/gxml/libxml-CharacterData.vala
index 4d5ef5c..f7b6829 100644
--- a/gxml/libxml-CharacterData.vala
+++ b/gxml/libxml-CharacterData.vala
@@ -27,7 +27,7 @@ namespace GXml {
/**
* CharacterData defines an interface for manipulating XML character data.
*
- * It is used by the { link GXml.CDATASection},
+ * It is used by the { link GXml.xCDATASection},
* { link GXml.Text}, and { link GXml.Comment} node types.
*
* Version: DOM Level 1 Core<<BR>>
diff --git a/gxml/libxml-Document.vala b/gxml/libxml-Document.vala
index 660f584..90e18db 100644
--- a/gxml/libxml-Document.vala
+++ b/gxml/libxml-Document.vala
@@ -480,10 +480,10 @@ namespace GXml {
/**
* Creates a xDocument from data found in memory using options.
*
- * @param xml: A string representing an XML document
- * @param url: the base URL to use for the document
- * @param encoding: the document encoding
- * @param options: a combination of { link Xml.ParserOption}
+ * @param xml A string representing an XML document
+ * @param url the base URL to use for the document
+ * @param encoding the document encoding
+ * @param options a combination of { link Xml.ParserOption}
*
* @return A new { link GXml.xDocument} from `memory`; this must be freed with { link
GLib.Object.unref}
*/
@@ -702,7 +702,7 @@ namespace GXml {
*
* @param cdata_data The content for the CDATA section
*
- * @return A new { link GXml.CDATASection} with the
+ * @return A new { link GXml.xCDATASection} with the
* supplied data; this should not be freed
*/
public unowned xCDATASection create_cdata_section (string cdata_data) {
@@ -760,7 +760,7 @@ namespace GXml {
}
/**
- * Creates an { link GXml.Attr} attribute with `name`, usually to be associated with an
xElement.
+ * Creates an { link GXml.Attribute} attribute with `name`, usually to be associated with an
xElement.
*
* XML example: {{{<element attributename="attributevalue">content</element>}}}
*
@@ -769,7 +769,7 @@ namespace GXml {
*
* @param name The `name` of the attribute
*
- * @return A new { link GXml.Attr} with the given `name`; this should not be freed
+ * @return A new { link GXml.Attribute} with the given `name`; this should not be freed
*/
public xAttr create_attribute (string name) {
/* TODO: figure out memory for this; its a
diff --git a/gxml/libxml-Element.vala b/gxml/libxml-Element.vala
index 1b51388..5ae0356 100644
--- a/gxml/libxml-Element.vala
+++ b/gxml/libxml-Element.vala
@@ -83,7 +83,7 @@ namespace GXml {
/**
* Contains a { link GXml.NamedAttrMap} of
- * { link GXml.Attr} attributes associated with this
+ * { link GXml.Attribute} attributes associated with this
* { link GXml.xElement}.
*
* Attributes in the NamedNodeMap are updated live, so
@@ -285,33 +285,6 @@ namespace GXml {
return ret;
}
-
- /* Visual explanation of get_elements_by_tag_name tree traversal.
- a
- b c
- d e f g
-
- we want: a b d e c f g
-
- start:
- add a
-
- pop top of stack (a)
- a: check for match: yes? add to return list
- a: add children from last to first (c,b) to top of stack (so head=b, then c)
-
- a
- a< [bc]
- b< [de]c
- d< ec
- e< c
- c< [fg]
- f< g
- g<
-
- see a, add a, visit a
- */
-
/* This keeps a list of all descendants with a given tag name, so you can do
elem.get_elements_by_tag_name ("name") and find them quickly; whenever a
node is added to the DOM, all its ancestors have it added to their list */
@@ -358,6 +331,33 @@ namespace GXml {
* This will include the current element if it
* matches. The returned list is updated as necessary
* as the tree changes.
+ *
+ * Visual explanation of get_elements_by_tag_name tree traversal.
+ * {{{
+ * a
+ * b c
+ * d e f g
+ *
+ * we want: a b d e c f g
+ *
+ * start:
+ * add a
+ *
+ * pop top of stack (a)
+ * a: check for match: yes? add to return list
+ * a: add children from last to first (c,b) to top of stack (so head=b, then c)
+ *
+ * a
+ * a< [bc]
+ * b< [de]c
+ * d< ec
+ * e< c
+ * c< [fg]
+ * f< g
+ * g<
+ *
+ * see a, add a, visit a
+ * }}}
*
* Version: DOM Level 1 Core<<BR>>
* URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#ID-1938918D]]
@@ -365,11 +365,10 @@ namespace GXml {
* @param tag_name The tag name to match for
*
* @return A NodeList containing the matching descendants
- */
- /*TODO: make sure we want to include the current
- * element, I think probably not.
+ *
*/
public NodeList get_elements_by_tag_name (string tag_name) {
+ //TODO: make sure we want to include the current element, I think probably not.
TagNameNodeList tagged = new TagNameNodeList (tag_name, this, this.owner_document);
//List<xNode> tagged = new List<xNode> ();
Queue<Xml.Node*> tocheck = new Queue<Xml.Node*> ();
diff --git a/gxml/libxml-NamespaceAttr.vala b/gxml/libxml-NamespaceAttr.vala
index a24c0f4..c7fe439 100644
--- a/gxml/libxml-NamespaceAttr.vala
+++ b/gxml/libxml-NamespaceAttr.vala
@@ -27,7 +27,7 @@ namespace GXml {
* Represents an XML Namespace for a { link GXml.Node} node.
*
* These represent
- * prefix=uri pairs that define namespaces for XML { link GXml.xElements}
+ * prefix=uri pairs that define namespaces for XML { link GXml.xElement}
* and { link GXml.xAttr}.
*/
public class NamespaceAttr : xNode, GXml.Namespace {
diff --git a/gxml/libxml-Node.vala b/gxml/libxml-Node.vala
index 63cb3a3..48b03b9 100644
--- a/gxml/libxml-Node.vala
+++ b/gxml/libxml-Node.vala
@@ -122,7 +122,7 @@ namespace GXml {
/**
* Set namespace to this { link GXml.xNode}
*
- * Returns: { link true} if namespace exists.
+ * Returns: true if namespace exists.
*/
public virtual bool set_namespace (string uri, string? namespace_prefix)
{
@@ -170,7 +170,7 @@ namespace GXml {
/**
* Stores the name of the node. Sometimes this is
* similar to the node type, but sometimes, it is
- * arbitrary data, like for { link GXml.Attr} where
+ * arbitrary data, like for { link GXml.Attribute} where
* the node_name is the name of the Attr's name=value
* pair.
*
@@ -208,7 +208,7 @@ namespace GXml {
/**
* Stores the type of node. Most XML structures are
* nodes of different types, like { link GXml.xDocument}
- * as a { link GXml.NodeType.DOCUMENT}, { link GXml.Attr}
+ * as a { link GXml.NodeType.DOCUMENT}, { link GXml.Attribute}
* as a { link GXml.NodeType.ATTRIBUTE}, Element as a
* { link GXml.NodeType.ELEMENT}, etc.
*
@@ -333,7 +333,7 @@ namespace GXml {
}
/**
- * A { link GXml.NamedNodeMap} containing the { link GXml.Attr}
+ * A { link GXml.NamedNodeMap} containing the { link GXml.Attribute}
* attributes for this node. `attributes`
* actually only apply to { link GXml.Element}
* nodes. For all other { link GXml.xNode} subclasses,
@@ -457,7 +457,7 @@ namespace GXml {
*
* URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#method-hasChildNodes]]
*
- * @return %TRUE if this node has children, %FALSE if not
+ * @return true if this node has children, false if not
*/
public virtual bool has_child_nodes () {
return false;
@@ -470,7 +470,7 @@ namespace GXml {
*
* URL: [[http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#method-cloneNode]]
*
- * @param deep If %TRUE, descendants are cloned as well. If %FALSE, they are not
+ * @param deep If true, descendants are cloned as well. If false, they are not
*
* @return A parentless clone of this node. Do not
* free it, its memory will be released when the owning
@@ -491,7 +491,7 @@ namespace GXml {
* libxml2 will not handle that case. (See libxml2's
* xmlNodeDumpOutput internals to understand more.)
*
- * @param format %FALSE: no formatting, %TRUE: formatted, with indentation
+ * @param format %FALSE: no formatting, true: formatted, with indentation
* @param level Indentation level
*
* @return XML string for node, which must be free
diff --git a/gxml/libxml-NodeList.vala b/gxml/libxml-NodeList.vala
index e8ace71..19d3343 100644
--- a/gxml/libxml-NodeList.vala
+++ b/gxml/libxml-NodeList.vala
@@ -31,7 +31,7 @@ namespace GXml {
* 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}.
+ * the results of { link GXml.xElement.get_elements_by_tag_name}.
* { link GXml.NodeList} implements both the DOM Level 1 Core API for
* a NodeList, as well as the { link GLib.List} API, to make
* it more accessible and familiar to GLib programmers.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
