Skip to content

Commit 8f21158

Browse files
theojintheojin
authored
Merge pull request #2171 from sgchoi5/update_hal_api_ref_main_page
Update menu tree and main page of HAL API Referfence
2 parents df8c436 + 78f0034 commit 8f21158

14 files changed

+77
-71
lines changed

‎docs/platform/HAL/api/1.0/Nodes.xml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,19 +180,19 @@
180180
<Path>group__HALAPI__HAL__SECURITY.html</Path>
181181
<Subnodes>
182182
<Node>
183-
<Name>Security Auth</Name>
183+
<Name>Auth</Name>
184184
<Path>group__HALAPI__HAL__SECURITY__AUTH__MODULE.html</Path>
185185
<Subnodes>
186186
</Subnodes>
187187
</Node>
188188
<Node>
189-
<Name>Security Certs</Name>
189+
<Name>Certs</Name>
190190
<Path>group__HALAPI__HAL__SECURITY__CERTS__MODULE.html</Path>
191191
<Subnodes>
192192
</Subnodes>
193193
</Node>
194194
<Node>
195-
<Name>Security Keys</Name>
195+
<Name>Keys</Name>
196196
<Path>group__HALAPI__HAL__SECURITY__KEYS__MODULE.html</Path>
197197
<Subnodes>
198198
</Subnodes>

‎docs/platform/HAL/api/1.0/Tokens.xml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18396,7 +18396,7 @@
1839618396
<APILanguage>c</APILanguage>
1839718397
</TokenIdentifier>
1839818398
<Path>group__HALAPI__HAL__SECURITY__AUTH__MODULE.html</Path>
18399-
<Abstract>The Security Auth provides functions to handle the authentication per user.</Abstract>
18399+
<Abstract>The Auth provides functions to handle the authentication per user.</Abstract>
1840018400
</Token>
1840118401
<Token>
1840218402
<TokenIdentifier>
@@ -18806,7 +18806,7 @@
1880618806
<APILanguage>c</APILanguage>
1880718807
</TokenIdentifier>
1880818808
<Path>group__HALAPI__HAL__SECURITY__CERTS__MODULE.html</Path>
18809-
<Abstract>The Security Certs provides functions for device certificates and signing operations.</Abstract>
18809+
<Abstract>The Certs provides functions for device certificates and signing operations.</Abstract>
1881018810
</Token>
1881118811
<Token>
1881218812
<TokenIdentifier>
@@ -19059,7 +19059,7 @@
1905919059
<APILanguage>c</APILanguage>
1906019060
</TokenIdentifier>
1906119061
<Path>group__HALAPI__HAL__SECURITY__KEYS__MODULE.html</Path>
19062-
<Abstract>The Security Keys provides functions to handle keys and data related operations.</Abstract>
19062+
<Abstract>The Keys provides functions to handle keys and data related operations.</Abstract>
1906319063
</Token>
1906419064
<Token>
1906519065
<TokenIdentifier>
@@ -20106,7 +20106,7 @@
2010620106
<APILanguage>c</APILanguage>
2010720107
</TokenIdentifier>
2010820108
<Path>group__HALAPI__HAL__SENSOR__MODULE.html</Path>
20109-
<Abstract>The Sensor provides functions for geting/putting backend and creating sensor devices.</Abstract>
20109+
<Abstract>The Sensor provides functions for getting/putting backend and creating sensor devices.</Abstract>
2011020110
</Token>
2011120111
<Token>
2011220112
<TokenIdentifier>

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,11 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_OVERVIEW"></a>
9898
<tr>
9999
<th>Module </th><th>Description </th></tr>
100100
<tr>
101-
<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>
101+
<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>
102102
<tr>
103-
<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>
103+
<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>
104104
<tr>
105-
<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>
105+
<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>
106106
</table>
107107
<p>For more information on the HAL Security submodule features, see HAL Security Guide. </p>
108108
</div><!-- contents -->

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var group__HALAPI__HAL__SECURITY =
22
[
3-
[ "Security Auth", "group__HALAPI__HAL__SECURITY__AUTH__MODULE.html", null ],
4-
[ "Security Certs", "group__HALAPI__HAL__SECURITY__CERTS__MODULE.html", null ],
5-
[ "Security Keys", "group__HALAPI__HAL__SECURITY__KEYS__MODULE.html", null ]
3+
[ "Auth", "group__HALAPI__HAL__SECURITY__AUTH__MODULE.html", null ],
4+
[ "Certs", "group__HALAPI__HAL__SECURITY__CERTS__MODULE.html", null ],
5+
[ "Keys", "group__HALAPI__HAL__SECURITY__KEYS__MODULE.html", null ]
66
];

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY__AUTH__MODULE.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<title>Tizen HAL API: Security Auth</title>
6+
<title>Tizen HAL API: Auth</title>
77

88
<link href="tabs.css" rel="stylesheet" type="text/css"/>
99
<link href="doxygen_html_stylesheet.css" rel="stylesheet" type="text/css" />
@@ -89,11 +89,11 @@
8989
<div class="summary">
9090
<a href="#typedef-members">Typedefs</a> </div>
9191
<div class="headertitle">
92-
<div class="title">Security Auth</div> </div>
92+
<div class="title">Auth</div> </div>
9393
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SECURITY.html">Security</a></div></div><!--header-->
9494
<div class="contents">
9595
<hr/><a name="details" id="details"></a><h2> </h2>
96-
<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>
96+
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__AUTH__MODULE.html">Auth</a> provides functions to handle the authentication per user. </p>
9797
<h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_HEADER"></a>
9898
Required Header</h2>
9999
<p>#include &lt;hal/hal-security-auth.h&gt;</p>
@@ -239,7 +239,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
239239
</table>
240240
</div>
241241
<div class="memdoc">
242-
<p>Get the accumulated attempt number for user's password auth trys </p>
242+
<p>Get the accumulated attempt number for user's password auth tries </p>
243243

244244
</div>
245245
</div>
@@ -281,7 +281,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
281281
</table>
282282
</div>
283283
<div class="memdoc">
284-
<p>Get the limited maximum attempt number of user's password auth trys </p>
284+
<p>Get the limited maximum attempt number of user's password auth tries </p>
285285

286286
</div>
287287
</div>
@@ -323,7 +323,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
323323
</table>
324324
</div>
325325
<div class="memdoc">
326-
<p>Increase the accumulated attempt number for user's password auth trys </p>
326+
<p>Increase the accumulated attempt number for user's password auth tries </p>
327327

328328
</div>
329329
</div>
@@ -393,7 +393,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
393393
</table>
394394
</div>
395395
<div class="memdoc">
396-
<p>Reset the accumulated attempt number for user's password auth trys </p>
396+
<p>Reset the accumulated attempt number for user's password auth tries </p>
397397

398398
</div>
399399
</div>
@@ -435,7 +435,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SECURITY_AUTH_MODULE_OVERVIEW"></a>
435435
</table>
436436
</div>
437437
<div class="memdoc">
438-
<p>Set the limited maximum attempt number of user's password auth trys </p>
438+
<p>Set the limited maximum attempt number of user's password auth tries </p>
439439

440440
</div>
441441
</div>

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY__CERTS__MODULE.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<title>Tizen HAL API: Security Certs</title>
6+
<title>Tizen HAL API: Certs</title>
77

88
<link href="tabs.css" rel="stylesheet" type="text/css"/>
99
<link href="doxygen_html_stylesheet.css" rel="stylesheet" type="text/css" />
@@ -89,11 +89,11 @@
8989
<div class="summary">
9090
<a href="#typedef-members">Typedefs</a> </div>
9191
<div class="headertitle">
92-
<div class="title">Security Certs</div> </div>
92+
<div class="title">Certs</div> </div>
9393
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SECURITY.html">Security</a></div></div><!--header-->
9494
<div class="contents">
9595
<hr/><a name="details" id="details"></a><h2> </h2>
96-
<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>
96+
<p>The <a class="el" href="group__HALAPI__HAL__SECURITY__CERTS__MODULE.html">Certs</a> provides functions for device certificates and signing operations. </p>
9797
<h2><a class="anchor" id="HALAPI_HAL_SECURITY_CERTS_MODULE_HEADER"></a>
9898
Required Header</h2>
9999
<p>#include &lt;hal/hal-security-certs.h&gt;</p>

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__SECURITY__KEYS__MODULE.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<title>Tizen HAL API: Security Keys</title>
6+
<title>Tizen HAL API: Keys</title>
77

88
<link href="tabs.css" rel="stylesheet" type="text/css"/>
99
<link href="doxygen_html_stylesheet.css" rel="stylesheet" type="text/css" />
@@ -89,11 +89,11 @@
8989
<div class="summary">
9090
<a href="#typedef-members">Typedefs</a> </div>
9191
<div class="headertitle">
92-
<div class="title">Security Keys</div> </div>
92+
<div class="title">Keys</div> </div>
9393
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SECURITY.html">Security</a></div></div><!--header-->
9494
<div class="contents">
9595
<hr/><a name="details" id="details"></a><h2> </h2>
96-
<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>
96+
<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>
9797
<h2><a class="anchor" id="HALAPI_HAL_SECURITY_KEYS_MODULE_HEADER"></a>
9898
Required Header</h2>
9999
<p>#include &lt;hal/hal-security-keys.h&gt;</p>

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__SENSOR__MODULE.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494
<div class="ingroups"><a class="el" href="group__HALAPI__HAL__SYSTEM.html">System</a></div></div><!--header-->
9595
<div class="contents">
9696
<hr/><a name="details" id="details"></a><h2> </h2>
97-
<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>
97+
<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>
9898
<h2><a class="anchor" id="HALAPI_HAL_SENSOR_MODULE_HEADER"></a>
9999
Required Header</h2>
100100
<p>#include &lt;hal-sensor.h&gt;</p>
@@ -132,7 +132,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SENSOR_MODULE_OVERVIEW"></a>
132132
<li>int hal_sensor_get_attribute_int(uint64_t sensor_device_id, uint32_t id, int32_t attribute, int32_t *value);</li>
133133
<li>int hal_sensor_get_attribute_str(uint64_t sensor_device_id, uint32_t id, int32_t attribute, char **value, size_t *len);</li>
134134
</ul>
135-
<p>Function to flush sensor datas:</p>
135+
<p>Function to flush sensor data:</p>
136136
<ul>
137137
<li>int hal_sensor_flush(uint64_t sensor_device_id, uint32_t id); </li>
138138
</ul>
@@ -225,7 +225,7 @@ <h2><a class="anchor" id="HALAPI_HAL_SENSOR_MODULE_OVERVIEW"></a>
225225
</table>
226226
</div>
227227
<div class="memdoc">
228-
<p>Flush sensor datas </p>
228+
<p>Flush sensor data </p>
229229

230230
</div>
231231
</div>

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__TBM__MODULE.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ <h2><a class="anchor" id="HALAPI_HAL_TBM_MODULE_OVERVIEW"></a>
514514
</table>
515515
</div>
516516
<div class="memdoc">
517-
<p>Get plane's information from TBM buffer manger HAL according to the color format </p>
517+
<p>Get plane's information from TBM buffer manager HAL according to the color format </p>
518518

519519
</div>
520520
</div>
@@ -528,7 +528,7 @@ <h2><a class="anchor" id="HALAPI_HAL_TBM_MODULE_OVERVIEW"></a>
528528
</table>
529529
</div>
530530
<div class="memdoc">
531-
<p>Get supported color format from TBM buffer manger. </p>
531+
<p>Get supported color format from TBM buffer manager. </p>
532532

533533
</div>
534534
</div>

‎docs/platform/HAL/api/1.0/group__HALAPI__HAL__TDM__MODULE.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4807,13 +4807,13 @@ <h2><a class="anchor" id="HALAPI_HAL_TDM_MODULE_OVERVIEW"></a>
48074807
<dl class="user"><dt><b>Since:</b></dt><dd>HAL_MODULE_TDM 1.0 </dd></dl>
48084808
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
48094809
<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>
4810-
<p>The output disconnected </p>
4810+
<p>The output is disconnected </p>
48114811
</td></tr>
48124812
<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>
4813-
<p>The output connected </p>
4813+
<p>The output is connected </p>
48144814
</td></tr>
48154815
<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>
4816-
<p>The output connected and setted the mode </p>
4816+
<p>The output is connected and set the mode </p>
48174817
</td></tr>
48184818
</table>
48194819
</dd>

0 commit comments

Comments
 (0)