File: AsValidator.html

package info (click to toggle)
appstream 0.7.3-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,660 kB
  • ctags: 2,618
  • sloc: xml: 10,142; ansic: 8,362; cpp: 1,905; python: 236; sh: 58; makefile: 13
file content (168 lines) | stat: -rw-r--r-- 8,889 bytes parent folder | download | duplicates (2) 
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AppStream Library Reference Manual: AsValidator</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="AppStream Library Reference Manual">
<link rel="up" href="ch01.html" title="AppStream API Reference">
<link rel="prev" href="appstream-as-provides.html" title="as-provides">
<link rel="next" href="AsValidatorIssue.html" title="AsValidatorIssue">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#AsValidator.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#AsValidator.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="appstream-as-provides.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AsValidatorIssue.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AsValidator"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AsValidator.top_of_page"></a>AsValidator</span></h2>
<p>AsValidator — Validator and report-generator about AppStream XML metadata</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AsValidator.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="AsValidator.html" title="AsValidator"><span class="returnvalue">AsValidator</span></a> *
</td>
<td class="function_name">
<a class="link" href="AsValidator.html#as-validator-new" title="as_validator_new ()">as_validator_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="AsValidator.html#as-validator-clear-issues" title="as_validator_clear_issues ()">as_validator_clear_issues</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AsValidator.html#as-validator-validate-file" title="as_validator_validate_file ()">as_validator_validate_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="AsValidator.html#as-validator-validate-data" title="as_validator_validate_data ()">as_validator_validate_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="AsValidator.html#as-validator-get-issues" title="as_validator_get_issues ()">as_validator_get_issues</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AsValidator.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> AsValidator
</pre>
</div>
<div class="refsect1">
<a name="AsValidator.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;appstream.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="AsValidator.description"></a><h2>Description</h2>
<p>This object is able to validate AppStream XML metadata (distro and upstream)
and to generate a report about issues found with it.</p>
<p>See also: <a class="link" href="AsMetadata.html" title="AsMetadata"><span class="type">AsMetadata</span></a></p>
</div>
<div class="refsect1">
<a name="AsValidator.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="as-validator-new"></a><h3>as_validator_new ()</h3>
<pre class="programlisting"><a class="link" href="AsValidator.html" title="AsValidator"><span class="returnvalue">AsValidator</span></a> *
as_validator_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="AsValidator.html" title="AsValidator"><span class="type">AsValidator</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.15.7.2.5"></a><h4>Returns</h4>
<p> an <a class="link" href="AsValidator.html" title="AsValidator"><span class="type">AsValidator</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-clear-issues"></a><h3>as_validator_clear_issues ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
as_validator_clear_issues (<em class="parameter"><code><a class="link" href="AsValidator.html" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>);</pre>
<p>Clears the list of issues</p>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-validate-file"></a><h3>as_validator_validate_file ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_validator_validate_file (<em class="parameter"><code><a class="link" href="AsValidator.html" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>,
                            <em class="parameter"><code><a href="../gio/GFile.html"><span class="type">GFile</span></a> *metadata_file</code></em>);</pre>
<p>Validate an AppStream XML file</p>
<div class="refsect3">
<a name="id-1.2.15.7.4.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-validate-data"></a><h3>as_validator_validate_data ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
as_validator_validate_data (<em class="parameter"><code><a class="link" href="AsValidator.html" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>,
                            <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *metadata</code></em>);</pre>
<p>Validate AppStream XML data</p>
<div class="refsect3">
<a name="id-1.2.15.7.5.5"></a><h4>Returns</h4>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="as-validator-get-issues"></a><h3>as_validator_get_issues ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
as_validator_get_issues (<em class="parameter"><code><a class="link" href="AsValidator.html" title="AsValidator"><span class="type">AsValidator</span></a> *validator</code></em>);</pre>
<p>Get a list of found metadata format issues.</p>
<div class="refsect3">
<a name="id-1.2.15.7.6.5"></a><h4>Returns</h4>
<p> a list of <a class="link" href="AsValidatorIssue.html" title="AsValidatorIssue"><span class="type">AsValidatorIssue</span></a> instances, free with <a href="../glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> AsValidatorIssue][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AsValidator.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>