feat: Add Public C Value API document #395
Conversation
✅ Deploy Preview for lynx-doc ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
| @@ -0,0 +1,518 @@ | |||
| From d5868a22f8e38514a6ebe34d9d131547ccc28a90 Mon Sep 17 00:00:00 2001 | |||
FrendyChen
force-pushed
the
p/lynx_value_document
branch
from
b94a0cd to
6c157bf
Compare
| @@ -0,0 +1,225 @@ | |||
| # LynxValue | |||
| LynxValue 是 Lynx 提供的一套 C Value API，支持 LynxSDK 与 Lynx 客户端接口使用方相互传递数据。 | |||
There was a problem hiding this comment.
"开发者在什么场景下需要用到这一组 API" 这个信息在哪里能看得到吗
There was a problem hiding this comment.
建议把方案设计中的 Motivation 和 使用指南中抽取出部分信息在这里介绍一下。
| ```c | ||
| lynx_api_status lynx_value_typeof(lynx_api_env env, | ||
| lynx_value value, | ||
| lynx_value_type* result); |
There was a problem hiding this comment.
这里每一个 API 的介绍比较简单，可以参考 https://lynxjs.org/api/engine/element-api/__AddInlineStyle.html 这些 API，提供入参介绍，返回值介绍和代码示例。
There was a problem hiding this comment.
同时需要补充兼容性表格，这些 API 是哪个 Lynx Engine 版本引入的。
| @@ -0,0 +1,225 @@ | |||
| # LynxValue | |||
| LynxValue is a set of C Value APIs provided by Lynx, supporting data exchange between LynxSDK and Lynx client interface users. | |||
There was a problem hiding this comment.
| LynxValue is a set of C Value APIs provided by Lynx, supporting data exchange between LynxSDK and Lynx client interface users. | |
| LynxValue is a set of C Value APIs provided by Lynx, supporting data exchange between Lynx Engine and Lynx client interface users. |
What is "Lynx client interface users"? Please only uses terms defined from spec and linked to spec on high-level introduction like https://lynxjs.org/guide/start/integrate-with-existing-apps.html?platform=ios#configuring-deps
There was a problem hiding this comment.
We should also introduce "Lynx Value" as a new definition in the Spec while adding the APIs
Change-Id: I1a985909e731028f0b555ca7e1681831e66e954b
FrendyChen
force-pushed
the
p/lynx_value_document
branch
from
6c157bf to
dfe3989
Compare
4 participants
Change-Id: I1a985909e731028f0b555ca7e1681831e66e954b