[gxml] Fixed documentation installation
- From: Daniel Espinosa Ortiz <despinosa src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gxml] Fixed documentation installation
- Date: Mon, 4 May 2015 19:00:53 +0000 (UTC)
commit 23b0f8b9e3de1c4fd6caca866ea99c7483834c5f
Author: Daniel Espinosa <esodan gmail com>
Date: Mon May 4 11:44:34 2015 -0500
Fixed documentation installation
* Removed unnecesary code in docs/valadoc/Makefile.am
docs/valadoc/Makefile.am | 109 --------------------------------------
docs/valadoc/gtk-doc/Makefile.am | 9 ++-
gxml/Attribute.vala | 2 +-
gxml/Document.vala | 4 +-
gxml/Element.vala | 10 ++--
gxml/Namespace.vala | 6 +-
gxml/Node.vala | 12 ++--
gxml/Serializable.vala | 74 +++++++++++++-------------
gxml/libxml-Comment.vala | 11 +++-
9 files changed, 68 insertions(+), 169 deletions(-)
---
diff --git a/docs/valadoc/Makefile.am b/docs/valadoc/Makefile.am
index 0fe83c6..cdb1e9e 100644
--- a/docs/valadoc/Makefile.am
+++ b/docs/valadoc/Makefile.am
@@ -1,114 +1,5 @@
SUBDIRS=
-# inspired by folks' documentation Makefile.am
-
-# distclean_dirs?
-# phony_deps?
-distclean_dirs = \
- gxml \
- gtk-doc \
- $(NULL)
-
-phony_deps = \
- gxml-doc \
- gxml-gtk-doc \
- $(NULL)
-
-gxml_wiki_pages = \
- concepts \
- glossary \
- debugging \
- $(NULL)
-
-
-# Huh, gxml_wiki_files isn't defined for a while down below
-EXTRA_DIST = $(gxml_wiki_files)
-
-
-
-# ---------------------------------------------------------
-
-gxmldocdir=$(datadir)/devhelp/references/gxml
-gxmlimgdir=$(datadir)/devhelp/references/gxml/img
-
-gxmlgtkdocdir=$(datadir)/gtk-doc/html/gxml
-
-common_doc_files = \
- *.css \
- *.png \
- *.js \
- index.htm \
- *.html \
- $(NULL)
-
-gxmldoc_DATA = \
- gxml/GXml/GXml.devhelp2 \
- $(addprefix gxml/GXml/,$(common_doc_files)) \
- $(NULL)
-
-gxmlgtkdoc_DATA = gtk-doc/gxml/html/*
-
-# gxmlimg_DATA = gxml/gxml/img/*.png
-
-# $(gxmldoc_DATA) ($gxmlimg_DATA): gxml-doc
-$(gxmldoc_DATA): gxml-doc
-$(gxmlgtkdoc_DATA): gxml-gtk-doc
-
-
-# -------------------------------------------------------
-
-valadoc_flags = \
- --force \
- --package-name=GXml \
- --package-version=$(PACKAGE_VERSION) \
- $(NULL)
-
-# $(top_srcdir)/gxml/internal.vala
-gxml_doc_files_blacklist = \
- $(NULL)
-
-# this expands the list of files, so we can filter out elements
-gxml_doc_files_all = \
- $(wildcard $(top_srcdir)/gxml/*.vala) \
- $(NULL)
-
-gxml_wiki_files = \
- $(addprefix wiki/,$(addsuffix .valadoc,$(gxml_wiki_pages))) \
- $(NULL)
-
-# TODO: Fix this. Sorting done to "work around the native doclet portino of bgo#662784" - folks
-gxml_doc_files = \
- $(sort \
- $(filter-out $(gxml_doc_files_blacklist),$(gxml_doc_files_all)))
-
-# todo: find out what dependencies I want/need to set
-gxml_doc_deps = \
- xlibxml-1.0 \
- gio-2.0 \
- gee-0.8 \
- libxml-2.0 \
- $(NULL)
-
-valadoc_flags_gxml = \
- $(valadoc_flags) \
- -X $(top_srcdir)/gxml/gxml.h \
- $(addprefix --pkg=,$(gxml_doc_deps)) \
- --vapidir=$(top_srcdir)/gxml \
- --vapidir=$(top_srcdir)/vapi \
- --wiki=$(top_srcdir)/docs/valadoc/wiki \
- $(NULL)
-
-
-# $(AM_V_GEN)$(VALADOC)
-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:
- $(VALADOC) -o gtk-doc/gxml --doclet=gtkdoc $(valadoc_flags_gxml) $(top_srcdir)/gxml/*.vala
-
if ENABLE_DEVHELP_DOCS
SUBDIRS+=devhelp
endif
diff --git a/docs/valadoc/gtk-doc/Makefile.am b/docs/valadoc/gtk-doc/Makefile.am
index 5ef06d5..426d030 100644
--- a/docs/valadoc/gtk-doc/Makefile.am
+++ b/docs/valadoc/gtk-doc/Makefile.am
@@ -20,9 +20,12 @@ sources= \
gxmlgtkdocdir=$(datadir)/gtk-doc/html/gxml
gxmlgtkdoc_DATA= \
gtk-doc/gxml/*.txt \
- gtk-doc/gxml/html/*.bak \
- gtk-doc/gxml/html/*.types \
- gtk-doc/gxml/html/sgml.stamp
+ gtk-doc/gxml/*.xml \
+ gtk-doc/gxml/xml/*.xml \
+ gtk-doc/gxml/xml/*.top \
+ gtk-doc/gxml/xml/*.bottom \
+ gtk-doc/gxml/*.types \
+ gtk-doc/gxml/sgml.stamp
$(gxmlgtkdoc_DATA): gxml-gtk-doc
diff --git a/gxml/Attribute.vala b/gxml/Attribute.vala
index 1bf1d9a..3bea24e 100644
--- a/gxml/Attribute.vala
+++ b/gxml/Attribute.vala
@@ -26,7 +26,7 @@ using Gee;
*
* Its features relays on { link GXml.Node} interface inplementation to access
* { link GXml.Element} properties.
- *
+ *
* Attribute's name could be get from { link GXml.Node.name} property. Its value
* should be get from { link GXml.Node.value} property.
*/
diff --git a/gxml/Document.vala b/gxml/Document.vala
index 2de0f46..ab75099 100644
--- a/gxml/Document.vala
+++ b/gxml/Document.vala
@@ -38,14 +38,14 @@ public interface GXml.Document : Object, GXml.Node
public abstract GLib.File file { get; set; }
/**
* This method should create a new { link GXml.Element}.
- *
+ *
* Is a matter of you to add as a child to any other
* { link GXml.Node}.
*/
public abstract GXml.Node create_element (string name);
/**
* Creates a new { link GXml.Text}.
- *
+ *
* Is a matter of you to add as a child to any other
* { link GXml.Node}, like a { link GXml.Element} node.
*/
diff --git a/gxml/Element.vala b/gxml/Element.vala
index 45a3e04..20c71c2 100644
--- a/gxml/Element.vala
+++ b/gxml/Element.vala
@@ -23,7 +23,7 @@
using Gee;
/**
* Interface to access XML document's tags, properties and content.
- *
+ *
* Provides methods to create new XML tags properties and its values, and
* access to tag's contents.
*/
@@ -31,18 +31,18 @@ public interface GXml.Element : Object, GXml.Node
{
/**
* This merges all adjacent { link GXml.Text} nodes that are
- * descendants of this { link GXml.Element}.
- */
+ * descendants of this { link GXml.Element}.
+ */
public abstract void normalize ();
/**
* Add a new { link GXml.Attribute} to this { link GXml.Element}.
- *
+ *
* You should provide a name and a value.
*/
public abstract void set_attr (string name, string value);
/**
* Search for a { link GXml.Attribute} with given name.
- *
+ *
* All attributes could be get using { link GXml.Node.attrs} property.
*/
public abstract GXml.Node get_attr (string name);
diff --git a/gxml/Namespace.vala b/gxml/Namespace.vala
index 8caa3f1..7725e0e 100644
--- a/gxml/Namespace.vala
+++ b/gxml/Namespace.vala
@@ -24,10 +24,10 @@ using Gee;
/**
* Interface to handle XML Namespaces.
- *
+ *
* Basic information for a XML document's namespaces and applied to a given
* { link GXml.Node}.
- *
+ *
* Namespace management is a matter of this or other libraries, implementing
* this interfaces.
*/
@@ -39,7 +39,7 @@ public interface GXml.Namespace : Object
public abstract string uri { get; }
/**
* Read-only property to get namespace's prefix.
- *
+ *
* Prefix should be added to { link GXml.Element} or { link GXml.Attribute}
* name in order to apply a given namespace, unless it is the default.
*/
diff --git a/gxml/Node.vala b/gxml/Node.vala
index 9ed99b9..50c532c 100644
--- a/gxml/Node.vala
+++ b/gxml/Node.vala
@@ -33,7 +33,7 @@ public interface GXml.Node : Object
public abstract Gee.List<GXml.Namespace> namespaces { get; }
/**
* Collection of { link GXml.Node} as childs.
- *
+ *
* Depend on { link GXml.Node} type, this childs could of different, like,
* elements, element's contents or properties.
*/
@@ -64,31 +64,31 @@ public interface GXml.Node : Object
public abstract string to_string ();
/**
* Set a namespace to this node.
- *
+ *
* Search for existing document's namespaces and applies it if found or creates
* a new one, appending to document's namespaces collection.
*/
public abstract bool set_namespace (string uri, string prefix);
/**
* Node's defaults namespace's prefix.
- *
+ *
* This allways returns first { link GXml.Namespace}'s prefix in { link GXml.Node}'s
* namespaces collection.
*/
public virtual string ns_prefix () { return namespaces.first ().prefix; }
/**
* Node's defaults namespace's URI.
- *
+ *
* This allways returns first { link GXml.Namespace}'s URI in { link GXml.Node}'s
* namespaces collection.
*/
public virtual string ns_urf () { return namespaces.first ().uri; }
/**
* Copy a { link GXml.Node} relaing on { link GXml.Document} to other { link GXml.Node}.
- *
+ *
* node could belongs from different { link GXml.Document}, while source is a node
* belonging to given document.
- *
+ *
* Just { link GXml.Element} objects are supported. For attributes, use
* { link GXml.Element.set_attr} method, passing source's name and value as arguments.
*/
diff --git a/gxml/Serializable.vala b/gxml/Serializable.vala
index 1a38452..e303906 100644
--- a/gxml/Serializable.vala
+++ b/gxml/Serializable.vala
@@ -23,7 +23,7 @@
namespace GXml {
/**
* GXml { link GLib.Object} serialization framework main interface to XML files.
- *
+ *
* Implementors of this interface, could define or override the way you want to
* represent your class in a XML file.
*/
@@ -61,12 +61,12 @@ namespace GXml {
/**
* On deserialization stores any { link GXml.Node} not used on this
* object, but exists in current XML file.
- *
+ *
* Node's name is used as key to find stored { link GXml.Node}.
- *
+ *
* XML allows great flexibility, providing different ways to represent the same
* information. This is a problem when you try to deserialize them.
- *
+ *
* In order to deserialize correctly, you must create your XML, both by
* serializing a { link Serializable} object or by hand writing. By using the
* former, you can add extra information, like nodes or properties, but most of
@@ -76,7 +76,7 @@ namespace GXml {
* 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.
- *
+ *
* This property is ignored on serialisation.
*/
public abstract HashTable<string,GXml.Node> unknown_serializable_property { get; protected set; }
@@ -114,12 +114,12 @@ namespace GXml {
//public abstract Namespace @namespace { get; set; default = null; }
/**
* Used to check { link GXml.Element}'s contents must be deseralized.
- *
+ *
* By default GXml's implementations doesn't deseriaze/serialize XML node contents.
* In order to enable it, you must override { link serialize_use_xml_node_value}
* method to return true and store XML node's content to { link 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
@@ -135,7 +135,7 @@ namespace GXml {
/**
* Defines the way to set Node's property name, by using
* it's nick instead of default name.
- *
+ *
* 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 names like
* "your_property", but more common is to use "YourProperty". In order
@@ -147,17 +147,17 @@ namespace GXml {
public abstract bool property_use_nick ();
/**
* Serialize this object.
- *
+ *
* 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 { link serialize} method over all properties
* to be serialized.
*/
@@ -167,7 +167,7 @@ namespace GXml {
/**
* Deserialize this object.
- *
+ *
* @param node { link GXml.Node} used to deserialize from.
*/
public abstract GXml.Node? deserialize (GXml.Node node)
@@ -198,7 +198,7 @@ namespace GXml {
/**
* Signal to serialize unknown properties. Any new node must be added to
* @param element before return the new @param node added.
- *
+ *
* @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
@@ -239,7 +239,7 @@ namespace GXml {
/**
* Handles finding the { link GLib.ParamSpec} for a given property.
- *
+ *
* { link GXml.Serialization} uses { link GLib.ObjectClass.find_property}
* (as well as { link GLib.ObjectClass.list_properties},
* { link GLib.Object.get_property}, and
@@ -249,25 +249,25 @@ namespace GXml {
* { 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);
/**
- * Default implementation for find_property_spec ().
+ * Default implementation for { link Serializable.find_property_spec}
*
*/
public virtual GLib.ParamSpec? default_find_property_spec (string property_name) {
@@ -301,7 +301,7 @@ namespace GXml {
public abstract void init_properties ();
/**
- * Default implementation for init_properties ().
+ * Default implementation for { link Serializable.init_properties}
*
*/
public virtual void default_init_properties ()
@@ -324,7 +324,7 @@ namespace GXml {
/**
* List the known properties for an object's class
- *
+ *
* Class { link GXml.Serialization} uses
* { link GLib.ObjectClass.list_properties} (as well as
* { link GLib.ObjectClass.find_property},
@@ -334,7 +334,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
@@ -342,16 +342,16 @@ 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 ();
/**
- * Default implementation for list_serializable_properties ().
+ * Default implementation for { link Serializable.list_serializable_properties}
*
*/
public virtual GLib.ParamSpec[] default_list_serializable_properties ()
@@ -371,7 +371,7 @@ namespace GXml {
/**
* Get a string version of the specified property
- *
+ *
* { link GXml.Serialization} uses { link GLib.Object.get_property} (as
* well as { link GLib.ObjectClass.find_property},
* { link GLib.ObjectClass.list_properties}, and
@@ -380,22 +380,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.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 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)
{
@@ -404,7 +404,7 @@ namespace GXml {
}
/**
* Set a property's value.
- *
+ *
* Class { link GXml.Serialization} uses { link GLib.Object.set_property} (as
* well as { link GLib.ObjectClass.find_property},
* { link GLib.ObjectClass.list_properties}, and
@@ -413,14 +413,14 @@ 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 set_property_value} 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.
*/
@@ -564,18 +564,18 @@ 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.
- *
+ *
* @param val: a { link GLib.Value} to get attribute from
* @param str: a string describing attribute to deserialize
*/
@@ -604,7 +604,7 @@ namespace GXml {
}
/**
- * Errors from { link Serialization}.
+ * Errors from { link Serializable}.
*/
public errordomain SerializableError {
/**
diff --git a/gxml/libxml-Comment.vala b/gxml/libxml-Comment.vala
index aeab40a..6a9eb8e 100644
--- a/gxml/libxml-Comment.vala
+++ b/gxml/libxml-Comment.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 -*- */
/* Comment.vala
*
* Copyright (C) 2011-2013 Richard Schwarting <aquarichy gmail com>
@@ -30,10 +30,15 @@
*
* To create one, use { link GXml.xDocument.create_comment}.
*
- * An XML example looks like: {{{ <someNode>
+ * An XML example looks like:
+ *
+ * {{{
+ * <someNode>
* <!-- this is a comment -->
* text in the node
- * </someNode> }}}
+ * </someNode>
+ * }}}
+ *
* For more, see: [[http://www.w3.org/TR/DOM-Level-1/level-one-core.html#ID-1728279322]]
*/
public class GXml.Comment : GXml.CharacterData {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
