Skip to content

Commit

Permalink
add doxygen generated API document (bytecodealliance#46)
Browse files Browse the repository at this point in the history
  • Loading branch information
@TianlongLiang
TianlongLiang authored Apr 8, 2024
1 parent 3a50165 commit 313a1b3
Show file tree
Hide file tree
Showing 172 changed files with 19,944 additions and 0 deletions.
5 changes: 5 additions & 0 deletions config/_default/menus/menus.en.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@
url = "/resources/"
weight = 30

[[main]]
name = "User APIs"
url = "/apis/"
weight = 30

[[social]]
name = "GitHub"
pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>"
Expand Down
16 changes: 16 additions & 0 deletions content/en/apis/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "User APIs"
description: "End User APIs document for WAMR Export APIs."
date: 2024-4-7T10:13:29+00:00
lastmod: 2024-4-7T10:13:30+00:00
draft: false
images: []
---

End User APIs document for WAMR Export APIs:

- [wasm export APIs](../docs/html/wasm__export_8h.html)
- [wasm C APIs](../docs/html/wasm__c__api_8h.html)
- [aot export APIs](../docs/html/aot__export_8h.html)
- [gc export APIs](../docs/html/gc__export_8h.html)
- [lib export APIs](../docs/html/lib__export_8h.html)
93 changes: 93 additions & 0 deletions static/docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WAMR User APIs: Class List</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">WAMR User APIs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">Class List</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structInstantiationArgs.html" target="_self">InstantiationArgs</a></td><td class="desc"></td></tr>
<tr id="row_1_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmem__alloc__info__t.html" target="_self">mem_alloc_info_t</a></td><td class="desc"></td></tr>
<tr id="row_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionMemAllocOption.html" target="_self">MemAllocOption</a></td><td class="desc"></td></tr>
<tr id="row_3_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structNativeSymbol.html" target="_self">NativeSymbol</a></td><td class="desc"></td></tr>
<tr id="row_4_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structRuntimeInitArgs.html" target="_self">RuntimeInitArgs</a></td><td class="desc"></td></tr>
<tr id="row_5_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionV128.html" target="_self">V128</a></td><td class="desc"></td></tr>
<tr id="row_6_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwasm__config__t.html" target="_self">wasm_config_t</a></td><td class="desc"></td></tr>
<tr id="row_7_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwasm__limits__t.html" target="_self">wasm_limits_t</a></td><td class="desc"></td></tr>
<tr id="row_8_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwasm__ref__type__t.html" target="_self">wasm_ref_type_t</a></td><td class="desc"></td></tr>
<tr id="row_9_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwasm__section__t.html" target="_self">wasm_section_t</a></td><td class="desc"></td></tr>
<tr id="row_10_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structwasm__val__t.html" target="_self">wasm_val_t</a></td><td class="desc"></td></tr>
<tr id="row_11_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structWASMLocalObjectRef.html" target="_self">WASMLocalObjectRef</a></td><td class="desc"></td></tr>
<tr id="row_12_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="unionWASMValue.html" target="_self">WASMValue</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
167 changes: 167 additions & 0 deletions static/docs/html/aot__export_8h.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>WAMR User APIs: core/iwasm/include/aot_export.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">WAMR User APIs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li><li class="navelem"><a class="el" href="dir_70ddbf8ef0ea72aed946aee035146e11.html">iwasm</a></li><li class="navelem"><a class="el" href="dir_5334258e64866e0b85968f39ee98c801.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">aot_export.h File Reference</div> </div>
</div><!--header-->
<div class="contents">

<p>This file defines the exported AOT compilation APIs.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdbool.h&gt;</code><br />
<code>#include &quot;aot_comp_option.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for aot_export.h:</div>
<div class="dyncontent">
<div class="center"><img src="aot__export_8h__incl.png" border="0" usemap="#core_2iwasm_2include_2aot__export_8h" alt=""/></div>
<map name="core_2iwasm_2include_2aot__export_8h" id="core_2iwasm_2include_2aot__export_8h">
<area shape="rect" title="This file defines the exported AOT compilation APIs." alt="" coords="68,5,216,47"/>
<area shape="rect" title=" " alt="" coords="5,95,76,121"/>
<area shape="rect" title=" " alt="" coords="101,95,183,121"/>
<area shape="rect" title=" " alt="" coords="207,95,354,121"/>
</map>
</div>
</div>
<p><a href="aot__export_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a3ef55abca3fbfe4e8dad3f760bf280b8"><td class="memItemLeft" align="right" valign="top"><a id="a3ef55abca3fbfe4e8dad3f760bf280b8"></a>
typedef struct AOTCompData *&#160;</td><td class="memItemRight" valign="bottom"><b>aot_comp_data_t</b></td></tr>
<tr class="separator:a3ef55abca3fbfe4e8dad3f760bf280b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74dcc47041f4d1f76e2dcf10ccde1ea7"><td class="memItemLeft" align="right" valign="top"><a id="a74dcc47041f4d1f76e2dcf10ccde1ea7"></a>
typedef struct AOTCompContext *&#160;</td><td class="memItemRight" valign="bottom"><b>aot_comp_context_t</b></td></tr>
<tr class="separator:a74dcc47041f4d1f76e2dcf10ccde1ea7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top"><a id="a06fc87d81c62e9abb8790b6e5713c55b"></a>enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>AOT_FORMAT_FILE</b>,
<b>AOT_OBJECT_FILE</b>,
<b>AOT_LLVMIR_UNOPT_FILE</b>,
<b>AOT_LLVMIR_OPT_FILE</b>
}</td></tr>
<tr class="separator:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ad86479d5276717a0402a7bfdf201182e"><td class="memItemLeft" align="right" valign="top"><a id="ad86479d5276717a0402a7bfdf201182e"></a>
aot_comp_data_t&#160;</td><td class="memItemRight" valign="bottom"><b>aot_create_comp_data</b> (void *wasm_module, const char *target_arch, bool gc_enabled)</td></tr>
<tr class="separator:ad86479d5276717a0402a7bfdf201182e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad10333fba2f048ca71b09e910ae24ff4"><td class="memItemLeft" align="right" valign="top"><a id="ad10333fba2f048ca71b09e910ae24ff4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>aot_destroy_comp_data</b> (aot_comp_data_t comp_data)</td></tr>
<tr class="separator:ad10333fba2f048ca71b09e910ae24ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9da919a10f619ff24dd75de319224f7"><td class="memItemLeft" align="right" valign="top"><a id="aa9da919a10f619ff24dd75de319224f7"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>aot_compiler_init</b> (void)</td></tr>
<tr class="separator:aa9da919a10f619ff24dd75de319224f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf224f69e680c4a73cc49e1bb11c51f8"><td class="memItemLeft" align="right" valign="top"><a id="acf224f69e680c4a73cc49e1bb11c51f8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>aot_compiler_destroy</b> (void)</td></tr>
<tr class="separator:acf224f69e680c4a73cc49e1bb11c51f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b5f1879d1cfe0391e85bea1590a037c"><td class="memItemLeft" align="right" valign="top"><a id="a8b5f1879d1cfe0391e85bea1590a037c"></a>
aot_comp_context_t&#160;</td><td class="memItemRight" valign="bottom"><b>aot_create_comp_context</b> (aot_comp_data_t comp_data, aot_comp_option_t option)</td></tr>
<tr class="separator:a8b5f1879d1cfe0391e85bea1590a037c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9201c05f6bba2671dbe369da4b16624"><td class="memItemLeft" align="right" valign="top"><a id="af9201c05f6bba2671dbe369da4b16624"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>aot_destroy_comp_context</b> (aot_comp_context_t comp_ctx)</td></tr>
<tr class="separator:af9201c05f6bba2671dbe369da4b16624"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3d2a01830c171b3544bb5bb2b31d0117"><td class="memItemLeft" align="right" valign="top"><a id="a3d2a01830c171b3544bb5bb2b31d0117"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>aot_compile_wasm</b> (aot_comp_context_t comp_ctx)</td></tr>
<tr class="separator:a3d2a01830c171b3544bb5bb2b31d0117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd0493f267119058c62251fc7fc7f291"><td class="memItemLeft" align="right" valign="top"><a id="afd0493f267119058c62251fc7fc7f291"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>aot_emit_llvm_file</b> (aot_comp_context_t comp_ctx, const char *file_name)</td></tr>
<tr class="separator:afd0493f267119058c62251fc7fc7f291"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41761ec9d03dca2edff53146f234974e"><td class="memItemLeft" align="right" valign="top"><a id="a41761ec9d03dca2edff53146f234974e"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>aot_emit_object_file</b> (aot_comp_context_t comp_ctx, const char *file_name)</td></tr>
<tr class="separator:a41761ec9d03dca2edff53146f234974e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16598de62b2feb0263c6a7dfef256c48"><td class="memItemLeft" align="right" valign="top"><a id="a16598de62b2feb0263c6a7dfef256c48"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>aot_emit_aot_file</b> (aot_comp_context_t comp_ctx, aot_comp_data_t comp_data, const char *file_name)</td></tr>
<tr class="separator:a16598de62b2feb0263c6a7dfef256c48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af7e27d8b482a43248f9e65f164a5a645"><td class="memItemLeft" align="right" valign="top"><a id="af7e27d8b482a43248f9e65f164a5a645"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>aot_destroy_aot_file</b> (uint8_t *aot_file)</td></tr>
<tr class="separator:af7e27d8b482a43248f9e65f164a5a645"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebb2d7f9809dbc755957d7946d986f6b"><td class="memItemLeft" align="right" valign="top"><a id="aebb2d7f9809dbc755957d7946d986f6b"></a>
char *&#160;</td><td class="memItemRight" valign="bottom"><b>aot_get_last_error</b> ()</td></tr>
<tr class="separator:aebb2d7f9809dbc755957d7946d986f6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50870de3d533c79452efc19ce7e5752c"><td class="memItemLeft" align="right" valign="top"><a id="a50870de3d533c79452efc19ce7e5752c"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>aot_get_plt_table_size</b> ()</td></tr>
<tr class="separator:a50870de3d533c79452efc19ce7e5752c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This file defines the exported AOT compilation APIs. </p>
<dl class="section date"><dt>Date</dt><dd>Wed Mar 20 10:46:38 2024 </dd></dl>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
6 changes: 6 additions & 0 deletions static/docs/html/aot__export_8h__incl.map
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<map id="core/iwasm/include/aot_export.h" name="core/iwasm/include/aot_export.h">
<area shape="rect" id="node1" title="This file defines the exported AOT compilation APIs." alt="" coords="68,5,216,47"/>
<area shape="rect" id="node2" title=" " alt="" coords="5,95,76,121"/>
<area shape="rect" id="node3" title=" " alt="" coords="101,95,183,121"/>
<area shape="rect" id="node4" title=" " alt="" coords="207,95,354,121"/>
</map>
1 change: 1 addition & 0 deletions static/docs/html/aot__export_8h__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
05039fe82e544182e483596a743290ff
Binary file added static/docs/html/aot__export_8h__incl.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 313a1b3

Please sign in to comment.