Skip to content

Update menu tree and main page of HAL API Referfence #2171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2025
Merged

Update menu tree and main page of HAL API Referfence #2171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/Nodes.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,19 +180,19 @@
<Path>group__HALAPI__HAL__SECURITY.html</Path>
<Subnodes>
<Node>
<Name>Security Auth</Name>
<Name>Auth</Name>
<Path>group__HALAPI__HAL__SECURITY__AUTH__MODULE.html</Path>
<Subnodes>
</Subnodes>
</Node>
<Node>
<Name>Security Certs</Name>
<Name>Certs</Name>
<Path>group__HALAPI__HAL__SECURITY__CERTS__MODULE.html</Path>
<Subnodes>
</Subnodes>
</Node>
<Node>
<Name>Security Keys</Name>
<Name>Keys</Name>
<Path>group__HALAPI__HAL__SECURITY__KEYS__MODULE.html</Path>
<Subnodes>
</Subnodes>
Expand Down
8 changes: 4 additions & 4 deletions docs/platform/HAL/api/1.0/Tokens.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18396,7 +18396,7 @@
<APILanguage>c</APILanguage>
</TokenIdentifier>
<Path>group__HALAPI__HAL__SECURITY__AUTH__MODULE.html</Path>
<Abstract>The Security Auth provides functions to handle the authentication per user.</Abstract>
<Abstract>The Auth provides functions to handle the authentication per user.</Abstract>
</Token>
<Token>
<TokenIdentifier>
Expand Down Expand Up @@ -18806,7 +18806,7 @@
<APILanguage>c</APILanguage>
</TokenIdentifier>
<Path>group__HALAPI__HAL__SECURITY__CERTS__MODULE.html</Path>
<Abstract>The Security Certs provides functions for device certificates and signing operations.</Abstract>
<Abstract>The Certs provides functions for device certificates and signing operations.</Abstract>
</Token>
<Token>
<TokenIdentifier>
Expand Down Expand Up @@ -19059,7 +19059,7 @@
<APILanguage>c</APILanguage>
</TokenIdentifier>
<Path>group__HALAPI__HAL__SECURITY__KEYS__MODULE.html</Path>
<Abstract>The Security Keys provides functions to handle keys and data related operations.</Abstract>
<Abstract>The Keys provides functions to handle keys and data related operations.</Abstract>
</Token>
<Token>
<TokenIdentifier>
Expand Down Expand Up @@ -20106,7 +20106,7 @@
<APILanguage>c</APILanguage>
</TokenIdentifier>
<Path>group__HALAPI__HAL__SENSOR__MODULE.html</Path>
<Abstract>The Sensor provides functions for geting/putting backend and creating sensor devices.</Abstract>
<Abstract>The Sensor provides functions for getting/putting backend and creating sensor devices.</Abstract>
</Token>
<Token>
<TokenIdentifier>
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,11 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_OVERVIEW"></a>
<tr>
<th>Module </th><th>Description </th></tr>
<tr>
<td><a class="el" href="group__HALAPI__HAL__SECURITY__CERTS__MODULE.html">Security Certs</a> </td><td>Provides functions to handle device certificates and signing operations </td></tr>
<td><a class="el" href="group__HALAPI__HAL__SECURITY__CERTS__MODULE.html">Certs</a> </td><td>Provides functions to handle device certificates and signing operations </td></tr>
<tr>
<td><a class="el" href="group__HALAPI__HAL__SECURITY__KEYS__MODULE.html">Security Keys</a> </td><td>Provides functions to handle keys and data related operations </td></tr>
<td><a class="el" href="group__HALAPI__HAL__SECURITY__KEYS__MODULE.html">Keys</a> </td><td>Provides functions to handle keys and data related operations </td></tr>
<tr>
<td><a class="el" href="group__HALAPI__HAL__SECURITY__AUTH__MODULE.html">Security Auth</a> </td><td>Provides functions to handle the authentication per user </td></tr>
<td><a class="el" href="group__HALAPI__HAL__SECURITY__AUTH__MODULE.html">Auth</a> </td><td>Provides functions to handle the authentication per user </td></tr>
</table>
<p>For more information on the HAL Security submodule features, see HAL Security Guide. </p>
</div><!-- contents -->
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var group__HALAPI__HAL__SECURITY =
[
[ "Security Auth", "group__HALAPI__HAL__SECURITY__AUTH__MODULE.html", null ],
[ "Security Certs", "group__HALAPI__HAL__SECURITY__CERTS__MODULE.html", null ],
[ "Security Keys", "group__HALAPI__HAL__SECURITY__KEYS__MODULE.html", null ]
[ "Auth", "group__HALAPI__HAL__SECURITY__AUTH__MODULE.html", null ],
[ "Certs", "group__HALAPI__HAL__SECURITY__CERTS__MODULE.html", null ],
[ "Keys", "group__HALAPI__HAL__SECURITY__KEYS__MODULE.html", null ]
];
16 changes: 8 additions & 8 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY__AUTH__MODULE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Tizen HAL API: Security Auth</title>
<title>Tizen HAL API: Auth</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen_html_stylesheet.css" rel="stylesheet" type="text/css" />
Expand Down Expand Up @@ -89,11 +89,11 @@
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Security Auth</div> </div>
<div class="title">Auth</div> </div>
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SECURITY.html">Security</a></div></div><!--header-->
<div class="contents">
<hr/><a name="details" id="details"></a><h2> </h2>
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__AUTH__MODULE.html">Security Auth</a> provides functions to handle the authentication per user. </p>
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__AUTH__MODULE.html">Auth</a> provides functions to handle the authentication per user. </p>
<h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_HEADER"></a>
Required Header</h2>
<p>#include &lt;hal/hal-security-auth.h&gt;</p>
Expand Down Expand Up @@ -239,7 +239,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Get the accumulated attempt number for user's password auth trys </p>
<p>Get the accumulated attempt number for user's password auth tries </p>

</div>
</div>
Expand Down Expand Up @@ -281,7 +281,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Get the limited maximum attempt number of user's password auth trys </p>
<p>Get the limited maximum attempt number of user's password auth tries </p>

</div>
</div>
Expand Down Expand Up @@ -323,7 +323,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Increase the accumulated attempt number for user's password auth trys </p>
<p>Increase the accumulated attempt number for user's password auth tries </p>

</div>
</div>
Expand Down Expand Up @@ -393,7 +393,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Reset the accumulated attempt number for user's password auth trys </p>
<p>Reset the accumulated attempt number for user's password auth tries </p>

</div>
</div>
Expand Down Expand Up @@ -435,7 +435,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Set the limited maximum attempt number of user's password auth trys </p>
<p>Set the limited maximum attempt number of user's password auth tries </p>

</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY__CERTS__MODULE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Tizen HAL API: Security Certs</title>
<title>Tizen HAL API: Certs</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen_html_stylesheet.css" rel="stylesheet" type="text/css" />
Expand Down Expand Up @@ -89,11 +89,11 @@
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Security Certs</div> </div>
<div class="title">Certs</div> </div>
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SECURITY.html">Security</a></div></div><!--header-->
<div class="contents">
<hr/><a name="details" id="details"></a><h2> </h2>
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__CERTS__MODULE.html">Security Certs</a> provides functions for device certificates and signing operations. </p>
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__CERTS__MODULE.html">Certs</a> provides functions for device certificates and signing operations. </p>
<h2><a class="anchor" id="HALAPI_HAL_SECURITY_CERTS_MODULE_HEADER"></a>
Required Header</h2>
<p>#include &lt;hal/hal-security-certs.h&gt;</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY__KEYS__MODULE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Tizen HAL API: Security Keys</title>
<title>Tizen HAL API: Keys</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen_html_stylesheet.css" rel="stylesheet" type="text/css" />
Expand Down Expand Up @@ -89,11 +89,11 @@
<div class="summary">
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">Security Keys</div> </div>
<div class="title">Keys</div> </div>
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SECURITY.html">Security</a></div></div><!--header-->
<div class="contents">
<hr/><a name="details" id="details"></a><h2> </h2>
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__KEYS__MODULE.html">Security Keys</a> provides functions to handle keys and data related operations. </p>
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__KEYS__MODULE.html">Keys</a> provides functions to handle keys and data related operations. </p>
<h2><a class="anchor" id="HALAPI_HAL_SECURITY_KEYS_MODULE_HEADER"></a>
Required Header</h2>
<p>#include &lt;hal/hal-security-keys.h&gt;</p>
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__SENSOR__MODULE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SYSTEM.html">System</a></div></div><!--header-->
<div class="contents">
<hr/><a name="details" id="details"></a><h2> </h2>
<p>The <a class="el" href="group__HALAPI__HAL__SENSOR__MODULE.html">Sensor</a> provides functions for geting/putting backend and creating sensor devices. </p>
<p>The <a class="el" href="group__HALAPI__HAL__SENSOR__MODULE.html">Sensor</a> provides functions for getting/putting backend and creating sensor devices. </p>
<h2><a class="anchor" id="HALAPI_HAL_SENSOR_MODULE_HEADER"></a>
Required Header</h2>
<p>#include &lt;hal-sensor.h&gt;</p>
Expand Down Expand Up @@ -132,7 +132,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SENSOR_MODULE_OVERVIEW"></a>
<li>int hal_sensor_get_attribute_int(uint64_t sensor_device_id, uint32_t id, int32_t attribute, int32_t *value);</li>
<li>int hal_sensor_get_attribute_str(uint64_t sensor_device_id, uint32_t id, int32_t attribute, char **value, size_t *len);</li>
</ul>
<p>Function to flush sensor datas:</p>
<p>Function to flush sensor data:</p>
<ul>
<li>int hal_sensor_flush(uint64_t sensor_device_id, uint32_t id); </li>
</ul>
Expand Down Expand Up @@ -225,7 +225,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SENSOR_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Flush sensor datas </p>
<p>Flush sensor data </p>

</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__TBM__MODULE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,7 @@ <h2><a class="anchor" id="HALAPI_HAL_TBM_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Get plane's information from TBM buffer manger HAL according to the color format </p>
<p>Get plane's information from TBM buffer manager HAL according to the color format </p>

</div>
</div>
Expand All @@ -528,7 +528,7 @@ <h2><a class="anchor" id="HALAPI_HAL_TBM_MODULE_OVERVIEW"></a>
</table>
</div>
<div class="memdoc">
<p>Get supported color format from TBM buffer manger. </p>
<p>Get supported color format from TBM buffer manager. </p>

</div>
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/HAL/api/1.0/group__HALAPI__HAL__TDM__MODULE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4807,13 +4807,13 @@ <h2><a class="anchor" id="HALAPI_HAL_TDM_MODULE_OVERVIEW"></a>
<dl class="user"><dt><b>Since:</b></dt><dd>HAL_MODULE_TDM 1.0 </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggae89f32424fc5915e44c05d6fe38db134a04a19a71fa7ca675c4c5d00c21fc30e8"></a><!-- doxytag: member="HAL_TDM_OUTPUT_CONN_STATUS_DISCONNECTED" ref="ggae89f32424fc5915e44c05d6fe38db134a04a19a71fa7ca675c4c5d00c21fc30e8" args="" -->HAL_TDM_OUTPUT_CONN_STATUS_DISCONNECTED</em>&nbsp;</td><td>
<p>The output disconnected </p>
<p>The output is disconnected </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggae89f32424fc5915e44c05d6fe38db134a8d75cffdcb7818700ef6950f9f0ff773"></a><!-- doxytag: member="HAL_TDM_OUTPUT_CONN_STATUS_CONNECTED" ref="ggae89f32424fc5915e44c05d6fe38db134a8d75cffdcb7818700ef6950f9f0ff773" args="" -->HAL_TDM_OUTPUT_CONN_STATUS_CONNECTED</em>&nbsp;</td><td>
<p>The output connected </p>
<p>The output is connected </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggae89f32424fc5915e44c05d6fe38db134ae50356f563eccbc7fb0808420f3af701"></a><!-- doxytag: member="HAL_TDM_OUTPUT_CONN_STATUS_MODE_SETTED" ref="ggae89f32424fc5915e44c05d6fe38db134ae50356f563eccbc7fb0808420f3af701" args="" -->HAL_TDM_OUTPUT_CONN_STATUS_MODE_SETTED</em>&nbsp;</td><td>
<p>The output connected and setted the mode </p>
<p>The output is connected and set the mode </p>
</td></tr>
</table>
</dd>
Expand Down
Loading