[gxml/gxml-0-4] Fixed valadoc build



commit c7aa6ce98bec4be0aeabb6b9a20333b0c8111e05
Author: Daniel Espinosa <esodan gmail com>
Date:   Wed Sep 24 00:17:01 2014 -0500

    Fixed valadoc build

 docs/valadoc/Makefile.am |   23 +++------
 gxml/Attr.vala           |    4 +-
 gxml/Document.vala       |    8 ++--
 gxml/Element.vala        |    2 +-
 gxml/Enumeration.vala    |   38 ++++++++--------
 gxml/Node.vala           |    8 ++--
 gxml/Serializable.vala   |  116 ++++++++++++++++++++++-----------------------
 gxml/Serialization.vala  |    8 ++--
 8 files changed, 98 insertions(+), 109 deletions(-)
---
diff --git a/docs/valadoc/Makefile.am b/docs/valadoc/Makefile.am
index 31f767c..9155afe 100644
--- a/docs/valadoc/Makefile.am
+++ b/docs/valadoc/Makefile.am
@@ -57,8 +57,8 @@ $(gxmlgtkdoc_DATA): gxml-gtk-doc
 
 valadoc_flags = \
        --force \
-       --package-name GXml \
-       --package-version $(PACKAGE_VERSION) \
+       --package-name=GXml \
+       --package-version=$(PACKAGE_VERSION) \
        $(NULL)
 
 #      $(top_srcdir)/gxml/internal.vala 
@@ -92,28 +92,19 @@ valadoc_flags_gxml = \
        $(addprefix --pkg=,$(gxml_doc_deps)) \
        --vapidir=$(top_srcdir)/gxml \
        --vapidir=$(top_srcdir)/vapi \
-       --wiki=$(top_srcdir)/docs/wiki \
-       $(gxml_doc_files) \
+       --wiki=$(top_srcdir)/docs/valadoc/wiki \
        $(NULL)
 
 
 #      $(AM_V_GEN)$(VALADOC) 
-gxml-doc: $(gxml_doc_files) $(gxml_wiki_files)
-       $(VALADOC) \
-               -o gxml/ \
-               --doclet=devhelp \
-               $(valadoc_flags_gxml) \
-               $(NULL)
+gxml-doc:
+       $(VALADOC) -o gxml/ --doclet=devhelp $(valadoc_flags_gxml) $(top_srcdir)/gxml/*.vala
 
 # TODO: need to figure out how to not rely on -0.2 in this Makefile.am
 # AM_V_GEN: what does it do?  It appears to prettify output but also obscure errors :D
 #      $(AM_V_GEN)$(VALADOC)
-gxml-gtk-doc: $(gxml_doc_files) $(gxml_wiki_files)
-       $(VALADOC) \
-               -o gtk-doc/gxml \
-               --doclet=gtkdoc \
-               $(valadoc_flags_gxml) \
-               $(NULL)
+gxml-gtk-doc:
+       $(VALADOC) -o gtk-doc/gxml --doclet=gtkdoc $(valadoc_flags_gxml) $(top_srcdir)/gxml/*.vala
 
 .PHONY: $(phony_deps)
 
diff --git a/gxml/Attr.vala b/gxml/Attr.vala
index e1c7e06..b16f3dd 100644
--- a/gxml/Attr.vala
+++ b/gxml/Attr.vala
@@ -235,9 +235,9 @@ namespace GXml {
                 *
                 * For { link GXml.Attr} this method copy name and value.
                 *
-                * @node could be owned by other { link GXml.Document}.
+                * @param node could be owned by other { link GXml.Document}.
                 *
-                * @deep paramenter have no effect.
+                * @param deep paramenter have no effect.
                 */
                public override bool copy (ref Node node, bool deep = false)
                               requires (node is Attr)
diff --git a/gxml/Document.vala b/gxml/Document.vala
index 7a777e1..3fb36e4 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.
                 *
-                * @xml: A string representing an XML document
-                * @url: the base URL to use for the document
-                * @encoding: the document encoding
-                * @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 67b942c..62f3916 100644
--- a/gxml/Element.vala
+++ b/gxml/Element.vala
@@ -465,7 +465,7 @@ namespace GXml {
                 * For { link GXml.Element} this method copy attributes and child nodes
                 * when @deep is set to { link true}.
                 *
-                * @node could be owned by other { link GXml.Document}.
+                * { link [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 b86f957..45933de 100644
--- a/gxml/Enumeration.vala
+++ b/gxml/Enumeration.vala
@@ -30,8 +30,8 @@ namespace GXml {
                 *
                 * Returns: an string representing an enumeration's value.
                 *
-                * @enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
-                * @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.
                 *
-                * @enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
-                * @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 @param enumeration.
                 */
                public static string get_nick_camelcase (Type enumeration, int val) throws GLib.Error
                {
@@ -55,10 +55,10 @@ namespace GXml {
                 *
                 * Returns: an string representing an enumeration's value.
                 *
-                * @enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
-                * @val: an integer to parse an enum value of type @enumeration.
-                * @use_nick: makes to returns value's nick name in { link GLib.EnumClass}
-                * @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, 
@@ -86,12 +86,12 @@ namespace GXml {
                }
                /**
                 * Parse @val to an enumeration's value.
-                *
+                * 
                 * Returns: an { link GLib.EnumValue} representing an enumeration's value.
-                *
-                * @enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
-                * @val: a string to parse an enum value of type @enumeration.
-                * @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.
+                * @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 EnumValue? parse (Type enumeration, string val)
@@ -117,12 +117,12 @@ namespace GXml {
                }
                /**
                 * Transform an enumeration in an array of { link GLib.EnumValue}.
-                *
+                * 
                 * Returns: an array of { link GLib.EnumValue} representing an enumeration.
-                *
-                * @enumeration: a { link GLib.Type} of type { link GLib.Type.ENUM}
-                * @val: a string to parse an enum value of type @enumeration.
-                * @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 @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.
                 */
                public static unowned EnumValue[] to_array (Type enumeration)
@@ -134,7 +134,7 @@ namespace GXml {
                /**
                 * Converts a string to a value in a { link GLib.EnumValue}
                 *
-                * Returns: a value in a { link GLib.EnumValue
+                * Returns: a value in a { link GLib.EnumValue}
                 */
        }
        public errordomain EnumerationError
diff --git a/gxml/Node.vala b/gxml/Node.vala
index a8d9300..61e2b92 100644
--- a/gxml/Node.vala
+++ b/gxml/Node.vala
@@ -28,10 +28,10 @@ namespace GXml {
        /**
         * Represents an XML Node, the base class for most XML structures in
         * the { link GXml.Document}'s tree.
-        *
+        * 
         * { link GXml.Document}s are { link GXml.Node}s, and are
         * composed of a tree of { link GXml.Node}s.
-        *
+        * 
         * Version: DOM Level 1 Core<<BR>>
         * URL: [[http://www.w3.org/TR/DOM-Level-1/level-one-core.html#ID-1950641247]]
         */
@@ -490,8 +490,8 @@ namespace GXml {
                /**
                 * Creates a copy of node's definition to @node.
                 *
-                * @node: a { link GXml.Node} to copy values to.
-                * @deep: { link true} when you want to copy child nodes too.
+                * @param node: a { link GXml.Node} to copy values to.
+                * @param deep: { link 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 e334780..a2d575e 100644
--- a/gxml/Serializable.vala
+++ b/gxml/Serializable.vala
@@ -73,7 +73,7 @@ namespace GXml {
      * { link 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 { link 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.
@@ -99,18 +99,18 @@ namespace GXml {
     public abstract bool property_use_nick ();
     /**
      * Serialize this object.
-     *
-     * @doc an { link GXml.Document} object to serialize to 
-     *
+     * 
      * This method must call serialize_property() recursivally on all properties
      * to serialize.
+     * 
+     * @param doc an { link GXml.Document} object to serialize to.
      */
     public abstract GXml.Node? serialize (GXml.Node node) throws GLib.Error;
 
     /**
      * Serialize a property @prop on a { link GXml.Element}.
-     *
-     * This method is called recursivally by serialize() method over all properties
+     * 
+     * This method is called recursivally by { link serialize} method over all properties
      * to be serialized.
      */
     public abstract GXml.Node? serialize_property (GXml.Element element,
@@ -119,8 +119,8 @@ namespace GXml {
 
     /**
      * Deserialize this object.
-     *
-     * @node { link GXml.Node} used to deserialize from.
+     * 
+     * @param node { link GXml.Node} used to deserialize from.
      */
     public abstract GXml.Node? deserialize (GXml.Node node)
                                       throws GLib.Error;
@@ -151,11 +151,11 @@ namespace GXml {
 
     /**
      * Signal to serialize unknown properties. Any new node must be added to
-     * @element before return the new @node added.
+     * @param element before return the new @param node added.
      * 
-     * @element a { link GXml.Node} to add attribute or child nodes to
-     * @prop a { link GLib.ParamSpec} describing attribute to serialize
-     * @node set to the { link GXml.Node} representing this attribute
+     * @param element a { link GXml.Node} to add attribute or child nodes to
+     * @param prop a { link GLib.ParamSpec} describing attribute to serialize
+     * @param node set to the { link GXml.Node} representing this attribute
      */
     public signal void serialize_unknown_property (GXml.Node element,
                                                    ParamSpec prop,
@@ -163,11 +163,11 @@ namespace GXml {
 
     /**
      * Signal to serialize unknown properties. Any new node must be added to
-     * @element before return the new @node added.
+     * @param element before return the new @node added.
      * 
-     * @element a { link GXml.Node} to add attribute or child nodes to
-     * @prop a { link GLib.ParamSpec} describing attribute to serialize
-     * @node set to the { link GXml.Node} representing this attribute
+     * @param element a { link GXml.Node} to add attribute or child nodes to
+     * @param prop a { link GLib.ParamSpec} describing attribute to serialize
+     * @param node set to the { link GXml.Node} representing this attribute
      */
     public signal void serialize_unknown_property_type (GXml.Node element,
                                                         ParamSpec prop,
@@ -176,8 +176,8 @@ namespace GXml {
     /**
      * Signal to deserialize unknown properties.
      *
-     * @node a { link GXml.Node} to get attribute from
-     * @prop a { link GLib.ParamSpec} describing attribute to deserialize
+     * @param node a { link GXml.Node} to get attribute from
+     * @param prop a { link GLib.ParamSpec} describing attribute to deserialize
      */
     public signal void deserialize_unknown_property (GXml.Node node,
                                                      ParamSpec prop);
@@ -185,39 +185,38 @@ namespace GXml {
     /**
      * Signal to deserialize unknown properties' type.
      *
-     * @node a { link GXml.Node} to get attribute from
-     * @prop a { link GLib.ParamSpec} describing attribute to deserialize
+     * @param node a { link GXml.Node} to get attribute from
+     * @param prop a { link GLib.ParamSpec} describing attribute to deserialize
      */
     public signal void deserialize_unknown_property_type (GXml.Node node,
                                                           ParamSpec prop);
 
     /**
      * Handles finding the { link GLib.ParamSpec} for a given property.
-     *
-     * @param property_name the name of a property to obtain a { link GLib.ParamSpec} for
-     * @return a { link GLib.ParamSpec} describing the named property
-     *
-     * { link GXml.Serialization} uses { link
-     * GLib.ObjectClass.find_property} (as well as { link
-     * GLib.ObjectClass.list_properties}, { link
-     * GLib.Object.get_property}, and { link
-     * GLib.Object.set_property}) to manage serialization
+     * 
+     * { link GXml.Serialization} uses { link GLib.ObjectClass.find_property}
+     * (as well as { link GLib.ObjectClass.list_properties},
+     * { link GLib.Object.get_property}, and
+     * { link GLib.Object.set_property}) to manage serialization
      * of properties.  { link GXml.Serializable} gives the
      * implementing class an opportunity to override
      * { link GLib.ObjectClass.find_property} to control
      * what properties exist for { link GXml.Serialization}'s
      * purposes.
-     *
+     * 
      * 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
      * to return a { link GLib.ParamSpec} for non-installed
      * properties.  Other { link GXml.Serializable} functions
      * should be consistent with it.
-     *
+     * 
      * An implementing class might wish to maintain such
      * { link GLib.ParamSpec} s separately, rather than creating new
      * ones for each call.
+     * 
+     * @param property_name the name of a property to obtain a { link GLib.ParamSpec} for
+     * @return a { link GLib.ParamSpec} describing the named property
      */
     public abstract GLib.ParamSpec? find_property_spec (string property_name);
 
@@ -277,11 +276,8 @@ namespace GXml {
 
     /**
      * List the known properties for an object's class
-     *
-     * @return an array of { link GLib.ParamSpec} of
-     * "properties" for the object.
-     *
-     * { link GXml.Serialization} uses
+     * 
+     * Class { link GXml.Serialization} uses
      * { link GLib.ObjectClass.list_properties} (as well as
      * { link GLib.ObjectClass.find_property},
      * { link GLib.Object.get_property}, and { link GLib.Object.set_property})
@@ -290,7 +286,7 @@ namespace GXml {
      * opportunity to override
      * { link GLib.ObjectClass.list_properties} to control which
      * properties exist for { link GXml.Serialization}'s purposes.
-     *
+     * 
      * For instance, if an object has private data fields
      * that are not installed public properties, but that
      * should be serialized, list_properties can be
@@ -298,10 +294,12 @@ namespace GXml {
      * all the "properties" to serialize.  Other
      * { link GXml.Serializable} functions should be consistent
      * with it.
-     *
+     * 
      * An implementing class might wish to maintain such
      * { link GLib.ParamSpec} s separately, rather than creating new
      * ones for each call.
+     * 
+     * @return an array of { link GLib.ParamSpec} of "properties" for the object.
      */
     public abstract GLib.ParamSpec[] list_serializable_properties ();
     /**
@@ -325,9 +323,7 @@ namespace GXml {
 
     /**
      * Get a string version of the specified property
-     *
-     * @param spec The property we're retrieving as a string
-     *
+     * 
      * { link GXml.Serialization} uses { link GLib.Object.get_property} (as
      * well as { link GLib.ObjectClass.find_property},
      * { link GLib.ObjectClass.list_properties}, and
@@ -336,20 +332,22 @@ namespace GXml {
      * implementing class an opportunity to override
      * { link GLib.Object.get_property} to control what value is
      * returned for a given parameter.
-     *
+     * 
      * 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
      * handle this case as a virtual property, supported
      * by the other { link GXml.Serializable} functions.
-     *
-     * `spec` is usually obtained from list_properties or find_property.
+     * 
+     * @param spec is usually obtained from { link list_properties} or { link find_property}.
+     * 
+     * @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 ().
-     *
+     * 
      */
     public virtual void default_get_property_value (GLib.ParamSpec spec, ref Value val) 
     {
@@ -358,11 +356,8 @@ namespace GXml {
     }
     /**
      * Set a property's value.
-     *
-     * @param spec Specifies the property whose value will be set
-     * @param val The value to set the property to.
-     *
-     * { link GXml.Serialization} uses { link GLib.Object.set_property} (as
+     * 
+     * Class { link GXml.Serialization} uses { link GLib.Object.set_property} (as
      * well as { link GLib.ObjectClass.find_property},
      * { link GLib.ObjectClass.list_properties}, and
      * { link GLib.Object.get_property}) to manage serialization of
@@ -370,13 +365,16 @@ namespace GXml {
      * implementing class an opportunity to override
      * { link GLib.Object.set_property} to control how a property's
      * value is set.
-     *
+     * 
      * 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
      * handle this case as a virtual property, supported
      * by the other { link GXml.Serializable} functions.
+     * 
+     * @param spec Specifies the property whose value will be set
+     * @param val The value to set the property to.
      */
     public abstract void set_property_value (GLib.ParamSpec spec, GLib.Value val);
     /**
@@ -406,8 +404,8 @@ namespace GXml {
      * implementators to provide custome transformations.
      * Call this method before use standard Serializable or implementator ones.
      *
-     * @node a { link GXml.Node} to get attribute from
-     * @prop a { link GLib.ParamSpec} describing attribute to deserialize
+     * @param str a string to get attribute from
+     * @param dest a { link GObject.Value} describing attribute to deserialize
      */
     public abstract bool transform_from_string (string str, ref GLib.Value dest)
                                                 throws GLib.Error;
@@ -509,20 +507,20 @@ namespace GXml {
      * Method to provide custome transformations from
      * a { link GLib.Value} to strings. Could be used on { link deserialize} or simple 
      * transformations to strings.
-     *
+     * 
      * 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.
-     *
-     * @node a { link GXml.Node} to get attribute from
-     * @prop a { link GLib.ParamSpec} describing attribute to deserialize
+     * 
+     * @param node a { link GXml.Node} to get attribute from
+     * @param prop a { link GLib.ParamSpec} describing attribute to deserialize
      */
     public abstract bool transform_to_string (GLib.Value val, ref string str)
                                               throws GLib.Error;
diff --git a/gxml/Serialization.vala b/gxml/Serialization.vala
index 1d35233..a3dd8e0 100644
--- a/gxml/Serialization.vala
+++ b/gxml/Serialization.vala
@@ -342,7 +342,7 @@ namespace GXml {
 
                /**
                 * Deserialize a { link GXml.Document} back into a { link GLib.Object}.
-                *
+                * 
                 * This deserializes a { link GXml.Document} back into a
                 * { link GLib.Object}.  The { link GXml.Document}
                 * must represent a { link GLib.Object} as serialized
@@ -350,9 +350,9 @@ namespace GXml {
                 * objects that are being deserialized must be known
                 * to the system deserializing them or a
                 * { link GXml.SerializationError} will result.
-                *
-                * @type object type to deserialize
-                * @doc a { link GXml.Document} to deseralize from
+                * 
+                * @param type object type to deserialize
+                * @param doc a { link GXml.Document} to deseralize from
                 * @return the deserialized { link GLib.Object}
                 */
                public static GLib.Object deserialize_object (Type type, GXml.Document doc) throws GLib.Error


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]