spiegel-keyman/core/docs/api/changes.md
Marc Durdin 0f2f3c1009 refactor(core): clean up API documentation
Move all Keyman Core header API documentation to javadoc-style so that
we can get inline documentation and simplify the readability of the
header files.

Update api-header-extractor to support minimal javadoc formatting of the
comments.

Test-bot: skip
2026-05-05 16:29:53 +02:00

6.7 KiB

title
Changes - Keyman Core API

Changes between 18.0 and 19.0

  • Removed deprecated km_core_keyboard_attrs.folder_path
  • 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.