1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<refentry id="AsValidator">
<refmeta>
<refentrytitle role="top_of_page" id="AsValidator.top_of_page">AsValidator</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
APPSTREAM Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>AsValidator</refname>
<refpurpose>Validator and report-generator about AppStream XML metadata</refpurpose>
</refnamediv>
<refsect1 id="AsValidator.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="AsValidator"><returnvalue>AsValidator</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-validator-new">as_validator_new</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-clear-issues">as_validator_clear_issues</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-validate-file">as_validator_validate_file</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="as-validator-validate-data">as_validator_validate_data</link> <phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GList"><returnvalue>GList</returnvalue></link> *
</entry><entry role="function_name"><link linkend="as-validator-get-issues">as_validator_get_issues</link> <phrase role="c_punctuation">()</phrase></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="AsValidator.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen> <link linkend="GObject">GObject</link>
<phrase role="lineart">╰──</phrase> AsValidator
</screen>
</refsect1>
<refsect1 id="AsValidator.includes"><title>Includes</title><synopsis>#include <appstream.h>
</synopsis></refsect1>
<refsect1 id="AsValidator.description" role="desc">
<title role="desc.title">Description</title>
<para>This object is able to validate AppStream XML metadata (distro and upstream)
and to generate a report about issues found with it.</para>
<para>See also: <link linkend="AsMetadata"><type>AsMetadata</type></link></para>
</refsect1>
<refsect1 id="AsValidator.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="as-validator-new" role="function">
<title>as_validator_new ()</title>
<indexterm zone="as-validator-new"><primary>as_validator_new</primary></indexterm>
<programlisting language="C"><link linkend="AsValidator"><returnvalue>AsValidator</returnvalue></link> *
as_validator_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Creates a new <link linkend="AsValidator"><type>AsValidator</type></link>.</para>
<refsect3 role="returns">
<title>Returns</title>
<para> an <link linkend="AsValidator"><type>AsValidator</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer full</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="as-validator-clear-issues" role="function">
<title>as_validator_clear_issues ()</title>
<indexterm zone="as-validator-clear-issues"><primary>as_validator_clear_issues</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
as_validator_clear_issues (<parameter><link linkend="AsValidator"><type>AsValidator</type></link> *validator</parameter>);</programlisting>
<para>Clears the list of issues</para>
</refsect2>
<refsect2 id="as-validator-validate-file" role="function">
<title>as_validator_validate_file ()</title>
<indexterm zone="as-validator-validate-file"><primary>as_validator_validate_file</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
as_validator_validate_file (<parameter><link linkend="AsValidator"><type>AsValidator</type></link> *validator</parameter>,
<parameter><link linkend="GFile"><type>GFile</type></link> *metadata_file</parameter>);</programlisting>
<para>Validate an AppStream XML file</para>
<refsect3 role="returns">
<title>Returns</title>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-validator-validate-data" role="function">
<title>as_validator_validate_data ()</title>
<indexterm zone="as-validator-validate-data"><primary>as_validator_validate_data</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
as_validator_validate_data (<parameter><link linkend="AsValidator"><type>AsValidator</type></link> *validator</parameter>,
<parameter>const <link linkend="gchar"><type>gchar</type></link> *metadata</parameter>);</programlisting>
<para>Validate AppStream XML data</para>
<refsect3 role="returns">
<title>Returns</title>
<para></para>
</refsect3></refsect2>
<refsect2 id="as-validator-get-issues" role="function">
<title>as_validator_get_issues ()</title>
<indexterm zone="as-validator-get-issues"><primary>as_validator_get_issues</primary></indexterm>
<programlisting language="C"><link linkend="GList"><returnvalue>GList</returnvalue></link> *
as_validator_get_issues (<parameter><link linkend="AsValidator"><type>AsValidator</type></link> *validator</parameter>);</programlisting>
<para>Get a list of found metadata format issues.</para>
<refsect3 role="returns">
<title>Returns</title>
<para> a list of <link linkend="AsValidatorIssue"><type>AsValidatorIssue</type></link> instances, free with <link linkend="g-list-free"><function>g_list_free()</function></link>. </para>
<para><emphasis role="annotation">[<acronym>element-type</acronym> AsValidatorIssue][<acronym>transfer container</acronym>]</emphasis></para>
</refsect3></refsect2>
</refsect1>
<refsect1 id="AsValidator.other_details" role="details">
<title role="details.title">Types and Values</title>
</refsect1>
</refentry>
|
