Update docs to v0.11.3

2026-04-02 14:27:00 -04:00 · 2018-04-01 22:45:49 -07:00
parent faecb98247
commit bf8a33cda0
15 changed files with 4628 additions and 2073 deletions
--- a/reference/html/FlatpakRef.html
+++ b/reference/html/FlatpakRef.html
@@ -3,12 +3,12 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>FlatpakRef: Flatpak Library Reference Manual</title>
-<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
 <link rel="home" href="index.html" title="Flatpak Library Reference Manual">
 <link rel="up" href="ch01.html" title="Flatpak">
 <link rel="prev" href="FlatpakInstallation.html" title="FlatpakInstallation">
 <link rel="next" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">
-<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
+<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
 <link rel="stylesheet" href="style.css" type="text/css">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -35,7 +35,7 @@
 </tr></table></div>
 <div class="refsect1">
 <a name="FlatpakRef.functions"></a><h2>Functions</h2>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="functions_return">
 <col class="functions_name">
@@ -67,6 +67,13 @@
 <td class="function_type">const <span class="returnvalue">char</span> *
 </td>
 <td class="function_name">
+<a class="link" href="FlatpakRef.html#flatpak-ref-get-collection-id" title="flatpak_ref_get_collection_id ()">flatpak_ref_get_collection_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">const <span class="returnvalue">char</span> *
+</td>
+<td class="function_name">
 <a class="link" href="FlatpakRef.html#flatpak-ref-get-commit" title="flatpak_ref_get_commit ()">flatpak_ref_get_commit</a> <span class="c_punctuation">()</span>
 </td>
 </tr>
@@ -98,7 +105,7 @@
 </div>
 <div class="refsect1">
 <a name="FlatpakRef.properties"></a><h2>Properties</h2>
-<div class="informaltable"><table border="0">
+<div class="informaltable"><table class="informaltable" border="0">
 <colgroup>
 <col width="150px" class="properties_type">
 <col width="300px" class="properties_name">
@@ -107,19 +114,25 @@
 <tbody>
 <tr>
 <td class="property_type">
-<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
+<span class="type">gchar</span> *</td>
 <td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--arch" title="The “arch” property">arch</a></td>
 <td class="property_flags">Read / Write</td>
 </tr>
 <tr>
 <td class="property_type">
-<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
+<span class="type">gchar</span> *</td>
 <td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--branch" title="The “branch” property">branch</a></td>
 <td class="property_flags">Read / Write</td>
 </tr>
 <tr>
 <td class="property_type">
-<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
+<span class="type">gchar</span> *</td>
+<td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--collection-id" title="The “collection-id” property">collection-id</a></td>
+<td class="property_flags">Read / Write</td>
+</tr>
+<tr>
+<td class="property_type">
+<span class="type">gchar</span> *</td>
 <td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--commit" title="The “commit” property">commit</a></td>
 <td class="property_flags">Read / Write</td>
 </tr>
@@ -130,7 +143,7 @@
 </tr>
 <tr>
 <td class="property_type">
-<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
+<span class="type">gchar</span> *</td>
 <td class="property_name"><a class="link" href="FlatpakRef.html#FlatpakRef--name" title="The “name” property">name</a></td>
 <td class="property_flags">Read / Write</td>
 </tr>
@@ -139,7 +152,7 @@
 </div>
 <div class="refsect1">
 <a name="FlatpakRef.other"></a><h2>Types and Values</h2>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="name">
 <col class="description">
@@ -158,10 +171,11 @@
 </div>
 <div class="refsect1">
 <a name="FlatpakRef.object-hierarchy"></a><h2>Object Hierarchy</h2>
-<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
+<pre class="screen">    GObject
    <span class="lineart">╰──</span> FlatpakRef
        <span class="lineart">├──</span> <a class="link" href="flatpak-flatpak-bundle-ref.html#FlatpakBundleRef">FlatpakBundleRef</a>
        <span class="lineart">├──</span> <a class="link" href="FlatpakInstalledRef.html" title="FlatpakInstalledRef">FlatpakInstalledRef</a>
+        <span class="lineart">├──</span> <a class="link" href="FlatpakRelatedRef.html" title="FlatpakRelatedRef">FlatpakRelatedRef</a>
        <span class="lineart">╰──</span> <a class="link" href="FlatpakRemoteRef.html" title="FlatpakRemoteRef">FlatpakRemoteRef</a>
 </pre>
 </div>
@@ -190,7 +204,7 @@ flatpak_ref_format_ref (<em class="parameter"><code><a class="link" href="Flatpa
 can be parsed by <a class="link" href="FlatpakRef.html#flatpak-ref-parse" title="flatpak_ref_parse ()"><code class="function">flatpak_ref_parse()</code></a>.</p>
 <div class="refsect3">
 <a name="flatpak-ref-format-ref.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -205,7 +219,7 @@ can be parsed by <a class="link" href="FlatpakRef.html#flatpak-ref-parse" title=
 </div>
 <div class="refsect3">
 <a name="flatpak-ref-format-ref.returns"></a><h4>Returns</h4>
-<p> string representation. </p>
+<p>string representation. </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>
@@ -217,7 +231,7 @@ flatpak_ref_get_arch (<em class="parameter"><code><a class="link" href="FlatpakR
 <p>Gets the arch or the ref.</p>
 <div class="refsect3">
 <a name="flatpak-ref-get-arch.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -232,7 +246,7 @@ flatpak_ref_get_arch (<em class="parameter"><code><a class="link" href="FlatpakR
 </div>
 <div class="refsect3">
 <a name="flatpak-ref-get-arch.returns"></a><h4>Returns</h4>
-<p> the arch. </p>
+<p>the arch. </p>
 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 </div>
 </div>
@@ -244,7 +258,7 @@ flatpak_ref_get_branch (<em class="parameter"><code><a class="link" href="Flatpa
 <p>Gets the branch of the ref.</p>
 <div class="refsect3">
 <a name="flatpak-ref-get-branch.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -259,7 +273,34 @@ flatpak_ref_get_branch (<em class="parameter"><code><a class="link" href="Flatpa
 </div>
 <div class="refsect3">
 <a name="flatpak-ref-get-branch.returns"></a><h4>Returns</h4>
-<p> the branch. </p>
+<p>the branch. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="flatpak-ref-get-collection-id"></a><h3>flatpak_ref_get_collection_id ()</h3>
+<pre class="programlisting">const <span class="returnvalue">char</span> *
+flatpak_ref_get_collection_id (<em class="parameter"><code><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> *self</code></em>);</pre>
+<p>Gets the collection ID of the ref.</p>
+<div class="refsect3">
+<a name="flatpak-ref-get-collection-id.parameters"></a><h4>Parameters</h4>
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>self</p></td>
+<td class="parameter_description"><p>a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="flatpak-ref-get-collection-id.returns"></a><h4>Returns</h4>
+<p>the collection ID. </p>
 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 </div>
 </div>
@@ -271,7 +312,7 @@ flatpak_ref_get_commit (<em class="parameter"><code><a class="link" href="Flatpa
 <p>Gets the commit of the ref.</p>
 <div class="refsect3">
 <a name="flatpak-ref-get-commit.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -286,7 +327,7 @@ flatpak_ref_get_commit (<em class="parameter"><code><a class="link" href="Flatpa
 </div>
 <div class="refsect3">
 <a name="flatpak-ref-get-commit.returns"></a><h4>Returns</h4>
-<p> the commit. </p>
+<p>the commit. </p>
 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 </div>
 </div>
@@ -298,7 +339,7 @@ flatpak_ref_get_kind (<em class="parameter"><code><a class="link" href="FlatpakR
 <p>Gets the kind of artifact that this ref refers to.</p>
 <div class="refsect3">
 <a name="flatpak-ref-get-kind.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -324,7 +365,7 @@ flatpak_ref_get_name (<em class="parameter"><code><a class="link" href="FlatpakR
 <p>Gets the name of the ref.</p>
 <div class="refsect3">
 <a name="flatpak-ref-get-name.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -339,7 +380,7 @@ flatpak_ref_get_name (<em class="parameter"><code><a class="link" href="FlatpakR
 </div>
 <div class="refsect3">
 <a name="flatpak-ref-get-name.returns"></a><h4>Returns</h4>
-<p> the name. </p>
+<p>the name. </p>
 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 </div>
 </div>
@@ -348,12 +389,12 @@ flatpak_ref_get_name (<em class="parameter"><code><a class="link" href="FlatpakR
 <a name="flatpak-ref-parse"></a><h3>flatpak_ref_parse ()</h3>
 <pre class="programlisting"><a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="returnvalue">FlatpakRef</span></a> *
 flatpak_ref_parse (<em class="parameter"><code>const <span class="type">char</span> *ref</code></em>,
-                   <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+                   <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 <p>Tries to parse a full ref name and return a <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a> (without a
 commit set) or fail if the ref is invalid somehow.</p>
 <div class="refsect3">
 <a name="flatpak-ref-parse.parameters"></a><h4>Parameters</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="150px" class="parameters_name">
 <col class="parameters_description">
@@ -367,7 +408,7 @@ commit set) or fail if the ref is invalid somehow.</p>
 </tr>
 <tr>
 <td class="parameter_name"><p>error</p></td>
-<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a></p></td>
+<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td>
 <td class="parameter_annotations"> </td>
 </tr>
 </tbody>
@@ -375,7 +416,7 @@ commit set) or fail if the ref is invalid somehow.</p>
 </div>
 <div class="refsect3">
 <a name="flatpak-ref-parse.returns"></a><h4>Returns</h4>
-<p> an <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
+<p>an <a class="link" href="FlatpakRef.html" title="FlatpakRef"><span class="type">FlatpakRef</span></a>, or <code class="literal">NULL</code>. </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>
@@ -392,7 +433,7 @@ commit set) or fail if the ref is invalid somehow.</p>
 <p>The kind of artifact that a FlatpakRef refers to.</p>
 <div class="refsect3">
 <a name="FlatpakRefKind.members"></a><h4>Members</h4>
-<div class="informaltable"><table width="100%" border="0">
+<div class="informaltable"><table class="informaltable" width="100%" border="0">
 <colgroup>
 <col width="300px" class="enum_members_name">
 <col class="enum_members_description">
@@ -422,7 +463,7 @@ commit set) or fail if the ref is invalid somehow.</p>
 <a name="FlatpakRef.property-details"></a><h2>Property Details</h2>
 <div class="refsect2">
 <a name="FlatpakRef--arch"></a><h3>The <code class="literal">“arch”</code> property</h3>
-<pre class="programlisting">  “arch”                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
+<pre class="programlisting">  “arch”                     <span class="type">gchar</span> *</pre>
 <p>The architecture of the application or runtime.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
@@ -430,15 +471,23 @@ commit set) or fail if the ref is invalid somehow.</p>
 <hr>
 <div class="refsect2">
 <a name="FlatpakRef--branch"></a><h3>The <code class="literal">“branch”</code> property</h3>
-<pre class="programlisting">  “branch”                   <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
+<pre class="programlisting">  “branch”                   <span class="type">gchar</span> *</pre>
 <p>The branch of the application or runtime.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
 </div>
 <hr>
 <div class="refsect2">
+<a name="FlatpakRef--collection-id"></a><h3>The <code class="literal">“collection-id”</code> property</h3>
+<pre class="programlisting">  “collection-id”            <span class="type">gchar</span> *</pre>
+<p>The collection ID.</p>
+<p>Flags: Read / Write</p>
+<p>Default value: NULL</p>
+</div>
+<hr>
+<div class="refsect2">
 <a name="FlatpakRef--commit"></a><h3>The <code class="literal">“commit”</code> property</h3>
-<pre class="programlisting">  “commit”                   <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
+<pre class="programlisting">  “commit”                   <span class="type">gchar</span> *</pre>
 <p>The commit.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
@@ -454,7 +503,7 @@ commit set) or fail if the ref is invalid somehow.</p>
 <hr>
 <div class="refsect2">
 <a name="FlatpakRef--name"></a><h3>The <code class="literal">“name”</code> property</h3>
-<pre class="programlisting">  “name”                     <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
+<pre class="programlisting">  “name”                     <span class="type">gchar</span> *</pre>
 <p>The name of the application or runtime.</p>
 <p>Flags: Read / Write</p>
 <p>Default value: NULL</p>
@@ -462,6 +511,6 @@ commit set) or fail if the ref is invalid somehow.</p>
 </div>
 </div>
 <div class="footer">
-<hr>Generated by GTK-Doc V1.25.1</div>
+<hr>Generated by GTK-Doc V1.27</div>
 </body>
 </html>