spiegel-keyman/core/docs/api/changes.md
Marc Durdin 8b88195aec
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
docs(core): rebuild Core docs from .h and remove broken hotdoc config
Rebuild the API docs using api-header-extractor script, and add the
script to the normal build for Core so that it doesn't get out of sync
again.

Hotdoc configuration has not been used for a while; it is currently
broken and we haven't got any docs generated by it anyway, so remove
from repo.

Remove largely duplicate BUILDING.md and old json-schema.md.

Test-bot: skip
2026-04-11 17:33:07 +02:00

4.6 KiB

title
Changes - Keyman Core API

Changes in 19.0

  • The JSON introspection APIs (which were not fully implemented), km_core_state_options_to_json and km_core_state_to_json, have been removed.

Changes between 16.0 and 17.0

  • The namespace identifier has changed from km_kbp_ to km_core_.
  • Most context APIs are now private, and km_core_state_context_set_if_needed is the primary context function. Private APIs are available in keyman_core_api_context.h.
  • The action queue APIs are now private and deprecated. Instead, use km_core_state_get_actions. Private APIs are available in keyman_core_api_actions.h.
  • Debug APIs are available in keyman_core_api_debug.h.