Commit graph

10 commits

Author SHA1 Message Date
Marc Durdin
48e684e242
Merge branch 'epic/web-core' into refactor/core/api-documentation
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
2026-05-08 19:18:57 +10:00
Marc Durdin
7591dc0bba chore(core): tidy up api-header-extractor 2026-05-06 13:28:03 +02:00
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
Eberhard Beilharz
f30e3fbd95
docs(core): update generated files
This change updates the documentation files that get generated out of
the the content in the source files. These files showed up as changed
when building.

Build-bot: skip
Test-bot: skip
2026-04-23 16:39:25 +02:00
Marc Durdin
0fb2cd2dc6 chore: Merge branch 'epic/web-core' into epic/embed-osk-in-kmx 2026-04-17 19:01:15 +02:00
Marc Durdin
8b88195aec docs(core): rebuild Core docs from .h and remove broken hotdoc config
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
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
Eberhard Beilharz
0422b3f912
chore(core): Remove km_core_keyboard_attrs.folder_path
PR #12769 removed `km_core_keyboard_load` that allowed loading a keyboard
from a path. Instead we now pass a BLOB to core to load a keyboard.
With the function gone there is no longer a need to have a field with the
path.

Follow-up-of: #12497
Related-to: #12769
Test-bot: skip
2026-01-20 15:17:38 +01:00
Marc Durdin
5ec2ce7863 chore: address review comments 2024-12-05 05:35:27 +07:00
Marc Durdin
4c3b2132ee chore(core): remove km_core_keyboard_load API
Fixes: #12497
2024-12-04 13:38:07 +07:00
Marc Durdin
fbab6eb8cf chore(core): move API docs from help.keyman.com
Reorganizes /core/doc to /core/docs and moves internal files
accordingly.

Depends-on: keymanapp/help.keyman.com#1684
2024-11-07 08:28:33 +07:00