Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Neutree
Neutree committed May 8, 2024
1 parent 37275cd commit 4524542
Show file tree
Hide file tree
Showing 25 changed files with 1,393 additions and 719 deletions.
963 changes: 559 additions & 404 deletions maixpy/api/api.json
View file

Large diffs are not rendered by default.

69 changes: 69 additions & 0 deletions maixpy/api/maix/app.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,9 @@ <h2 id="Enum">Enum</h2>
<h2 id="Variable">Variable</h2>
<h2 id="Function">Function</h2>
<h3 id="app_id">app_id</h3>

<pre class="language-python"><code class="language-python">def app_id() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -222,6 +225,9 @@ <h3 id="app_id">app_id</h3>
<pre class="language-cpp"><code class="language-cpp">string app_id()
</code></pre>
<h3 id="set_app_id">set_app_id</h3>

<pre class="language-python"><code class="language-python">def set_app_id(app_id: str) -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -245,6 +251,9 @@ <h3 id="set_app_id">set_app_id</h3>
<pre class="language-cpp"><code class="language-cpp">string set_app_id(const string &amp;app_id)
</code></pre>
<h3 id="get_apps_info_path">get_apps_info_path</h3>

<pre class="language-python"><code class="language-python">def get_apps_info_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -264,6 +273,9 @@ <h3 id="get_apps_info_path">get_apps_info_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_apps_info_path()
</code></pre>
<h3 id="get_apps_info">get_apps_info</h3>

<pre class="language-python"><code class="language-python">def get_apps_info(ignore_launcher: bool = False, ignore_app_store: bool = False) -&gt; list[APP_Info]
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -291,6 +303,9 @@ <h3 id="get_apps_info">get_apps_info</h3>
<pre class="language-cpp"><code class="language-cpp">vector&lt;app::APP_Info&gt; &amp;get_apps_info(bool ignore_launcher = false, bool ignore_app_store = false)
</code></pre>
<h3 id="get_app_data_path">get_app_data_path</h3>

<pre class="language-python"><code class="language-python">def get_app_data_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -314,6 +329,9 @@ <h3 id="get_app_data_path">get_app_data_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_app_data_path()
</code></pre>
<h3 id="get_app_path">get_app_path</h3>

<pre class="language-python"><code class="language-python">def get_app_path(app_id: str = '') -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -341,6 +359,9 @@ <h3 id="get_app_path">get_app_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_app_path(const string &amp;app_id = &quot;&quot;)
</code></pre>
<h3 id="get_tmp_path">get_tmp_path</h3>

<pre class="language-python"><code class="language-python">def get_tmp_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -364,6 +385,9 @@ <h3 id="get_tmp_path">get_tmp_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_tmp_path()
</code></pre>
<h3 id="get_share_path">get_share_path</h3>

<pre class="language-python"><code class="language-python">def get_share_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -387,6 +411,9 @@ <h3 id="get_share_path">get_share_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_share_path()
</code></pre>
<h3 id="get_picture_path">get_picture_path</h3>

<pre class="language-python"><code class="language-python">def get_picture_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -410,6 +437,9 @@ <h3 id="get_picture_path">get_picture_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_picture_path()
</code></pre>
<h3 id="get_video_path">get_video_path</h3>

<pre class="language-python"><code class="language-python">def get_video_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -433,6 +463,9 @@ <h3 id="get_video_path">get_video_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_video_path()
</code></pre>
<h3 id="get_font_path">get_font_path</h3>

<pre class="language-python"><code class="language-python">def get_font_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -456,6 +489,9 @@ <h3 id="get_font_path">get_font_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_font_path()
</code></pre>
<h3 id="get_icon_path">get_icon_path</h3>

<pre class="language-python"><code class="language-python">def get_icon_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -479,6 +515,9 @@ <h3 id="get_icon_path">get_icon_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_icon_path()
</code></pre>
<h3 id="get_sys_config_kv">get_sys_config_kv</h3>

<pre class="language-python"><code class="language-python">def get_sys_config_kv(item: str, key: str, value: str = '', from_cache: bool = True) -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -506,6 +545,9 @@ <h3 id="get_sys_config_kv">get_sys_config_kv</h3>
<pre class="language-cpp"><code class="language-cpp">string get_sys_config_kv(const string &amp;item, const string &amp;key, const string &amp;value = &quot;&quot;, bool from_cache = true)
</code></pre>
<h3 id="get_app_config_kv">get_app_config_kv</h3>

<pre class="language-python"><code class="language-python">def get_app_config_kv(item: str, key: str, value: str = '', from_cache: bool = True) -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -533,6 +575,9 @@ <h3 id="get_app_config_kv">get_app_config_kv</h3>
<pre class="language-cpp"><code class="language-cpp">string get_app_config_kv(const string &amp;item, const string &amp;key, const string &amp;value = &quot;&quot;, bool from_cache = true)
</code></pre>
<h3 id="set_app_config_kv">set_app_config_kv</h3>

<pre class="language-python"><code class="language-python">def set_app_config_kv(item: str, key: str, value: str, write_file: bool = True) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -560,6 +605,9 @@ <h3 id="set_app_config_kv">set_app_config_kv</h3>
<pre class="language-cpp"><code class="language-cpp">err::Err set_app_config_kv(const string &amp;item, const string &amp;key, const string &amp;value, bool write_file = true)
</code></pre>
<h3 id="get_app_config_path">get_app_config_path</h3>

<pre class="language-python"><code class="language-python">def get_app_config_path() -&gt; str
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -583,6 +631,9 @@ <h3 id="get_app_config_path">get_app_config_path</h3>
<pre class="language-cpp"><code class="language-cpp">string get_app_config_path()
</code></pre>
<h3 id="set_exit_msg">set_exit_msg</h3>

<pre class="language-python"><code class="language-python">def set_exit_msg(code: maix.err.Err, msg: str) -&gt; maix.err.Err
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -610,6 +661,9 @@ <h3 id="set_exit_msg">set_exit_msg</h3>
<pre class="language-cpp"><code class="language-cpp">err::Err set_exit_msg(err::Err code, const string &amp;msg)
</code></pre>
<h3 id="get_exit_msg">get_exit_msg</h3>

<pre class="language-python"><code class="language-python">def get_exit_msg(cache: bool = False) -&gt; tuple[str, maix.err.Err, str]
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -637,6 +691,9 @@ <h3 id="get_exit_msg">get_exit_msg</h3>
<pre class="language-cpp"><code class="language-cpp">tuple&lt;string, err::Err, string&gt; get_exit_msg(bool cache = false)
</code></pre>
<h3 id="have_exit_msg">have_exit_msg</h3>

<pre class="language-python"><code class="language-python">def have_exit_msg(cache: bool = False) -&gt; bool
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -664,6 +721,9 @@ <h3 id="have_exit_msg">have_exit_msg</h3>
<pre class="language-cpp"><code class="language-cpp">bool have_exit_msg(bool cache = false)
</code></pre>
<h3 id="switch_app">switch_app</h3>

<pre class="language-python"><code class="language-python">def switch_app(app_id: str, idx: int = -1) -&gt; None
</code></pre>
<table>
<thead>
<tr>
Expand All @@ -687,6 +747,9 @@ <h3 id="switch_app">switch_app</h3>
<pre class="language-cpp"><code class="language-cpp">void switch_app(const string &amp;app_id, int idx = -1)
</code></pre>
<h3 id="need_exit">need_exit</h3>

<pre class="language-python"><code class="language-python">def need_exit() -&gt; bool
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -714,6 +777,9 @@ <h3 id="need_exit">need_exit</h3>
<pre class="language-cpp"><code class="language-cpp">bool need_exit()
</code></pre>
<h3 id="running">running</h3>

<pre class="language-python"><code class="language-python">def running() -&gt; bool
</code></pre>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -741,6 +807,9 @@ <h3 id="running">running</h3>
<pre class="language-cpp"><code class="language-cpp">bool running()
</code></pre>
<h3 id="set_exit_flag">set_exit_flag</h3>

<pre class="language-python"><code class="language-python">def set_exit_flag(exit: bool) -&gt; None
</code></pre>
<table>
<thead>
<tr>
Expand Down
Loading

0 comments on commit 4524542

Please sign in to comment.