Commit Graph

10 Commits

Author SHA1 Message Date
zhangxiaowei16 14c3520569 docs: fix mixed Chinese-English translation issues in API docs
Fix incomplete/broken translations across media, bluetooth, and network
API documentation where Chinese and English were mixed together in
function descriptions, parameter explanations, and return values.

Changes:
- media: media_player, media_recorder, media_session, media_policy
- bluetooth: bt_a2dp, bt_hfp, bt_spp, bt_gap, bt_hid
- network: wapi
- media_utils: add missing media_player_dump and media_recorder_dump APIs (zh-cn + en)
2026-05-18 20:39:14 +08:00
zhangxiaowei16 20ca12fcda docs: fix dhcp6c SLAAC description and replace Multi-SIM with SIM identification in telephony 2026-05-15 09:51:52 +08:00
zhangxiaowei16 58e8a7b47c docs(bluetooth): add CS API, remove AVRCP/BLE scan/advertiser per team decision 2026-05-14 20:19:53 +08:00
zhangxiaowei16 37924fe937 docs: translate figures in en/api and prune low-value figures
Replace Chinese figures under docs/en/api/ with English translations so
the English documentation no longer embeds Chinese-only images.

Figures translated (docs/en/api/...):
- framework/feature/figures/JIDL.png
- framework/feature/figures/feature_static.png
- framework/feature/figures/feature_instance.png
- framework/feature/figures/Asynchronous_model.png
- framework/telephony/figures/TapiWork.png

Figures pruned (removed in both en/ and zh-cn/) and expressed inline via
concise text or tables, which carries the same information more compactly:
- feature_framework.png: use a short bullet list of the architecture layers.
- feature_life.png: use a table documenting each lifecycle event.
- feature_running.png: use a bullet list describing Module / Prototype /
  Instance semantics.
- callback_promise_manager.png: describe the internal ID/table design inline.
- quickapp/basic_structure.png: remove the Overall Architecture section,
  whose information is already covered by Related Documentation links.
2026-05-11 13:58:40 +08:00
zhangxiaowei16 ff8c2f9df0 docs: reference orphaned A2DP and Feature Context figures
Two figures previously shipped with the API reference were not referenced
by any document:

- figures/a2dp.png (under framework/bluetooth/) — A2DP connection state
  machine diagram.
- figures/ft_context.svg (under framework/feature/) — Relationship between
  the Feature framework interface (ft_value_t / ft_context_ref) and the
  frontend runtime (JSValue / JSContext).

Instead of deleting them, both figures are now properly referenced:

- bt_a2dp.md gains a new 'Connection State Machine' section that renders
  the A2DP state machine diagram with a description of each state.
- feature_framework_context.md gains a new 'Feature Context and Frontend
  Runtime' section that uses ft_context.svg to explain the value/context
  mapping between the Feature framework and frontend runtimes.

Chinese and English versions are kept in sync.
2026-05-09 20:35:49 +08:00
zhangxiaowei16 4071012159 docs: add English translation for API reference documentation
Add full English version of API reference docs under docs/en/api/,
covering 69 files across kernel, framework, and network modules.

Additional changes in docs/zh-cn/api/:
- Add bilingual navigation header to all 69 zh-cn API documents,
  enabling cross-language switching between Chinese and English versions.
- Fix 16 mis-placed function descriptions in telephony/telephony_call.md
  where multiple APIs incorrectly shared the same description
  (re-derived from the tapi_call.h header @brief comments).
- Fix 2 untranslated English residues in network/wapi.md.
2026-05-09 16:44:23 +08:00
zhangxiaowei16 235bdec4fb docs: add API doc generation guide (zh-cn/en) and remove empty api directory 2026-03-06 10:01:39 +08:00
jiayadong 86debc8691 Switch between Chinese and English 2025-05-15 09:34:27 +08:00
jiayadong 3715ed30de Switch between Chinese and English 2025-05-15 09:34:27 +08:00
zhangxiaowei16 5176b71c43 Add the Bluetooth API documentation table of contents 2025-01-06 11:20:39 +08:00