diff --git a/docs/valadoc/Makefile.am b/docs/valadoc/Makefile.am index 9155afedc00aa5e304d9f36aed5536e7ddd4bce3..c4f1aceaec6860ec5626d3d13e17aeb3a88ee341 100644 --- a/docs/valadoc/Makefile.am +++ b/docs/valadoc/Makefile.am @@ -88,7 +88,7 @@ gxml_doc_deps = \ valadoc_flags_gxml = \ $(valadoc_flags) \ - -X $(top_srcdir)/gxml/gxml.h \ + -X $(top_builddir)/gxml/gxml.h \ $(addprefix --pkg=,$(gxml_doc_deps)) \ --vapidir=$(top_srcdir)/gxml \ --vapidir=$(top_srcdir)/vapi \ diff --git a/gxml/Document.vala b/gxml/Document.vala index 3fb36e4da5b6fee71fff85f15a36c331e3737ba3..3832b246db9e1492e879551ef891d18487710ee4 100644 --- a/gxml/Document.vala +++ b/gxml/Document.vala @@ -497,10 +497,10 @@ namespace GXml { /** * Creates a Document 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.Document} from `memory`; this must be freed with {@link GLib.Object.unref} */ diff --git a/gxml/Element.vala b/gxml/Element.vala index 62f3916e0e40739d44a9291ac0783a4d27c44b49..0cb894bde03cf600583ede568a3ad8773190bb01 100644 --- a/gxml/Element.vala +++ b/gxml/Element.vala @@ -1,4 +1,4 @@ -/* -*- Mode: vala; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */ +/* -*- Mode: vala; indent-tabs-mode: t; c-basic-offset: 2; tab-width: 2 -*- */ /* Element.vala * * Copyright (C) 2011-2013 Richard Schwarting @@ -463,9 +463,9 @@ namespace GXml { * {@inheritDoc} * * For {@link GXml.Element} this method copy attributes and child nodes - * when @deep is set to {@link true}. + * when @deep is set to true. * - * {@link [node]} could be owned by other {@link GXml.Document}. + * @param node could be owned by other {@link GXml.Document}. */ public override bool copy (ref Node node, bool deep = false) requires (node is Element) diff --git a/gxml/Enumeration.vala b/gxml/Enumeration.vala index 45933de0514c9519dbd148800e38d4a0f5ea785f..1399b498a1d45fc3fad1e6a75c93cff25b79ff25 100644 --- a/gxml/Enumeration.vala +++ b/gxml/Enumeration.vala @@ -30,8 +30,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 { @@ -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 @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 { @@ -55,10 +55,9 @@ 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 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, @@ -89,10 +88,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} - * as camel case representation. If @use_nick is set this take no effect. + * @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. */ public static EnumValue? parse (Type enumeration, string val) throws GLib.Error @@ -120,10 +117,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 val: a string to parse an enum value of type @enumeration. - * @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. + * @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)) diff --git a/gxml/Node.vala b/gxml/Node.vala index 61e2b920d4c497f34a39cb85e081c12ca548f2f0..54aaa4b304cbc260b72537478e9feb9874f230ae 100644 --- a/gxml/Node.vala +++ b/gxml/Node.vala @@ -1,4 +1,4 @@ -/* -*- Mode: vala; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */ +/* -*- Mode: vala; indent-tabs-mode: t; c-basic-offset: 2; tab-width: 2 -*- */ /* Node.vala * * Copyright (C) 2011-2013 Richard Schwarting @@ -490,8 +490,8 @@ namespace GXml { /** * Creates a copy of node's definition to @node. * - * @param node: a {@link GXml.Node} to copy values to. - * @param deep: {@link true} when you want to copy child nodes too. + * @param node a {@link GXml.Node} to copy values to. + * @param deep true when you want to copy child nodes too. */ public virtual bool copy (ref Node node, bool deep = false) { return false; diff --git a/gxml/Serializable.vala b/gxml/Serializable.vala index a2d575ef0b8c6c842f2c9361ac3629bf3340a939..0b68fc664191cc96614ebf34bc8572c1ac76f985 100644 --- a/gxml/Serializable.vala +++ b/gxml/Serializable.vala @@ -33,7 +33,7 @@ namespace GXml { * Store all properties to be ignored on serialization. * * Use property's cannonical name as key and its {@link GLib.ParamSpec}. To - * get the last one use {@link GLib.get_class} and use, again, property's + * get the last one use {@link GLib.Object.get_class} and use, again, property's * cannonical name to find it. * * Long named properties like this 'ignored_serializable_properties' are stored @@ -44,11 +44,11 @@ namespace GXml { * * Implementors: By default {@link list_serializable_properties} initialize * this property to store all public properties, except this one. Make shure to - * call {@link init_properties()} before add new propeties. + * call {@link init_properties} before add new propeties. */ public abstract HashTable ignored_serializable_properties { get; protected set; } /** - * Return {@link false} if you want to ignore unknown properties and {@link GXml.Node}'s + * Return false if you want to ignore unknown properties and {@link GXml.Node}'s * not in your class definition. * * Take care, disabling this feature you can lost data on serialization, because any unknown @@ -70,10 +70,10 @@ namespace GXml { * * By default no contents is serialized/deseralized. Implementors must implement * {@link Serializable.serialize_use_xml_node_value} function returning - * {@link true} in order to use this property. + * 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. @@ -83,7 +83,7 @@ namespace GXml { * Used to check {@link GXml.Element}'s contents must be deseralized. * * By default no contents is serialized/deseralized. Implementors must implement - * this function returning {@link true} in order to use {@link serialized_xml_node_value} + * this function returning true in order to use {@link serialized_xml_node_value} * property's value in serialization to set {@link GXml.Element}'s contents. * */ @@ -103,7 +103,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; @@ -141,8 +141,6 @@ namespace GXml { * Use Serializable.get_property_value in order to allow derived classes to * override the properties to serialize. * - * @param property_name the name of the property as a string - * @param spec the {@link GLib.ParamSpec} describing the property. * @param property_node the {@link GXml.Node} encapsulating data to deserialize * @return `true` if the property was handled, `false` if {@link GXml.Serialization} should handle it. */ @@ -336,17 +334,17 @@ namespace GXml { * For instance, if an object has private data fields * that are not installed public properties, but that * should be serialized, - * {@link GXml.Serializable.get_property} can be used to + * {@link GXml.Serializable.list_serializable_properties} can be used to * 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 find_property_spec}. * * @param spec The property we're retrieving as a string */ public abstract void get_property_value (GLib.ParamSpec spec, ref Value val); /** - * Default implementation for get_property_value (). + * Default implementation for {@link get_property_value}. * */ public virtual void default_get_property_value (GLib.ParamSpec spec, ref Value val) @@ -369,7 +367,7 @@ namespace GXml { * For instance, if an object has private data fields * that are not installed public properties, but that * should be serialized, - * {@link GXml.Serializable.set_property} can be used to + * {@link set_property_value} can be used to * handle this case as a virtual property, supported * by the other {@link GXml.Serializable} functions. * @@ -390,13 +388,13 @@ namespace GXml { /** * Method to provide custome transformations from strings to - * a {@link GLib.Value}. Could be used on {@link serialize} or simple + * a {@link GLib.Value}. Could be used on {@link Serializable} or simple * transformations from string. * * Some specialized classes, like derived from {@link Serializable} class * implementator, can provide custome transformations. * - * Returns: {@link true} if transformation was handled, {@link false} otherwise. + * Returns: true if transformation was handled, false otherwise. * * Implementors: * To be overrided by derived classes of implementators to provide custome @@ -405,7 +403,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; @@ -511,7 +509,7 @@ 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. + * Returns: true if transformation was handled, false otherwise. * * Implementors: * To be overrided by derived classes of implementators to provide custome @@ -519,8 +517,8 @@ namespace GXml { * implementators to provide custome transformations. * Call this method before use standard Serializable or implementator ones. * - * @param node a {@link GXml.Node} to get attribute from - * @param prop a {@link GLib.ParamSpec} describing attribute to deserialize + * @param val a {@link GLib.Value} to get attribute from + * @param str a string describing attribute to deserialize */ public abstract bool transform_to_string (GLib.Value val, ref string str) throws GLib.Error;