diff --git a/NEWS b/NEWS index ebe86c6ffa8266b0378d71dd5e3a247b0be2e0a4..029454baf07128d607bd0c1c0ba67c74003e124a 100644 --- a/NEWS +++ b/NEWS @@ -1,9 +1,9 @@ =============== Version 0.20.0 =============== -* Transsition from pre 0.20 API, can be found at Wiki https://gitlab.gnome.org/GNOME/gxml/wikis/home +* Transition from pre 0.20 API, can be found at Wiki https://gitlab.gnome.org/GNOME/gxml/wikis/home * API simplification (breaks) -* Revome of obsolete and deprecated API +* Remove of obsolete and deprecated API * Meson: options renaming * Gom* classes renamed by removing the Gom prefix (API simplification) this means, for example: GomDocument to Document and GomElement to Element. @@ -100,7 +100,7 @@ Version 0.16.0 * GomDocument: Fixed get_element_by_id() * XPath: Reimplemented write_stream_async, create_stream_async * Gom: DocumenType write remove DTD definitions [] -* Gom: Added suppòrt for DOCTYPE definitions +* Gom: Added support for DOCTYPE definitions * Fixed lookup_namespace_uri() * Better support of xmlns http://www.w3.org/2000/xmlns * Fixes for Vala 0.39 @@ -174,7 +174,7 @@ Version 0.14.2 Version 0.14.1 =============== -* valadoc in not necesary to build from tarball +* valadoc is not necessary to build from tarball * New and updated translations: Updated Swedish by Josef Andersson Updated Polish by Piotr Drąg @@ -308,7 +308,7 @@ Version 0.10.0 Version 0.9.92 =============== -* New contructor methods for TDocument using custome ReadTypeFunc +* New constructor methods for TDocument using custom ReadTypeFunc * Bug fixes * New and updated translations: Updated Polish by Piotr Drąg @@ -371,7 +371,7 @@ API/ABI break * API change: Removed GXml.SerializableJson and GXml.Serialization, due to they have been unmaintained for a while now. -* API change: GXml.NodeList is now a Gee.ArrayList specialiced class for better +* API change: GXml.NodeList is now a Gee.ArrayList specialized class for better bindings support. The old class has been renamed to GXml.xNodeList. * API change: Most interfaces now return owned properties in order to allow implementations @@ -383,13 +383,13 @@ API/ABI break * New HtmlDocument for HTML handling -* Element interface removed finalize_attr (), due it is unsed +* Element interface removed finalize_attr (), due it is unused * Element added new get_ns_attr() for namespaced attributes * Element implements set_ns_attr() -* xNode and derivatives enter to a maintenace status, in order +* xNode and derivatives enter to a maintenance status, in order to be deprecated in future, some tests haven't been added due to its internal complexity, like poor namespaces support. Is better to relay on GNode and derivatives. DOM API will be added @@ -407,7 +407,7 @@ API/ABI break Version 0.8.2 =============== -* Fixed sigfault on xDocument.from_stream() +* Fixed segfault on xDocument.from_stream() * Added test for remote file read using GLib.File ============= @@ -466,7 +466,7 @@ Version 0.6.0 This new version is API/ABI incompatible with 0.4 series. -Most work has been on simplifying API for Vala programers users, using interfaces and +Most work has been on simplifying API for Vala programmers users, using interfaces and Gee classes, allowing to create new backends based or different from libxml2. This work allowed to re-implement existing classes without radically modify API for existing applications and makes room to improve performance and memory usage. @@ -474,7 +474,7 @@ applications and makes room to improve performance and memory usage. News and changes are as follow: -* Added new interfaces to simplify implementing new backends for XML reading/writting, +* Added new interfaces to simplify implementing new backends for XML reading/writing, containers are Gee ones. * Renamed GXml 0.4 DOM classes to prefixing a "x", to avoid conflicts with new interfaces @@ -482,7 +482,7 @@ News and changes are as follow: * GXml DOM classes, now implement new interfaces * GXml DOM classes now implement Gee interfaces to access directly to libxml2 structures, - reducing extra processing and memory consumption when they are referenced from permament + reducing extra processing and memory consumption when they are referenced from permanent on memory GObject classes. Reimplementing most other DOM classes to implement Gee classes in on roadmap, to reduce memory and possibly increase performance on parsing. @@ -526,7 +526,7 @@ Version 0.4 ============= - Added Examples (Richard Schwarting) - Improved Build system (Daniel Espinosa) -- Windows crosscopilation support (Daniel Espinosa) +- Windows cross-compilation support (Daniel Espinosa) - Added/Improved Serialization Framework (Richard Schwarting, Daniel Espinosa) - Added missing License (Richard Schwarting) - Renamed DomNode to Node (Richard Schwarting) diff --git a/README b/README index 5d3814a1e2d7c05d91f6ddf00927930d6a76cac9..b2596b2c72f014f7e48fd348415743bdec037439 100644 --- a/README +++ b/README @@ -89,7 +89,7 @@ Writing documentation - Documentation for overriding functions/methods is shown in valadoc, but not in gtkdoc. For gtkdoc, you can only go up to the original superclass to see what's been available, even if it's - been overriden. (Would we want this to be any different for + been overridden. (Would we want this to be any different for gtkdoc?) - We don't get an Object Hierarchy in our gtkdoc with valadoc :( @@ -101,7 +101,7 @@ Writing documentation reverse. TODO: write a patch to valadoc :D - - Multiline descriptions will only have the first line appear in + - Multi-line descriptions will only have the first line appear in valadoc. - For the gtkdoc or valadoc to be visible in devhelp and you're installing into @@ -109,6 +109,6 @@ Writing documentation installed gtk-doc in /usr/share/gtk-doc/html/. For example, $ ln -s ~/.local/share/gtk-doc/html/gxml /usr/share/gtk-doc/html - - Valadoc's documentation use JavaScript to naviate over inherited + - Valadoc's documentation use JavaScript to navigate over inherited methods and properties, but DevHelp have no support for that. TODO: write a patch to DevHelp to support Valadoc's JavaScript diff --git a/docs/mallard/C/gxml-serializable-objectmodel.page b/docs/mallard/C/gxml-serializable-objectmodel.page index c227d126c6c16f74098ad5dc08c169bc49bd391b..48b6c10fa6ca3f7ca9a1e24aa21e1b95c8772a96 100644 --- a/docs/mallard/C/gxml-serializable-objectmodel.page +++ b/docs/mallard/C/gxml-serializable-objectmodel.page @@ -15,5 +15,5 @@ SerializableObjectModel implementation

SerializableObjectModel is a class implementing Serializable interface. This implementation consider each object as a XML node, represented in GXml as a GXml.Element and its properties is represented by GXml.Attr. Each property, if it is a Serializable object, is represented as child nodes.

-

If a object's value property must be represented as a XML node content, then it requires to override serialize_use_xml_node_value() and set value at serialized_xml_node_value, as decribed at Node content.

+

If a object's value property must be represented as a XML node content, then it requires to override serialize_use_xml_node_value() and set value at serialized_xml_node_value, as described at Node content.

diff --git a/docs/mallard/C/gxml-serializable.page b/docs/mallard/C/gxml-serializable.page index 6b9f32ec7aed1c57f534057d17290eef3b8476a2..d262e294be27a73744c1896eab271f93aa8e5513 100644 --- a/docs/mallard/C/gxml-serializable.page +++ b/docs/mallard/C/gxml-serializable.page @@ -14,12 +14,12 @@ Serializable Interface -

Implementors of this interface, could define or override the way you want to represent your class in a XML file.

+

Implementers of this interface, could define or override the way you want to represent your class in a XML file.

Serializable properties

You can get control on class's properties to be serialized to XML. Allowing to provide ones, storing runtime information and ones to be stored in XML. By default, all object's properties are serialized. In order to skip properties from serialization process you must add its canonical name as key and its canonical name as value, to ignored_serializable_properties store.

-

Implementator must use ignored_serializable_properties property to check if a property should be serialized. This allows to dynamically remove, on convenience, properties on serialization. You can use list_serializable_properties() method as a convenient function, using its default implementation, or even override it at your convenience to automate dynamic serializable properties at run time; just make sure to skip the unwanted properties.

-

There are more methods to avoid properties serialization, like to override init_properties default implementation. It stores all Serializale's properties to be ignored by default; you must ensure to initialize correctly, by calling default_init_properties() method before any other code in your overrided method.

+

Implementer must use ignored_serializable_properties property to check if a property should be serialized. This allows to dynamically remove, on convenience, properties on serialization. You can use list_serializable_properties() method as a convenient function, using its default implementation, or even override it at your convenience to automate dynamic serializable properties at run time; just make sure to skip the unwanted properties.

+

There are more methods to avoid properties serialization, like to override init_properties default implementation. It stores all Serializale's properties to be ignored by default; you must ensure to initialize correctly, by calling default_init_properties() method before any other code in your overridden method.

Unknown XML elements

XML allows great flexibility, providing different ways to represent the same information. This is a problem when you try to deserialize them.

@@ -27,23 +27,23 @@
Property's name -

When serialize a class property, by default it uses its name given on class declaration, but is less common to see XML node mproperties with name like your_property, but more common is to use YourProperty. In order to use this kind of names, your implementation should use properties' nick name and override property_use_nick() method to return true. This should instruct your code to use this method to use property's nick name. This is the default in GXml default implementations.

+

When serialize a class property, by default it uses its name given on class declaration, but is less common to see XML node properties with name like your_property, but more common is to use YourProperty. In order to use this kind of names, your implementation should use properties' nick name and override property_use_nick() method to return true. This should instruct your code to use this method to use property's nick name. This is the default in GXml default implementations.

In order to set node's name, you should override node_name() method.

XML node's content -

By default GXml's implementations doesn't deseriaze/serialize XML node contents. In order to enable it, you must override serialize_use_xml_node_value() method to return true and store XML node's content to serialized_xml_node_value property.

-

Implementors could set up methods to provide a clean easy to use API to set nodes contents. In most cases, users would like to set a value through a getter or setter or through a property in the class. If you use a property, you should add it to ignored_serializable_properties in order to see its value in a XML node property.

+

By default GXml's implementations doesn't deserialize/serialize XML node contents. In order to enable it, you must override serialize_use_xml_node_value() method to return true and store XML node's content to serialized_xml_node_value property.

+

Implementers could set up methods to provide a clean easy to use API to set nodes contents. In most cases, users would like to set a value through a getter or setter or through a property in the class. If you use a property, you should add it to ignored_serializable_properties in order to see its value in a XML node property.

XML node name -

On serialization XML node's name could be set to use a prety one. By default, node's name is the class name; becareful because name could be GXmlSerializable, while may you prefer to use just 'Serializable'.

+

On serialization XML node's name could be set to use a prety one. By default, node's name is the class name; be careful because name could be GXmlSerializable, while may you prefer to use just 'Serializable'.

In order to set node's name, you should override node_name() method.

Serialize -

Serializable interface allows you to implement your own serialize() method. Your implementation should take a GXml.Node and serialize over it. Given GXml.Node, could be an GXml.Element or a GXml.Document, your implementaiton should take care about this and return XML nodes representing your class object.

+

Serializable interface allows you to implement your own serialize() method. Your implementation should take a GXml.Node and serialize over it. Given GXml.Node, could be an GXml.Element or a GXml.Document, your implementation should take care about this and return XML nodes representing your class object.

Serialize a property @@ -51,7 +51,7 @@
Deserialize -

Serializable interface allows you to implement your own deserialize() method. Your implementation should take a GXml.Node and deserialize from it. Given GXml.Node, could be an GXml.Element or a GXml.Document, your implementaiton should take care about this and return XML nodes representing your class object.

+

Serializable interface allows you to implement your own deserialize() method. Your implementation should take a GXml.Node and deserialize from it. Given GXml.Node, could be an GXml.Element or a GXml.Document, your implementation should take care about this and return XML nodes representing your class object.

Your implementation could take GXml.Element's name to detect the property to set up or detect the root element in a GXml.Document to use. Then you can iterate over all node's properties and set up your object properties; you can use gvalue_to_string() to transform most common value types from string to the required value's type.

Supported types @@ -63,7 +63,7 @@

enumerations
-

Enumerations have a set of utility methods to better represent on serialisation/deserialization.

+

Enumerations have a set of utility methods to better represent on serialization/deserialization.

Enumerations could be converted to string using its definition on GLib.EnumClass, by taking its nick name directly or converting to its camel case representation.

Any enumeration value type in a GLib.Object's property could be deserialized from its definition given on GLib.EnumClass (name and nick) or from its camel case representation.

diff --git a/docs/site/index.html b/docs/site/index.html index 926cda266222f8da5ad89cf0b878412d07af6dfe..64caf263477f5a4a50a2b567852e71f6f03f7cc6 100644 --- a/docs/site/index.html +++ b/docs/site/index.html @@ -6,7 +6,7 @@

About GXml

GXml is a library providing DOM4 and XSD API based on GObject.

-

GXml provides wrapping aroung libxml2 and a pure GObjec implementation, +

GXml provides wrapping around libxml2 and a pure GObjec implementation, along with CSS Selectors, XPath expressions ans serialization of GObject classes to XML and back.

For more recent details, checkout diff --git a/examples/js/node_self.js b/examples/js/node_self.js index 7ef897305bd1fe16d0319445698547d302113f2c..49c9997fa3a87e1042b6a2186cd91aed85438672 100755 --- a/examples/js/node_self.js +++ b/examples/js/node_self.js @@ -28,7 +28,7 @@ var first_book = book_list.get_element (0); var ath = first_book.get_attribute ("author"); var att = first_book.get_attribute ("title"); -print ("Autor: "+ath+" Title: "+att); +print ("Author: "+ath+" Title: "+att); var attrs = first_book.get_attributes (); print ("Attrs type:"+attrs.constructor); diff --git a/gxml/ArrayList.vala b/gxml/ArrayList.vala index 0e558ec4e8c8d7cb9d0ad8df3339b4366baa1e8d..16d51ae267e182d2d25e5975bf900b391f7f9311 100644 --- a/gxml/ArrayList.vala +++ b/gxml/ArrayList.vala @@ -24,7 +24,7 @@ using Gee; /** - * A class impementing {@link Collection} to store references to + * A class implementing {@link Collection} to store references to * child {@link DomElement} of {@link Collection.element}, using an index. * * {{{ diff --git a/gxml/Attr.vala b/gxml/Attr.vala index 5da7298e1684fe80c26ea7c3baba1b44d44dcf1b..7602228df5a481791fe0208fe1e75467eb6ebed3 100644 --- a/gxml/Attr.vala +++ b/gxml/Attr.vala @@ -24,7 +24,7 @@ using GXml; using Gee; /** - * DOM4 implemenation of {@link DomAttr}. + * DOM4 implementation of {@link DomAttr}. */ public class GXml.Attr : GXml.Node, GXml.DomAttr { protected string _namespace_uri; diff --git a/gxml/BaseCollection.vala b/gxml/BaseCollection.vala index 1184451f60357738aeaa7e25c3b9c22c4a77069a..9ce608023b5cc78f6580ff5ed779f8b1c49e1332 100644 --- a/gxml/BaseCollection.vala +++ b/gxml/BaseCollection.vala @@ -23,7 +23,7 @@ using Gee; /** - * Base class for collections implemeting {@link Collection}, priving basic + * Base class for collections implementing {@link Collection}, providing basic * infrastructure. * * Collections properties should be initialized with current container element @@ -32,7 +32,7 @@ using Gee; */ public abstract class GXml.BaseCollection : GLib.Object, Traversable, Iterable, Collection { /** - * A collection of node's index refered. Don't modify it manually. + * A collection of node's index referred. Don't modify it manually. */ protected GLib.Queue _nodes_index = new GLib.Queue (); /** @@ -45,13 +45,13 @@ public abstract class GXml.BaseCollection : GLib.Object, Traversable * contained in this collection. * * Used when reading to add elements to collection. You can set it at construction time, - * by, for example, instantaiting a object of the type {@link Collection.items_type} + * by, for example, instantiating a object of the type {@link Collection.items_type} * then use {@link GXml.Element.local_name}'s value. */ protected string _items_name = ""; /** * Objects' type to be referenced by this collection and to deserialize objects. - * Derived classes, can initilize this value at constructor or as construct property. + * Derived classes, can initialize this value at constructor or as construct property. * * Used when reading and at initialization time, to know {@link GXml.Element.local_name} * at runtime. @@ -95,11 +95,11 @@ public abstract class GXml.BaseCollection : GLib.Object, Traversable } /** * Initialize an {@link Collection} to use an element as children's parent. - * Searchs for all nodes, calling {@link Collection.search} + * Searches for all nodes, calling {@link Collection.search} * with {@link Collection.items_type}, using its * {@link DomElement.local_name} to find it. * - * Implemenation classes, should initialize collection to hold a {@link GXml.Element} + * Implementation classes, should initialize collection to hold a {@link GXml.Element} * derived type using {@link Collection.initialize}. */ public void initialize_element (GXml.Element e) throws GLib.Error { @@ -169,7 +169,7 @@ public abstract class GXml.BaseCollection : GLib.Object, Traversable var i = iterator (); return i.foreach (f); } - // Itarable Interface + // Iterable Interface public Iterator iterator () { return new CollectionIterator (this); } // For Iterable interface implementation private class CollectionIterator : GLib.Object, Traversable, Iterator { diff --git a/gxml/Collections.vala b/gxml/Collections.vala index be227a5c50c952bbd7bbeb4454d2e5df7955e5a7..4b441d644e2bd183f90699d61bb63c9abc7e529a 100644 --- a/gxml/Collections.vala +++ b/gxml/Collections.vala @@ -170,7 +170,7 @@ public interface GXml.Collection : GLib.Object */ public abstract bool validate_append (int index, DomElement element) throws GLib.Error; /** - * Clear this collection in prepareation for a search + * Clear this collection in preparation for a search */ public abstract void clear () throws GLib.Error; } @@ -181,7 +181,7 @@ public interface GXml.Collection : GLib.Object public interface GXml.List : GLib.Object, Collection, Traversable, Iterable {} /** - * Inteface to be implemented by {@link GXml.Collection} derived classes + * Interface to be implemented by {@link GXml.Collection} derived classes * in order to provide a string to be used in {@link GXml.HashMap} as key. * * If {@link GXml.HashMap} has set its {@link GXml.HashMap.attribute_key} @@ -217,7 +217,7 @@ public interface GXml.Map : GLib.Object, GXml.Collection, Traversable, DomNamedNodeMap { private TreeMap order = new TreeMap (); /** - * Holds {@link GXml.Element} refrence to attributes' parent element. + * Holds {@link GXml.Element} reference to attributes' parent element. * Derived classes should not modify, but set at construction time. */ protected GXml.Element _element; @@ -658,7 +658,7 @@ public class GXml.Element : GXml.Node, } if (p == "xmlns" && namespace_uri != "http://www.w3.org/2000/xmlns/" && namespace_uri != "http://www.w3.org/2000/xmlns") { - throw new DomError.NAMESPACE_ERROR (_("Invalid namespace. 4If attribute's prefix is xmlns, namespace URI should be http://www.w3.org/2000/xmlns")); + throw new DomError.NAMESPACE_ERROR (_("Invalid namespace. If attribute's prefix is xmlns, namespace URI should be http://www.w3.org/2000/xmlns")); } if (p == "" && n == "xmlns" && (namespace_uri != "http://www.w3.org/2000/xmlns/" @@ -704,7 +704,7 @@ public class GXml.Element : GXml.Node, public DomHTMLCollection get_elements_by_tag_name (string local_name) { var l = new HTMLCollection (); - //FIXME: quircks mode not considered + //FIXME: quirks mode not considered foreach (GXml.DomNode n in child_nodes) { if (!(n is DomElement)) continue; if (n.node_name == local_name) @@ -715,7 +715,7 @@ public class GXml.Element : GXml.Node, } public DomHTMLCollection get_elements_by_tag_name_ns (string? namespace, string local_name) { var l = new HTMLCollection (); - //FIXME: quircks mode not considered + //FIXME: quirks mode not considered foreach (GXml.DomNode n in child_nodes) { if (!(n is DomElement)) continue; if (n.node_name == local_name diff --git a/gxml/HashMap.vala b/gxml/HashMap.vala index 15deb0b85613a22b23bdd7eec8dd897ed5f3fa64..919f16f389ce599e579cbacb82b7bb757ffea28a 100644 --- a/gxml/HashMap.vala +++ b/gxml/HashMap.vala @@ -24,7 +24,7 @@ using Gee; /** - * A class impementing {@link Collection} to store references to + * A class implementing {@link Collection} to store references to * child {@link DomElement} of {@link Collection.element}, using an attribute in * items as key or {@link MappeableElement.get_map_key} method if implemented * by items to be added. If key is not defined in node, it is not added; but @@ -53,7 +53,7 @@ using Gee; */ public class GXml.HashMap : GXml.BaseCollection, GXml.Map { /** - * A hashtable with all keys as string to node's index refered. Don't modify it manually. + * A hashtable with all keys as string to node's index referred. Don't modify it manually. */ protected Gee.HashMap _hashtable = new Gee.HashMap (); /** diff --git a/gxml/HashPairedMap.vala b/gxml/HashPairedMap.vala index f385426d4f3f55b09eab3a5b8a5bfbcee34d574a..7cabbe8aa87492a688db0d27064efa7ec01d8ff6 100644 --- a/gxml/HashPairedMap.vala +++ b/gxml/HashPairedMap.vala @@ -24,7 +24,7 @@ using Gee; /** - * A class impementing {@link Collection} to store references to + * A class implementing {@link Collection} to store references to * child {@link DomElement} of {@link Collection.element}, using two attributes in * items as primary and secondary keys or {@link MappeableElementPairKey.get_map_primary_key} * and {@link MappeableElementPairKey.get_map_secondary_key} methods if @@ -61,11 +61,11 @@ using Gee; */ public class GXml.HashPairedMap : GXml.BaseCollection, GXml.PairedMap { /** - * A hashtable with all keys as string to node's index refered. Don't modify it manually. + * A hashtable with all keys as string to node's index referred. Don't modify it manually. */ protected Gee.HashMap> _hashtable = new Gee.HashMap> (); /** - * Element's attribute name used to refer of container's element as primery key. + * Element's attribute name used to refer of container's element as primary key. * You should define it at construction time * our set it as a construction property. */ @@ -131,7 +131,7 @@ public class GXml.HashPairedMap : GXml.BaseCollection, GXml.PairedMap { return _element.child_nodes.get (i) as DomElement; } /** - * Returns true if @key is used in collection as primery key. + * Returns true if @key is used in collection as primary key. */ public bool has_primary_key (string key) { if (_hashtable.has_key (key)) return true; diff --git a/gxml/HashThreeMap.vala b/gxml/HashThreeMap.vala index d661a82c146adf523521aad48fa9bf37af0702d7..de4e21702046846cd2a42c9b0197dabe0a837372 100644 --- a/gxml/HashThreeMap.vala +++ b/gxml/HashThreeMap.vala @@ -24,7 +24,7 @@ using Gee; /** - * A class impementing {@link Collection} to store references to + * A class implementing {@link Collection} to store references to * child {@link DomElement} of {@link Collection.element}, using three attributes in * items as primary, secondary tertiary keys or {@link MappeableElementThreeKey.get_map_pkey}, * {@link MappeableElementThreeKey.get_map_skey} @@ -66,11 +66,11 @@ using Gee; */ public class GXml.HashThreeMap : GXml.BaseCollection, ThreeMap { /** - * A hashtable with all keys as string to node's index refered. Don't modify it manually. + * A hashtable with all keys as string to node's index referred. Don't modify it manually. */ protected Gee.HashMap>> _hashtable = new Gee.HashMap>> (); /** - * Element's attribute name used to refer of container's element as primery key. + * Element's attribute name used to refer of container's element as primary key. * You should define it at construction time * our set it as a construction property. */ @@ -156,7 +156,7 @@ public class GXml.HashThreeMap : GXml.BaseCollection, ThreeMap { return _element.child_nodes.get (i) as DomElement; } /** - * Returns true if @key is used in collection as primery key. + * Returns true if @key is used in collection as primary key. */ public bool has_primary_key (string key) { if (_hashtable.has_key (key)) return true; diff --git a/gxml/IXsdSchema.vala b/gxml/IXsdSchema.vala index 58f607a7c5907812a73c5d9e9f2f45650a96eaea..17f122c34487fd9a0e619be26fc6446f647c463c 100644 --- a/gxml/IXsdSchema.vala +++ b/gxml/IXsdSchema.vala @@ -63,7 +63,7 @@ public interface GXml.IXsdTypeRestriction : GLib.Object, IXsdTypeDef { public abstract string base { get; set; } public abstract string id { get; set; } public abstract IXsdSimpleType simple_type { get; set; } - // TODO: Add all other definitons: like MinExclusive and others + // TODO: Add all other definitions: like MinExclusive and others public abstract IXsdListTypeRestrictionEnumerations enumerations { get; set; } public abstract IXsdListTypeRestrictionWhiteSpaces white_spaces { get; set; } } diff --git a/gxml/Object.vala b/gxml/Object.vala index c98758cdf5dba78e9000ee87679c3e5773350433..a82df488cfdeae67cecac2fe027fada348075a91 100644 --- a/gxml/Object.vala +++ b/gxml/Object.vala @@ -363,7 +363,7 @@ public interface GXml.Object : GLib.Object, * If property is a {@link Collection} it is initialize to use * this as its {@link Collection.element}. * - * Instance is set ot object's property. + * Instance is set to object's property. * * Property should be a {@link GXml.Element} or {@link Collection} * diff --git a/gxml/Parser.vala b/gxml/Parser.vala index 3012e636d7eb62f18ad4c14c359922ac3297bb34..f773307fa77e7a9bc7f691bf927fed02b68f1bc1 100644 --- a/gxml/Parser.vala +++ b/gxml/Parser.vala @@ -40,11 +40,11 @@ public interface GXml.Parser : GLib.Object { */ public abstract bool backup { get; set; } /** - * Controls if, when writing, identation should be used. + * Controls if, when writing, indentation should be used. */ public abstract bool indent { get; set; } /** - * Controls if, when writing, identation should be used. + * Controls if, when writing, indentation should be used. */ public abstract Cancellable? cancellable { get; set; } /** @@ -250,7 +250,7 @@ public interface GXml.Parser : GLib.Object { if (col.items_type == GLib.Type.INVALID || !(col.items_type.is_a (typeof (GXml.Object)))) { throw new DomError.INVALID_NODE_TYPE_ERROR - (_("Collection '%s' hasn't been constructed properly: items type propeerty was not set at construction time or set to invalid type"), col.get_type ().name ()); + (_("Collection '%s' hasn't been constructed properly: items' type property was not set at construction time or set to invalid type"), col.get_type ().name ()); } if (col.items_name == "" || col.items_name == null) { throw new DomError.INVALID_NODE_TYPE_ERROR @@ -262,7 +262,7 @@ public interface GXml.Parser : GLib.Object { } if (!(col.element is GXml.Object)) { throw new DomError.INVALID_NODE_TYPE_ERROR - (_("Invalid object of type '%s' doesn't implemement GXml.Object interface: can't be handled by the collection"), col.element.get_type ().name ()); + (_("Invalid object of type '%s' doesn't implement GXml.Object interface: can't be handled by the collection"), col.element.get_type ().name ()); } if (col.items_name.down () == current_node_name ().down ()) { if (parent.owner_document == null) @@ -280,11 +280,11 @@ public interface GXml.Parser : GLib.Object { return false; } /** - * Read all childs node feed by stream. + * Read all children node feed by stream. */ public abstract void read_child_nodes_stream (GLib.InputStream istream) throws GLib.Error; /** - * Read childs nodes from string + * Read children nodes from string */ public virtual void read_child_nodes_string (string str) throws GLib.Error { if (str == "") @@ -301,7 +301,7 @@ public interface GXml.Parser : GLib.Object { */ public abstract bool move_next_node () throws GLib.Error; /** - * Check if current node has childs. + * Check if current node has children. */ public abstract bool current_is_empty_element (); /** diff --git a/gxml/Property.vala b/gxml/Property.vala index 889c514f3c1cbe9fcbe51d1f86517a95d435b0f1..7bffe363cd7c870c40c1a9cc56b7b8fbb04888c4 100644 --- a/gxml/Property.vala +++ b/gxml/Property.vala @@ -24,7 +24,7 @@ /** * An interface for {@link GXml.Object}'s properties translated to * {@link DomElement} attributes. If object is instantiated it is - * written, if not is just ingnored. + * written, if not is just ignored. */ public interface GXml.Property : GLib.Object { @@ -217,7 +217,7 @@ public class GXml.XsdArrayString : ArrayString { /** * Convenient class to handle {@link Element}'s attributes - * using double pressition floats as sources of values. + * using double precision floats as sources of values. * * Property is represented as a string. */ @@ -238,7 +238,7 @@ public class GXml.Double : GXml.BaseProperty { */ public uint decimals { get; set; default = 4; } /** - * Retrive current value. + * Retrieve current value. */ public double get_double () { return _value; } /** @@ -255,7 +255,7 @@ public class GXml.Double : GXml.BaseProperty { */ public class GXml.Float : Double { /** - * Retrive current value. + * Retrieve current value. */ public float get_float () { return (float) _value; } /** @@ -282,7 +282,7 @@ public class GXml.Int : GXml.BaseProperty { } } /** - * Retrive current value. + * Retrieve current value. */ public int get_integer () { return _value; } /** @@ -308,7 +308,7 @@ public class GXml.Boolean : GXml.BaseProperty { } } /** - * Retrive current value. + * Retrieve current value. */ public bool get_boolean () { return _value; } /** @@ -322,7 +322,7 @@ public class GXml.Boolean : GXml.BaseProperty { * using a {@link GLib.Type.ENUM} as a source of values. * * Enumeration is represented as a string, using its name, independent of - * value possition in enumeration. + * value position in enumeration. */ public class GXml.Enum : GXml.BaseProperty { protected int _value = 0; @@ -351,7 +351,7 @@ public class GXml.Enum : GXml.BaseProperty { */ public bool use_nick { get; construct set; } /** - * Tries to convert the value to CamelCase using its nick non canical name. Defaults to FALSE. + * Tries to convert the value to CamelCase using its nick non canonical name. Defaults to FALSE. * * An enum declared as 'ENUM_VALUE', its value is converted to 'EnumValue'. See * {@link use_nick} for details. @@ -419,7 +419,7 @@ public class GXml.Enum : GXml.BaseProperty { _enum_type = enum_type; } /** - * Retrive current value. + * Retrieve current value. */ public int get_enum () { return (int) _value; } /** @@ -470,7 +470,7 @@ public class GXml.Date : GXml.BaseProperty { } } /** - * Retrives current value. + * Retrieves current value. */ public GLib.Date get_date () { return _value; } /** @@ -509,7 +509,7 @@ public class GXml.DateTime : GXml.BaseProperty { } } /** - * Retrives current value. + * Retrieves current value. */ public GLib.DateTime get_datetime () { return _value; } /** diff --git a/gxml/XAttribute.vala b/gxml/XAttribute.vala index ebf17e95732768fc9d2bfc9540acf4b723592d06..43905c2f994247843ad36d4d04e23aabb0dee737 100644 --- a/gxml/XAttribute.vala +++ b/gxml/XAttribute.vala @@ -22,7 +22,7 @@ using Gee; /** - * Class implemeting {@link GXml.DomAttr} interface, not tied to libxml-2.0 library. + * Class implementing {@link GXml.DomAttr} interface, not tied to libxml-2.0 library. */ public class GXml.XAttribute : GXml.XNode, GXml.DomAttr { diff --git a/gxml/XComment.vala b/gxml/XComment.vala index ca2bebf761fdff6a2771766cb6915e0d46cab62d..17434884259594c253946726457fe44c8b84dd41 100644 --- a/gxml/XComment.vala +++ b/gxml/XComment.vala @@ -22,7 +22,7 @@ using Gee; /** - * DOM4 Class implemeting {@link GXml.Comment} and {@link GXml.DomComment} interface, powered by libxml2 library. + * DOM4 Class implementing {@link GXml.Comment} and {@link GXml.DomComment} interface, powered by libxml2 library. */ public class GXml.XComment : GXml.XCharacterData, GXml.DomComment { diff --git a/gxml/XDocument.vala b/gxml/XDocument.vala index 644af2e6cdf95ccea2a3c08c2062b6747cded31a..c166956f6c377c3c6d291810c2ef4c06a71d1a9c 100644 --- a/gxml/XDocument.vala +++ b/gxml/XDocument.vala @@ -24,7 +24,7 @@ using Gee; using Xml; /** - * DOM4 class implemeting {@link GXml.DomDocument} and {GXml.DomDocument} interface, + * DOM4 class implementing {@link GXml.DomDocument} and {GXml.DomDocument} interface, * powered by libxml-2.0 library. * * This class use {@link Xml.TextWriter} to write down XML documents using @@ -136,7 +136,7 @@ public class GXml.XDocument : GXml.XNode, try { return write_string (); } catch (GLib.Error e) { - warning (_("Error writting documento to string: %s"), e.message); + warning (_("Error writing document to string: %s"), e.message); return ""; } } diff --git a/gxml/XElement.vala b/gxml/XElement.vala index ff8ee19bfcf99f0d315a8e8b8389cedfe5205dda..a05687b59860931dd5d612f3312fbeb833dc13d1 100644 --- a/gxml/XElement.vala +++ b/gxml/XElement.vala @@ -25,7 +25,7 @@ using Gee; /** - * DOM4 Class implemeting {@link GXml.DomElement} interface, + * DOM4 Class implementing {@link GXml.DomElement} interface, * powered by libxml-2.0 library. */ public class GXml.XElement : GXml.XNonDocumentChildNode, @@ -252,7 +252,7 @@ public class GXml.XElement : GXml.XNonDocumentChildNode, public DomHTMLCollection get_elements_by_tag_name (string local_name) { var l = new HTMLCollection (); - //FIXME: quircks mode not considered + //FIXME: quirks mode not considered foreach (GXml.DomElement n in children) { if (n.node_name == local_name) l.add (n); @@ -262,7 +262,7 @@ public class GXml.XElement : GXml.XNonDocumentChildNode, } public DomHTMLCollection get_elements_by_tag_name_ns (string? namespace, string local_name) { var l = new HTMLCollection (); - //FIXME: quircks mode not considered + //FIXME: quirks mode not considered foreach (GXml.DomElement n in children) { if (n.node_name == local_name && n.namespace_uri == namespace) diff --git a/gxml/XHashMapAttr.vala b/gxml/XHashMapAttr.vala index 22f92d282119f7eacee30ef2c8af53ad8d098396..b08e2243818b80795764b20c9309db973d5edd13 100644 --- a/gxml/XHashMapAttr.vala +++ b/gxml/XHashMapAttr.vala @@ -222,7 +222,7 @@ public class GXml.XHashMapAttr : Gee.AbstractMap, * Search items in this collection and return the object found at * index, but not order is warrantied * - * If index is greather than collection size, then last element found + * If index is greater than collection size, then last element found * is returned. This function falls back to first element found on any * issue. * diff --git a/gxml/XHtmlDocument.vala b/gxml/XHtmlDocument.vala index 183603aa092b7e5c541960b87a026c2ca48cb27b..8d41b3ed4d4f63c14bda40b823a844572d49de26 100644 --- a/gxml/XHtmlDocument.vala +++ b/gxml/XHtmlDocument.vala @@ -27,7 +27,7 @@ using Xml; namespace GXml { /** - * HML parsing suport. Document handling + * HML parsing support. Document handling */ public class XHtmlDocument : XDocument, DomHtmlDocument { public static int default_options { diff --git a/gxml/XNode.vala b/gxml/XNode.vala index 508d7a2c0faa802ef51e06d9289538b3b9439d9c..3551ad0f39cb9fd568f20d7e6048505ea689e1cc 100644 --- a/gxml/XNode.vala +++ b/gxml/XNode.vala @@ -22,7 +22,7 @@ using Gee; /** - * Auxiliary error codes for parsing/writting libxml2 powered classes + * Auxiliary error codes for parsing/writing libxml2 powered classes */ public errordomain GXml.Error { NOT_SUPPORTED, /* TODO: GET RID OF THIS */ @@ -129,7 +129,7 @@ public abstract class GXml.XNode : GLib.Object, case Xml.ElementType.ELEMENT_NODE: return DomNode.NodeType.ELEMENT_NODE; case Xml.ElementType.ATTRIBUTE_NODE: - return DomNode.NodeType.ATTRIBUTE_NODE; // historica + return DomNode.NodeType.ATTRIBUTE_NODE; // historical case Xml.ElementType.TEXT_NODE: return DomNode.NodeType.TEXT_NODE; case Xml.ElementType.CDATA_SECTION_NODE: diff --git a/gxml/XParser.vala b/gxml/XParser.vala index 724c102e335647e5bd386c2363333a5706cd3665..66dbec9dfc23effde72a141d75182c9291bca496 100644 --- a/gxml/XParser.vala +++ b/gxml/XParser.vala @@ -264,7 +264,7 @@ public class GXml.XParser : GLib.Object, GXml.Parser { return true; } /** - * Check if current node has childs. + * Check if current node has children. */ public bool current_is_empty_element () { if (tr == null) return false; diff --git a/gxml/XProcessingInstruction.vala b/gxml/XProcessingInstruction.vala index 5363f8a2c3ff7041458ca25c0568842d64fe4532..3eb83a9b04a71893330800bad21f467bb98b6e97 100644 --- a/gxml/XProcessingInstruction.vala +++ b/gxml/XProcessingInstruction.vala @@ -22,7 +22,7 @@ using Gee; /** - * DOM4 Class implemeting {@link GXml.ProcessingInstruction} and + * DOM4 Class implementing {@link GXml.ProcessingInstruction} and * {@link DomProcessingInstruction} interface, powered by libxml2 library. */ public class GXml.XProcessingInstruction : GXml.XCharacterData, diff --git a/gxml/XText.vala b/gxml/XText.vala index f5eabff4af31424ad3ef05a70c582f445259d16f..8ebb64039da8b67663ca0f1645229226270a4f50 100644 --- a/gxml/XText.vala +++ b/gxml/XText.vala @@ -22,7 +22,7 @@ using Gee; /** - * DOM4 Class implemeting {@link GXml.Text} + * DOM4 Class implementing {@link GXml.Text} * and {@link DomText} interface, powered by libxml2 library. */ public class GXml.XText : GXml.XCharacterData, GXml.DomText diff --git a/gxml/symbols.py b/gxml/symbols.py index a836523fc6bca8b854789269bdd3422e1c21935e..a2bcbf5f9b6982606012b4795f1c2969b68187b7 100755 --- a/gxml/symbols.py +++ b/gxml/symbols.py @@ -21,11 +21,11 @@ import fileinput import re, os # Configuration parameters -# Change this acording with your proyect's function's prefix +# Change this according with your project's function's prefix prefix = 'gxml_' # Change this the output file name filename = "gxml.symbols" -# Add any symbols, prefixs or simple texts you want to skip from parsing +# Add any symbols, prefixes or simple texts you want to skip from parsing blacklist = ("error_quark", "gxml_last_error;", "gxml_warning") # Start parsing diff --git a/test/DocumentTest.vala b/test/DocumentTest.vala index 1e852b2536848056d7a11e6be047c36ecdd5a550..bf4eddd9950fc823ffb5861e22f90b495487adb3 100644 --- a/test/DocumentTest.vala +++ b/test/DocumentTest.vala @@ -154,7 +154,7 @@ class GXml.DocumentTest : GXmlTest { try { var rf = GLib.File.new_for_uri ("https://git.gnome.org/browse/gxml/plain/gxml.doap"); if (!rf.query_exists ()) { - GLib.message ("No remote file available. Skiping..."); + GLib.message ("No remote file available. Skipping..."); return; } var d = new GXml.Document.from_file (rf); @@ -186,7 +186,7 @@ class GXml.DocumentTest : GXmlTest { try { var rf = GLib.File.new_for_uri ("https://git.gnome.org/browse/gxml/plain/gxml.doap"); if (!rf.query_exists ()) { - GLib.message ("No remote file available. Skiping..."); + GLib.message ("No remote file available. Skipping..."); return; } var d = new GXml.Document.from_file (rf); diff --git a/test/feedreader-test.vala b/test/feedreader-test.vala index 65d1408170641535b4874851a74aa30ee294feb2..2897b3f01189ecb77745210861c782239e84e3c7 100644 --- a/test/feedreader-test.vala +++ b/test/feedreader-test.vala @@ -1,5 +1,5 @@ /** - * Copyrigth (C) 2017 Daniel Espinosa + * Copyright (C) 2017 Daniel Espinosa * This is a GPL software * * To compile use: