Skip to content

Commit c16d3ef

Browse files
sgallaghersgallagher
committed
Updating libmodulemd docs for 44d2bc80fc6daccae4b9879eb769c18f73b0450c
1 parent 5af288f commit c16d3ef

File tree

5 files changed

+246
-1
lines changed

5 files changed

+246
-1
lines changed

‎libmodulemd/latest/ch15.html‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@
2727
 <span class="dim">|</span> 
2828
<a class="shortcut" href="#idxP">P</a>
2929
 <span class="dim">|</span> 
30-
<a class="shortcut" href="#idxS">S</a></span></td>
30+
<a class="shortcut" href="#idxS">S</a>
31+
 <span class="dim">|</span> 
32+
<a class="shortcut" href="#idxY">Y</a></span></td>
3133
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
3234
<td><a accesskey="u" href="modulemd-2.0-resources.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
3335
<td><a accesskey="p" href="ch14.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
@@ -278,6 +280,10 @@
278280
</dt>
279281
<dd></dd>
280282
<dt>
283+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-buildtime-requirement-streams-as-strv" title="modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv ()">modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
284+
</dt>
285+
<dd></dd>
286+
<dt>
281287
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-community" title="modulemd_module_stream_v3_get_community ()">modulemd_module_stream_v3_get_community</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
282288
</dt>
283289
<dd></dd>
@@ -358,6 +364,10 @@
358364
</dt>
359365
<dd></dd>
360366
<dt>
367+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-runtime-requirement-streams-as-strv" title="modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv ()">modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
368+
</dt>
369+
<dd></dd>
370+
<dt>
361371
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-summary" title="modulemd_module_stream_v3_get_summary ()">modulemd_module_stream_v3_get_summary</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
362372
</dt>
363373
<dd></dd>
@@ -808,6 +818,15 @@
808818
<a class="link" href="modulemd-2.0-Modulemd.html#modulemd-set-default-stream-mdversion" title="modulemd_set_default_stream_mdversion ()">modulemd_set_default_stream_mdversion</a>, function in <a class="link" href="modulemd-2.0-Modulemd.html" title="Modulemd">Modulemd</a>
809819
</dt>
810820
<dd></dd>
821+
<a name="idxY"></a><h3 class="title">Y</h3>
822+
<dt>
823+
<a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html#modulemd-yaml-emit-nested-set" title="modulemd_yaml_emit_nested_set ()">modulemd_yaml_emit_nested_set</a>, function in <a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html" title="YAML Manipulation Tools">YAML Manipulation Tools</a>
824+
</dt>
825+
<dd></dd>
826+
<dt>
827+
<a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html#modulemd-yaml-parse-nested-set" title="modulemd_yaml_parse_nested_set ()">modulemd_yaml_parse_nested_set</a>, function in <a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html" title="YAML Manipulation Tools">YAML Manipulation Tools</a>
828+
</dt>
829+
<dd></dd>
811830
</div>
812831
<div class="footer">
813832
<hr>Generated by GTK-Doc V1.32</div>

‎libmodulemd/latest/ch17.html‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2314,6 +2314,14 @@
23142314
</dt>
23152315
<dd></dd>
23162316
<dt>
2317+
<a href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-buildtime-requirement-stream">modulemd_module_stream_v3_get_buildtime_requirement_streams</a>, function in gi-binding-renames
2318+
</dt>
2319+
<dd></dd>
2320+
<dt>
2321+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-buildtime-requirement-streams-as-strv" title="modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv ()">modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
2322+
</dt>
2323+
<dd></dd>
2324+
<dt>
23172325
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-community" title="modulemd_module_stream_v3_get_community ()">modulemd_module_stream_v3_get_community</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
23182326
</dt>
23192327
<dd></dd>
@@ -2430,6 +2438,14 @@
24302438
</dt>
24312439
<dd></dd>
24322440
<dt>
2441+
<a href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-runtime-requirement-stream">modulemd_module_stream_v3_get_runtime_requirement_streams</a>, function in gi-binding-renames
2442+
</dt>
2443+
<dd></dd>
2444+
<dt>
2445+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-runtime-requirement-streams-as-strv" title="modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv ()">modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
2446+
</dt>
2447+
<dd></dd>
2448+
<dt>
24332449
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-summary" title="modulemd_module_stream_v3_get_summary ()">modulemd_module_stream_v3_get_summary</a>, function in <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html" title="Modulemd.ModuleStreamV3">Modulemd.ModuleStreamV3</a>
24342450
</dt>
24352451
<dd></dd>
@@ -3624,6 +3640,10 @@
36243640
</dt>
36253641
<dd></dd>
36263642
<dt>
3643+
<a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html#modulemd-yaml-emit-nested-set" title="modulemd_yaml_emit_nested_set ()">modulemd_yaml_emit_nested_set</a>, function in <a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html" title="YAML Manipulation Tools">YAML Manipulation Tools</a>
3644+
</dt>
3645+
<dd></dd>
3646+
<dt>
36273647
<a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html#modulemd-yaml-emit-variant" title="modulemd_yaml_emit_variant ()">modulemd_yaml_emit_variant</a>, function in <a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html" title="YAML Manipulation Tools">YAML Manipulation Tools</a>
36283648
</dt>
36293649
<dd></dd>
@@ -3668,6 +3688,10 @@
36683688
</dt>
36693689
<dd></dd>
36703690
<dt>
3691+
<a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html#modulemd-yaml-parse-nested-set" title="modulemd_yaml_parse_nested_set ()">modulemd_yaml_parse_nested_set</a>, function in <a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html" title="YAML Manipulation Tools">YAML Manipulation Tools</a>
3692+
</dt>
3693+
<dd></dd>
3694+
<dt>
36713695
<a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html#modulemd-yaml-parse-string" title="modulemd_yaml_parse_string ()">modulemd_yaml_parse_string</a>, function in <a class="link" href="modulemd-2.0-YAML-Manipulation-Tools.html" title="YAML Manipulation Tools">YAML Manipulation Tools</a>
36723696
</dt>
36733697
<dd></dd>

‎libmodulemd/latest/modulemd-2.0-Modulemd.ModuleStreamV3.html‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -557,6 +557,22 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleStreamV3.to
557557
</tr>
558558
<tr>
559559
<td class="function_type">
560+
<a href="https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html#GStrv"><span class="returnvalue">GStrv</span></a>
561+
</td>
562+
<td class="function_name">
563+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-buildtime-requirement-streams-as-strv" title="modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv ()">modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv</a> <span class="c_punctuation">()</span>
564+
</td>
565+
</tr>
566+
<tr>
567+
<td class="function_type">
568+
<a href="https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html#GStrv"><span class="returnvalue">GStrv</span></a>
569+
</td>
570+
<td class="function_name">
571+
<a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#modulemd-module-stream-v3-get-runtime-requirement-streams-as-strv" title="modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv ()">modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv</a> <span class="c_punctuation">()</span>
572+
</td>
573+
</tr>
574+
<tr>
575+
<td class="function_type">
560576
<span class="returnvalue">void</span>
561577
</td>
562578
<td class="function_name">
@@ -2663,6 +2679,88 @@ <h2><span class="refentrytitle"><a name="modulemd-2.0-Modulemd.ModuleStreamV3.to
26632679
</div>
26642680
<hr>
26652681
<div class="refsect2">
2682+
<a name="modulemd-module-stream-v3-get-buildtime-requirement-streams-as-strv"></a><h3>modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv ()</h3>
2683+
<pre class="programlisting"><a href="https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html#GStrv"><span class="returnvalue">GStrv</span></a>
2684+
modulemd_module_stream_v3_get_buildtime_requirement_streams_as_strv
2685+
(<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3"><span class="type">ModulemdModuleStreamV3</span></a> *self</code></em>,
2686+
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *module_name</code></em>);</pre>
2687+
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> modulemd_module_stream_v3_get_buildtime_requirement_streams]</span></p>
2688+
<div class="refsect3">
2689+
<a name="modulemd-module-stream-v3-get-buildtime-requirement-streams-as-strv.parameters"></a><h4>Parameters</h4>
2690+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
2691+
<colgroup>
2692+
<col width="150px" class="parameters_name">
2693+
<col class="parameters_description">
2694+
<col width="200px" class="parameters_annotations">
2695+
</colgroup>
2696+
<tbody>
2697+
<tr>
2698+
<td class="parameter_name"><p>self</p></td>
2699+
<td class="parameter_description"><p>This <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3"><span class="type">ModulemdModuleStreamV3</span></a> object. </p></td>
2700+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
2701+
</tr>
2702+
<tr>
2703+
<td class="parameter_name"><p>module_name</p></td>
2704+
<td class="parameter_description"><p>The name of the module this module depends on. </p></td>
2705+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
2706+
</tr>
2707+
</tbody>
2708+
</table></div>
2709+
</div>
2710+
<div class="refsect3">
2711+
<a name="modulemd-module-stream-v3-get-buildtime-requirement-streams-as-strv.returns"></a><h4>Returns</h4>
2712+
<p>NULL if <em class="parameter"><code>module_name</code></em>
2713+
is not a build-time dependency
2714+
of <em class="parameter"><code>self</code></em>
2715+
, else a <a href="https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a> list containing a single element that is the name of
2716+
the stream matching this module name in the build-time dependencies. </p>
2717+
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
2718+
</div>
2719+
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
2720+
</div>
2721+
<hr>
2722+
<div class="refsect2">
2723+
<a name="modulemd-module-stream-v3-get-runtime-requirement-streams-as-strv"></a><h3>modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv ()</h3>
2724+
<pre class="programlisting"><a href="https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html#GStrv"><span class="returnvalue">GStrv</span></a>
2725+
modulemd_module_stream_v3_get_runtime_requirement_streams_as_strv
2726+
(<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3"><span class="type">ModulemdModuleStreamV3</span></a> *self</code></em>,
2727+
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/stable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *module_name</code></em>);</pre>
2728+
<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> modulemd_module_stream_v3_get_runtime_requirement_streams]</span></p>
2729+
<div class="refsect3">
2730+
<a name="modulemd-module-stream-v3-get-runtime-requirement-streams-as-strv.parameters"></a><h4>Parameters</h4>
2731+
<div class="informaltable"><table class="informaltable" width="100%" border="0">
2732+
<colgroup>
2733+
<col width="150px" class="parameters_name">
2734+
<col class="parameters_description">
2735+
<col width="200px" class="parameters_annotations">
2736+
</colgroup>
2737+
<tbody>
2738+
<tr>
2739+
<td class="parameter_name"><p>self</p></td>
2740+
<td class="parameter_description"><p>This <a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3"><span class="type">ModulemdModuleStreamV3</span></a> object. </p></td>
2741+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
2742+
</tr>
2743+
<tr>
2744+
<td class="parameter_name"><p>module_name</p></td>
2745+
<td class="parameter_description"><p>The name of the module this module depends on. </p></td>
2746+
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input. Default is transfer none."><span class="acronym">in</span></acronym>]</span></td>
2747+
</tr>
2748+
</tbody>
2749+
</table></div>
2750+
</div>
2751+
<div class="refsect3">
2752+
<a name="modulemd-module-stream-v3-get-runtime-requirement-streams-as-strv.returns"></a><h4>Returns</h4>
2753+
<p>NULL if <em class="parameter"><code>module_name</code></em>
2754+
is not a run-time dependency
2755+
of <em class="parameter"><code>self</code></em>
2756+
, else a <a href="https://developer.gnome.org/glib/stable/glib-String-Utility-Functions.html#GStrv"><span class="type">GStrv</span></a> list containing a single element that is the name of
2757+
the stream matching this module name in the run-time dependencies. </p>
2758+
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
2759+
</div>
2760+
<p class="since">Since: <a class="link" href="ch15.html#api-index-2.10">2.10</a></p>
2761+
</div>
2762+
<hr>
2763+
<div class="refsect2">
26662764
<a name="modulemd-module-stream-v3-set-xmd"></a><h3>modulemd_module_stream_v3_set_xmd ()</h3>
26672765
<pre class="programlisting"><span class="returnvalue">void</span>
26682766
modulemd_module_stream_v3_set_xmd (<em class="parameter"><code><a class="link" href="modulemd-2.0-Modulemd.ModuleStreamV3.html#ModulemdModuleStreamV3"><span class="type">ModulemdModuleStreamV3</span></a> *self</code></em>,

0 commit comments

Comments
 (0)