Skip to content

fw/applib: misc SDK doc improvements and add missing log and function#1072

Merged
gmarull merged 3 commits intocoredevices:mainfrom
howeaj:main
Apr 10, 2026
Merged

fw/applib: misc SDK doc improvements and add missing log and function#1072
gmarull merged 3 commits intocoredevices:mainfrom
howeaj:main

Conversation

@howeaj
Copy link
Copy Markdown

@howeaj howeaj commented Apr 5, 2026

Hello, having just gotten started on Pebble app development, here's some fixes to the C API (mainly documentation) that would have helped me.

Added function:

Added log:

  • Add missing PBL_LOG_DBG for rejected BUTTON_ID_BACK click handlers to match window_raw_click_subscribe()

Added struct:

Documentation changes:

  • Add module summary with code example to app_glance.h
  • Clarify use of elapsed timers with app_timer_reschedule() and app_timer_cancel()
  • Clarify app_wakeup_service_subscribe()
  • Clarify that bitmap transparency is off by default and how to enable it in relevant locations
  • Document return values of persist_delete()
  • Replace an old reference to Aplite/Basalt with black&white/colour
  • Fix "error: duplicate 'const' declaration specifier" in vibes.h code examples
  • Fix typo in dictation_session.h

Copy link
Copy Markdown
Member

@jplexer jplexer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Just 2 minor things

@jplexer
Copy link
Copy Markdown
Member

jplexer commented Apr 7, 2026

fix build please 🥴

@howeaj
Copy link
Copy Markdown
Author

howeaj commented Apr 7, 2026

Sorry about that, I thought I'd just copypasted the equivalent function from other modules but now I remember I removed the cast thinking it was unnecessary.

Now I see, the cast was to strip the const. Stripping const like that is not very nice but I'll just copy what the rest are already doing and restore it to match.

@howeaj howeaj force-pushed the main branch 3 times, most recently from 3a5f615 to 0b4d3e1 Compare April 7, 2026 19:10
@howeaj
Copy link
Copy Markdown
Author

howeaj commented Apr 7, 2026

Messed up force push there sorry. The last two pushes together only add the const-removal-cast in and change the commit message to pass the "lint" compliance check

Copy link
Copy Markdown
Member

@gmarull gmarull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please split changes into smaller, focused commits, e.g. one updating docs, other adding new API, etc.

Copy link
Copy Markdown
Member

@gmarull gmarull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm, please use real mail on commits

howeaj added 3 commits April 9, 2026 21:50
- Add module summary with code example to app_glance.h
- Clarify use of elapsed timers with app_timer_reschedule() & app_timer_cancel()
- Clarify app_wakeup_service_subscribe()
- Clarify that bitmap transparency is off by default and how to enable it
- Document return values of persist_delete()
- Replace an old reference to Aplite/Basalt with black&white/colour
- Fix "error: duplicate 'const' declaration specifier" in vibes.h code examples
- Fix typo in dictation_session.h

Signed-off-by: Andrew Howe <howeaj.github@gmail.com>
Signed-off-by: Andrew Howe <howeaj.github@gmail.com>
…out to API

rot_bitmap_layer_get_layer() is added to match all other layer modules.

The anonymous `layout` struct from AppGlanceSlice is extracted to
AppGlanceSliceLayout so that its documentation can be included in docs.

Signed-off-by: Andrew Howe <howeaj.github@gmail.com>
@gmarull gmarull merged commit 02ff345 into coredevices:main Apr 10, 2026
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants