← Back to branch summary

~ubuntu-branches/ubuntu/raring/rygel/raring

« back to all changes in this revision

Viewing changes to doc/reference/librygel-core/gtkdoc/xml/rygel-description-file.xml

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2012-09-26 22:34:15 UTC
  • mfrom: (1.3.2)
  • mto: (14.1.10 sid)
  • mto: This revision was merged to the branch mainline in revision 27.
  • Revision ID: package-import@ubuntu.com-20120926223415-mem27auv86jjrj9k
Imported Upstream version 0.16.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/librygel-core/gtkdoc/xml/rygel-description-file.xml
42
42
<link linkend="DescriptionFile"><returnvalue>DescriptionFile</returnvalue></link> *   <link linkend="description-file-new-from-xml-document">description_file_new_from_xml_document</link>
43
43
                                                        (<parameter><link linkend="GUPnPXMLDoc"><type>GUPnPXMLDoc</type></link> *doc</parameter>);
44
44
struct              <link linkend="DescriptionFile-struct">DescriptionFile</link>;
 
45
struct              <link linkend="DescriptionFileClass">DescriptionFileClass</link>;
45
46
</synopsis>
46
47
</refsynopsisdiv>
47
48
<refsect1 id="DescriptionFile.object-hierarchy" role="object_hierarchy">
172
173
</para>
173
174
<para>
174
175
<para>It makes sure that the resulting file has the correct UTF-8 encoding and does not have any kind of newlines. This is necessary as some devices with broken XML parsers can't cope with UNIX newlines. If a file with the same name exists it will be overwritten.</para>
 
176
<para><link linkend="GError"><type>GError</type></link> will be returned in <parameter>error</parameter> if anything fails while creating the XML dump. </para>
175
177
</para><variablelist role="params">
176
178
<varlistentry><term><parameter>self</parameter>&#160;:</term>
177
179
<listitem><simpara>the <link linkend="DescriptionFile"><type>DescriptionFile</type></link> instance</simpara></listitem></varlistentry>
187
189
                                                         <parameter><link linkend="GError"><type>GError</type></link> **error</parameter>);</programlisting>
188
190
<para>
189
191
Constructor to load a description file from disk
 
192
</para>
 
193
<para>
 
194
<para><link linkend="GUPNP-XML-ERROR-PARSE"><type>GUPNP_XML_ERROR_PARSE</type></link> will be returned in <parameter>error</parameter> if there was an error reading or parsing the file. </para>
190
195
</para><variablelist role="params">
191
196
<varlistentry><term><parameter>template</parameter>&#160;:</term>
192
197
<listitem><simpara>the path to the description file. <emphasis role="annotation">[<acronym>in</acronym>]</emphasis></simpara></listitem></varlistentry>
211
216
<para>
212
217
Represents a device description document and offers methods for easy manipulation of those.
213
218
</para></refsect2>
 
219
<refsect2 id="DescriptionFileClass" role="struct">
 
220
<title>struct DescriptionFileClass</title>
 
221
<indexterm zone="DescriptionFileClass"><primary>DescriptionFileClass</primary></indexterm>
 
222
<programlisting>struct DescriptionFileClass {
 
223
        GObjectClass parent_class;
 
224
};
 
225
</programlisting>
 
226
<para>
 
227
The class structure for <link linkend="TYPE-DESCRIPTION-FILE:CAPS"><literal>TYPE_DESCRIPTION_FILE</literal></link>. All the fields in this structure are private and should never be accessed directly.
 
228
</para><variablelist role="struct">
 
229
<varlistentry><term><link linkend="GObjectClass"><type>GObjectClass</type></link>&#160;<structfield id="DescriptionFileClass.parent-class">parent_class</structfield>;</term>
 
230
<listitem><simpara>the parent class structure</simpara></listitem>
 
231
</varlistentry>
 
232
</variablelist></refsect2>
214
233
 
215
234
</refsect1>
216
235