LADI
/
jack-plugin-docs
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update API docs

This commit is contained in:
Nedko Arnaudov 2023-12-26 20:20:13 +02:00
parent 4dae91a1fb
commit aa70ad0fd8
2 changed files with 8 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
libjpl-api/loader_8h.html
View File

@ -116,9 +116,13 @@ Functions</h2></td></tr>
void&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_run</b> (void)</td></tr>
<tr class="memdesc:a47053fa4c3be985fe8cfc9cba35943c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read subprocess output and call the callbacks. <br /></td></tr>
<tr class="separator:a47053fa4c3be985fe8cfc9cba35943c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0bce03ff80a12b8e3c5d081949acf89" id="r_ad0bce03ff80a12b8e3c5d081949acf89"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#ad0bce03ff80a12b8e3c5d081949acf89">jpl_uninit</a> (void)</td></tr>
<tr class="memitem:ad0bce03ff80a12b8e3c5d081949acf89" id="r_ad0bce03ff80a12b8e3c5d081949acf89"><td class="memItemLeft" align="right" valign="top"><a id="ad0bce03ff80a12b8e3c5d081949acf89" name="ad0bce03ff80a12b8e3c5d081949acf89"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_uninit</b> (void)</td></tr>
<tr class="memdesc:ad0bce03ff80a12b8e3c5d081949acf89"><td class="mdescLeft">&#160;</td><td class="mdescRight">uninitialize the launcher module <br /></td></tr>
<tr class="separator:ad0bce03ff80a12b8e3c5d081949acf89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7725c04ff746f77ebbbe57a738c8bb55" id="r_a7725c04ff746f77ebbbe57a738c8bb55"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="loader_8h.html#a7725c04ff746f77ebbbe57a738c8bb55">jpl_get_app_count</a> (void)</td></tr>
<tr class="memitem:a7725c04ff746f77ebbbe57a738c8bb55" id="r_a7725c04ff746f77ebbbe57a738c8bb55"><td class="memItemLeft" align="right" valign="top"><a id="a7725c04ff746f77ebbbe57a738c8bb55" name="a7725c04ff746f77ebbbe57a738c8bb55"></a>
unsigned int&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_get_app_count</b> (void)</td></tr>
<tr class="memdesc:a7725c04ff746f77ebbbe57a738c8bb55"><td class="mdescLeft">&#160;</td><td class="mdescRight">get number of child processes <br /></td></tr>
<tr class="separator:a7725c04ff746f77ebbbe57a738c8bb55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
@ -266,25 +270,6 @@ void&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_run</b> (void)</t
</dl>
<dl class="section return"><dt>Returns</dt><dd>success status </dd></dl>
</div>
</div>
<a id="a7725c04ff746f77ebbbe57a738c8bb55" name="a7725c04ff746f77ebbbe57a738c8bb55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7725c04ff746f77ebbbe57a738c8bb55">&#9670;&#160;</a></span>jpl_get_app_count()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int jpl_get_app_count </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get number of child processes </p>
</div>
</div>
<a id="a26f5478ddde4a440a4e575bedf013081" name="a26f5478ddde4a440a4e575bedf013081"></a>
@ -322,25 +307,6 @@ void&#160;</td><td class="memItemRight" valign="bottom"><b>jpl_run</b> (void)</t
</dd>
</dl>
</div>
</div>
<a id="ad0bce03ff80a12b8e3c5d081949acf89" name="ad0bce03ff80a12b8e3c5d081949acf89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0bce03ff80a12b8e3c5d081949acf89">&#9670;&#160;</a></span>jpl_uninit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void jpl_uninit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>uninitialize the launcher module </p>
</div>
</div>
</div><!-- contents -->

4
libjpl-api/loader_8h_source.html
View File

@ -142,11 +142,11 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="preprocessor">#endif </span><span class="comment">/* #ifndef JPL_H__6D6AF97A_DA41_46D6_954B_A121B25E96CE__INCLUDED */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aloader_8h_html_a26f5478ddde4a440a4e575bedf013081"><div class="ttname"><a href="loader_8h.html#a26f5478ddde4a440a4e575bedf013081">jpl_init</a></div><div class="ttdeci">void jpl_init(jpl_on_child_exit on_child_exit, jpl_log_callback log_callback)</div><div class="ttdoc">initialize the launcher module</div></div>
<div class="ttc" id="aloader_8h_html_a47053fa4c3be985fe8cfc9cba35943c7"><div class="ttname"><a href="loader_8h.html#a47053fa4c3be985fe8cfc9cba35943c7">jpl_run</a></div><div class="ttdeci">void jpl_run(void)</div><div class="ttdoc">Read subprocess output and call the callbacks.</div></div>
<div class="ttc" id="aloader_8h_html_a7725c04ff746f77ebbbe57a738c8bb55"><div class="ttname"><a href="loader_8h.html#a7725c04ff746f77ebbbe57a738c8bb55">jpl_get_app_count</a></div><div class="ttdeci">unsigned int jpl_get_app_count(void)</div></div>
<div class="ttc" id="aloader_8h_html_a7725c04ff746f77ebbbe57a738c8bb55"><div class="ttname"><a href="loader_8h.html#a7725c04ff746f77ebbbe57a738c8bb55">jpl_get_app_count</a></div><div class="ttdeci">unsigned int jpl_get_app_count(void)</div><div class="ttdoc">get number of child processes</div></div>
<div class="ttc" id="aloader_8h_html_a7d3d646ee1a8b02e8288d2c248407376"><div class="ttname"><a href="loader_8h.html#a7d3d646ee1a8b02e8288d2c248407376">jpl_log_callback</a></div><div class="ttdeci">void(* jpl_log_callback)(void *ctx, bool error, const char *format,...)</div><div class="ttdoc">function type for callback called on child exit</div><div class="ttdef"><b>Definition</b> loader.h:42</div></div>
<div class="ttc" id="aloader_8h_html_a8da2c08d82e942d6a383ccadace574de"><div class="ttname"><a href="loader_8h.html#a8da2c08d82e942d6a383ccadace574de">jpl_child_handle</a></div><div class="ttdeci">struct jpl_child_tag * jpl_child_handle</div></div>
<div class="ttc" id="aloader_8h_html_a9b5b920eec41d3a3d367694a7d5604f5"><div class="ttname"><a href="loader_8h.html#a9b5b920eec41d3a3d367694a7d5604f5">jpl_on_child_exit</a></div><div class="ttdeci">void(* jpl_on_child_exit)(void *ctx, int exit_status)</div><div class="ttdoc">function type for callback called on child exit</div><div class="ttdef"><b>Definition</b> loader.h:28</div></div>
<div class="ttc" id="aloader_8h_html_ad0bce03ff80a12b8e3c5d081949acf89"><div class="ttname"><a href="loader_8h.html#ad0bce03ff80a12b8e3c5d081949acf89">jpl_uninit</a></div><div class="ttdeci">void jpl_uninit(void)</div></div>
<div class="ttc" id="aloader_8h_html_ad0bce03ff80a12b8e3c5d081949acf89"><div class="ttname"><a href="loader_8h.html#ad0bce03ff80a12b8e3c5d081949acf89">jpl_uninit</a></div><div class="ttdeci">void jpl_uninit(void)</div><div class="ttdoc">uninitialize the launcher module</div></div>
<div class="ttc" id="aloader_8h_html_ae127be7ab8852a56c48d4ef64109ae5c"><div class="ttname"><a href="loader_8h.html#ae127be7ab8852a56c48d4ef64109ae5c">jpl_execute</a></div><div class="ttdeci">bool jpl_execute(void *ctx, const char *working_dir, bool run_in_terminal, const char *commandline, const char *const *env_vars, const char *const *ldpreload, pid_t *pid_ptr, jpl_child_handle *child_handle_ptr)</div><div class="ttdoc">run child program in a subprocess</div></div>
<div class="ttc" id="astructjpl__child__tag_html"><div class="ttname"><a href="structjpl__child__tag.html">jpl_child_tag</a></div><div class="ttdef"><b>Definition</b> loader.h:16</div></div>
<div class="ttc" id="astructjpl__child__tag_html_ac72a9b79ab715b586b1b01e28efba90f"><div class="ttname"><a href="structjpl__child__tag.html#ac72a9b79ab715b586b1b01e28efba90f">jpl_child_tag::unused</a></div><div class="ttdeci">int unused</div><div class="ttdef"><b>Definition</b> loader.h:17</div></div>