diff options
| author | Richard Hughes <richard@hughsie.com> | 2014-03-18 11:20:07 +0000 |
|---|---|---|
| committer | Richard Hughes <richard@hughsie.com> | 2014-03-18 11:21:38 +0000 |
| commit | 3bd7010c35ff0cc7458716a3ec17834fed6a6c57 (patch) | |
| tree | 8db1e136c1053c2ee345c78c72553defb9d7d7c3 /libappstream-glib/as-node.h | |
| parent | ac87950adcf2c61c927e51439e1201c32213eb39 (diff) | |
| download | appstream-glib-3bd7010c35ff0cc7458716a3ec17834fed6a6c57.tar.gz | |
Add gtk-doc file headers and flesh out the documentation
Diffstat (limited to 'libappstream-glib/as-node.h')
| -rw-r--r-- | libappstream-glib/as-node.h | 45 |
1 files changed, 37 insertions, 8 deletions
diff --git a/libappstream-glib/as-node.h b/libappstream-glib/as-node.h index 66063af..71b7cf6 100644 --- a/libappstream-glib/as-node.h +++ b/libappstream-glib/as-node.h @@ -32,29 +32,58 @@ G_BEGIN_DECLS +/** + * AsNodeToXmlFlags: + * @AS_NODE_TO_XML_FLAG_NONE: No extra flags to use + * @AS_NODE_TO_XML_FLAG_ADD_HEADER: Add an XML header to the data + * @AS_NODE_TO_XML_FLAG_FORMAT_MULTILINE: Split up children with a newline + * @AS_NODE_TO_XML_FLAG_FORMAT_INDENT: Indent the XML by child depth + * + * The flags for converting to XML. + **/ typedef enum { - AS_NODE_TO_XML_FLAG_NONE = 0, - AS_NODE_TO_XML_FLAG_ADD_HEADER = 1, - AS_NODE_TO_XML_FLAG_FORMAT_MULTILINE = 2, - AS_NODE_TO_XML_FLAG_FORMAT_INDENT = 4, + AS_NODE_TO_XML_FLAG_NONE = 0, /* Since: 0.1.0 */ + AS_NODE_TO_XML_FLAG_ADD_HEADER = 1, /* Since: 0.1.0 */ + AS_NODE_TO_XML_FLAG_FORMAT_MULTILINE = 2, /* Since: 0.1.0 */ + AS_NODE_TO_XML_FLAG_FORMAT_INDENT = 4, /* Since: 0.1.0 */ /*< private >*/ AS_NODE_TO_XML_FLAG_LAST } AsNodeToXmlFlags; +/** + * AsNodeFromXmlFlags: + * @AS_NODE_FROM_XML_FLAG_NONE: No extra flags to use + * + * The flags for converting from XML. + **/ typedef enum { - AS_NODE_FROM_XML_FLAG_NONE = 0, + AS_NODE_FROM_XML_FLAG_NONE = 0, /* Since: 0.1.0 */ /*< private >*/ AS_NODE_FROM_XML_FLAG_LAST } AsNodeFromXmlFlags; +/** + * AsNodeInsertFlags: + * @AS_NODE_INSERT_FLAG_NONE: No extra flags to use + * @AS_NODE_INSERT_FLAG_PRE_ESCAPED: The data is already XML escaped + * @AS_NODE_INSERT_FLAG_SWAPPED: The name and key should be swapped + * + * The flags to use when inserting a node. + **/ typedef enum { - AS_NODE_INSERT_FLAG_NONE = 0, /* 'bar & baz > foo' */ - AS_NODE_INSERT_FLAG_PRE_ESCAPED = 1, /* 'bar & baz < foo' */ - AS_NODE_INSERT_FLAG_SWAPPED = 2, + AS_NODE_INSERT_FLAG_NONE = 0, /* Since: 0.1.0 */ + AS_NODE_INSERT_FLAG_PRE_ESCAPED = 1, /* Since: 0.1.0 */ + AS_NODE_INSERT_FLAG_SWAPPED = 2, /* Since: 0.1.0 */ /*< private >*/ AS_NODE_INSERT_FLAG_LAST } AsNodeInsertFlags; +/** + * AsNodeError: + * @AS_NODE_ERROR_FAILED: Generic failure + * + * The error type. + **/ typedef enum { AS_NODE_ERROR_FAILED, /*< private >*/ |