Update Iot Headed/Headless API ref #1358

sgchoi5 · 2020-11-24T02:12:46Z

Target: 4.0 / 5.0 / 5.5
Removed unnecessary modules
Fixed some minor issues (broken link, etc)

TizenDocsBot · 2020-11-24T02:23:26Z

checkout the webpage https://docs1.stg.tizen.org/staging/1358

TizenDocsBot · 2020-11-24T02:23:55Z

Check Broken Link: Not found any broken link

mijin85cho

Hello.

I skimmed the pages and got below queries.

Also, I reported an issue with the updated pages.

With the updated files, the LNB works.
However, in some pages, the layout is dragged down to the end of LNB, so at first sight the page shows just a blank window.

After scrolling :

I reported this issue to https://github.sec.samsung.net/RS8-TIZENWEBSITE/docs.tizen.org/issues/430.
Would you also please check the issue page to get the status?

mijin85cho · 2020-11-24T04:46:08Z

docs/application/native/api/iot-headed/4.0/ecore_thread_example_8c-example.html

        ftd = calloc(1, <span class="keyword">sizeof</span>(Feedback_Thread_Data));
        ftd-&gt;name = strdup(<span class="stringliteral">&quot;data0&quot;</span>);
        ftd-&gt;base = strdup(<span class="stringliteral">&quot;/usr/bin&quot;</span>);
-        <a name="a44"></a><a class="code" href="group__Eina__Lock__Group.html#ga8dda398c1db315582a80640c7f78f648" title="Initializes a new #Eina_Lock.">eina_lock_new</a>(&amp;ftd-&gt;mutex);
+        eina_lock_new(&amp;ftd-&gt;mutex);


It seems eina_lock_new() is removed. Can it be remained here?

I think .. new version is correct, because previous 4.0 headed api ref was made by very old header files.

It is same in https://docs1.stg.tizen.org/staging/1358/application/native/api/iot-headed/6.0/ecore_thread_example_8c-example.html, so I asked.

However if you think this issue is not critical, I'll just merge this PR after we get the reply for the dragged window issue.

In case of EFL, I will try to fix issues in this page.
https://code.sec.samsung.net/confluence/pages/viewpage.action?pageId=194846376

Hard to fix it quickly, because EFL team needs to fix upstream header first and sync it to Tizen Platform and SR should be completed. It takes ... at least 2~3 weeks.

Yes, correct. I am trying to fix them all.. t.t
Yesterday, I sent all issues to developers. waiting for fix and feedback..

mijin85cho · 2020-11-24T04:49:29Z

docs/application/native/api/iot-headed/4.0/ecore_thread_example_8c-example.html


-   <a name="a50"></a><a class="code" href="group__Eina__Lock__Group.html#ga838e1e7dfc8bbf114634a7de67de8956" title="Deallocates a condition variable.">eina_condition_free</a>(&amp;appdata.condition);
-   <a class="code" href="group__Eina__Lock__Group.html#gaf8d1c4e3aff3bd26fc85d81ed8c4e71a" title="Deallocates an #Eina_Lock.">eina_lock_free</a>(&amp;appdata.mutex);
+   eina_condition_free(&amp;appdata.condition);


It seems eina_condition_free() is removed. Can it be remained here?

I think .. new version is correct, because previous 4.0 headed api ref was made by very old header files.

mijin85cho · 2020-11-24T04:50:57Z

docs/application/native/api/iot-headed/4.0/ecore_thread_example_c.html

@@ -214,9 +214,9 @@
   <span class="keywordflow">while</span> (1)
     {
        <span class="keywordtype">int</span> msgs;
-        <a class="code" href="group__Eina__Lock__Group.html#ga149f387d5f18c469c365147ffbd4dc2c" title="Causes a thread to wait until signaled by the condition.">eina_condition_wait</a>(&amp;ad-&gt;condition);
+        eina_condition_wait(&amp;ad-&gt;condition);


It seems eina_condition_wait() is removed. Can it be remained here?

I think .. new version is correct, because previous 4.0 headed api ref was made by very old header files.

mijin85cho · 2020-11-24T05:24:01Z

docs/application/native/api/iot-headed/4.0/classDali_1_1Toolkit_1_1Button.html

@@ -81,7 +81,7 @@
  </div>


In this page, there are broken tables. Would you please check?

DALi is deprecated. They have stopped the maintenance of DALi...

Question. The issue I reported about the window display is happening in DALi.

If DALi is deprecated, can we just ignore that issue on https://github.sec.samsung.net/RS8-TIZENWEBSITE/docs.tizen.org/issues/430?

In other pages I couldn't find the same issue yet.

I think.. if it is not critical issue, hard to fix DALi issues... : (

mijin85cho · 2020-11-24T06:34:32Z

docs/application/native/api/iot-headed/4.0/index.html

@@ -106,7 +106,7 @@ <h2><a class="anchor" id="NATIVE_API_REFERENCE_SECTION1"></a>
 </p>
 <h2><a class="anchor" id="NATIVE_API_REFERENCE_SECTION2"></a>
 Related Feature</h2>
-<p>Some of the Tizen native APIs require features to prevent your application from being shown in the application list on the Tizen store. If related Feature is included in API reference as shown below and your application uses that feature, then you need to declare the feature in the tizen-manifest.xml file. For more information, see <a href="https://developer.tizen.org/development/getting-started/native-application/understanding-tizen-programming/application-filtering"><b>Application Filtering</b>.</a> </p>
+<p>Some of the Tizen native APIs require features to prevent your application from being shown in the application list on the Tizen store. If related Feature is included in API reference as shown below and your application uses that feature, then you need to declare the feature in the tizen-manifest.xml file. For more information, see <a href="https://docs.tizen.org/application/native/tutorials/details/app-filtering"><b>Application Filtering</b>.</a> </p>


Just a question.

IoT Headed / Headless API are based on Tizen Native API. Is it the reason of keep using the "Tizen native API" in the pages?

Iot Profiles support Native API. but, different coverage compared with Mobile / Wearable.

mijin85cho · 2020-11-26T06:44:29Z

@sgchoi5 I found some issues within this PR,
however most of them are same with the current published version, or not critical, or will take some time to fix (or hard to fix).

So, I'd like to merge this PR for now.
If so, about weeks later you can create a new PR for new version that will be generated at that time. Will you?

sgchoi5 · 2020-11-27T05:18:19Z

Yes, I will try. but, not easy to fix issues, because developers must update their header files.

mijin80lee · 2020-11-30T06:09:52Z

docs/application/native/api/iot-headed/5.0/group__Evas__Main__Group.html

@@ -98,13 +98,17 @@
 <tr><td colspan="2"><h2><a name="func-members"></a>
 Functions</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Evas__Main__Group.html#ga65b3f060b6dd9e488afd0b8cbe101869">evas_init</a> (void)</td></tr>


Need to check the function 'evas_init (void)' compared to mobile API Reference.
(ref. https://docs.tizen.org/application/native/api/mobile/6.0/group__Evas__Main__Group.html : EINA_DEPRECATED int)

It is wrong deprecated TAG. I've added an issue to https://code.sec.samsung.net/confluence/pages/viewpage.action?pageId=194846376
Issue No. 60

EFL part need to update header file.... Can't fix it right now.

Okay, I got it.

mijin80lee · 2020-11-30T06:10:11Z

docs/application/native/api/iot-headed/5.0/group__CAPI__OAUTH2__MODULE.html

@@ -114,7 +114,7 @@ <h2><a class="anchor" id="CAPI_OAUTH2_MODULE_FEATURE"></a>
 </p>
 <p>To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.<br/>
 </p>
-<p>More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature List</b>.</a>a&gt;</p>
+<p>More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature List</b>.</a>a&gt;</p>


Could you delete a> after <b>Feature List</b>.</a>?
The 6.0 version also has the same content, please modify it.

oauth2_doc.h should be fixed to remove unnecessary a>
I've added it to issue page with No.59.

In this case, I've fixed html directly and pushed changes.

mijin80lee · 2020-11-30T06:30:11Z

docs/application/native/api/iot-headed/5.0/group__ATSPI.html

@@ -90,7 +90,7 @@
 <a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
 <div class="title">AT-SPI2 Accessibility</div>  </div>
-<div class="ingroups"><a class="el" href="group__Elm__Engine.html">Elementary Engine</a> &#124; <a class="el" href="group__elm__infra__group.html">Elementary Infrastructure</a></div></div><!--header-->
+<div class="ingroups"><a class="el" href="group__Elm__Engine.html">Elementary Engine</a> &#124; <a class="el" href="group__Elementary.html">Elementary</a></div></div><!--header-->


Check the Menu tree and confirm exact location.
The 6.0 version also has the same issue, please modify it.

Issue. 61 (https://code.sec.samsung.net/confluence/pages/viewpage.action?pageId=194846376)
need to fix EFL header.

mijin80lee · 2020-11-30T06:51:29Z

Could you change URLs of 'Feature Element' of following pages as below?
(Tizen Docs, https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element)

docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__PERIPHERAL__IO__ADC__MODULE.html
docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__PERIPHERAL__IO__GPIO__MODULE.html
docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__PERIPHERAL__IO__I2C__MODULE.html
docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__PERIPHERAL__IO__PWM__MODULE.html
docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__PERIPHERAL__IO__SPI__MODULE.html
docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__PERIPHERAL__IO__UART__MODULE.html
docs/application/native/api/iot-headed/6.0/group__CAPI__SYSTEM__UPDATE__CONTROL__MODULE.html

mijin80lee · 2020-11-30T07:05:25Z

Could you add '(Deprecated)' to the title on DALi Toolkit page?
docs/application/native/api/iot-headed/6.0/group__dali__toolkit.html

- Target: 4.0 / 5.0 / 5.5 - Removed unnecessary modules - Fixed some minor issues (broken link, etc)

TizenDocsBot · 2020-11-30T07:24:01Z

checkout the webpage https://docs1.stg.tizen.org/staging/1358

TizenDocsBot · 2020-11-30T07:24:34Z

Check Broken Link: Not found any broken link

sgchoi5 · 2020-11-30T23:20:30Z

Could you add '(Deprecated)' to the title on DALi Toolkit page?
docs/application/native/api/iot-headed/6.0/group__dali__toolkit.html

will be fixed with next update. Recently, Dali team fixed it.

sgchoi5 · 2020-12-01T01:12:45Z

https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element

I've made a new page for this issue. Just, sent a request email to developers.
https://code.sec.samsung.net/confluence/display/API/Native+API+Ref%3A+developer.tizen.org+%3D%3E+docs.tizen.org

mijin85cho

Pending issues will be checked with next version.

sgchoi5 requested review from annie-samsung, journey2w and mijin85cho as code owners November 24, 2020 02:12

mijin85cho reviewed Nov 24, 2020

View reviewed changes

mijin80lee reviewed Nov 30, 2020

View reviewed changes

sgchoi5 force-pushed the update_iot_40_50_55_api_ref branch from 2ba77f5 to b4510fa Compare November 30, 2020 07:14

Update Iot Headed/Headless API ref

b4510fa

- Target: 4.0 / 5.0 / 5.5 - Removed unnecessary modules - Fixed some minor issues (broken link, etc)

mijin85cho approved these changes Dec 2, 2020

View reviewed changes

mijin85cho merged commit 5477451 into Samsung:master Dec 2, 2020

mijin80lee mentioned this pull request Dec 14, 2020

Native 6.0 API Reference Issues #1352

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Iot Headed/Headless API ref #1358

Update Iot Headed/Headless API ref #1358

sgchoi5 commented Nov 24, 2020 •

edited

Loading

TizenDocsBot commented Nov 24, 2020

TizenDocsBot commented Nov 24, 2020

mijin85cho left a comment

mijin85cho Nov 24, 2020

sgchoi5 Nov 25, 2020

mijin85cho Nov 25, 2020

sgchoi5 Nov 25, 2020

sgchoi5 Nov 26, 2020

mijin85cho Nov 24, 2020

sgchoi5 Nov 25, 2020

mijin85cho Nov 24, 2020

sgchoi5 Nov 25, 2020

mijin85cho Nov 24, 2020

sgchoi5 Nov 25, 2020

mijin85cho Nov 25, 2020

sgchoi5 Nov 25, 2020

mijin85cho Nov 24, 2020

sgchoi5 Nov 25, 2020

mijin85cho commented Nov 26, 2020

sgchoi5 commented Nov 27, 2020

mijin80lee Nov 30, 2020

sgchoi5 Nov 30, 2020

mijin80lee Nov 30, 2020

mijin80lee Nov 30, 2020

sgchoi5 Nov 30, 2020

mijin80lee Nov 30, 2020

sgchoi5 Nov 30, 2020

mijin80lee commented Nov 30, 2020

mijin80lee commented Nov 30, 2020

TizenDocsBot commented Nov 30, 2020

TizenDocsBot commented Nov 30, 2020

sgchoi5 commented Nov 30, 2020

sgchoi5 commented Dec 1, 2020

mijin85cho left a comment

Update Iot Headed/Headless API ref #1358

Update Iot Headed/Headless API ref #1358

Conversation

sgchoi5 commented Nov 24, 2020 • edited Loading

TizenDocsBot commented Nov 24, 2020

TizenDocsBot commented Nov 24, 2020

mijin85cho left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mijin85cho commented Nov 26, 2020

sgchoi5 commented Nov 27, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mijin80lee commented Nov 30, 2020

mijin80lee commented Nov 30, 2020

TizenDocsBot commented Nov 30, 2020

TizenDocsBot commented Nov 30, 2020

sgchoi5 commented Nov 30, 2020

sgchoi5 commented Dec 1, 2020

mijin85cho left a comment

Choose a reason for hiding this comment

sgchoi5 commented Nov 24, 2020 •

edited

Loading