Skip to content

docs: refresh stale architecture docs and comments (#413) - #414

Merged
Maxaubert merged 1 commit into
mainfrom
docs/413-docs-refresh
Oct 10, 2026
Merged

Maxaubert merged 1 commit into
mainfrom
docs/413-docs-refresh

Conversation

@Maxaubert

Copy link
Copy Markdown
Owner

Closes #413. Review batch 9 (Low section of the 2026-10-09 review), documentation refresh. Code changes are comment-only plus one static_assert(sizeof(MagCB) == 128).

Fixed

  • 6: 02-tick-loop reload keeps zoom (Changing any setting while zoomed drops the zoom to 1x #234), RunTick can block on the config read, Locked row has the learned gain, retarget wording, foreground reads.
  • 7: restart-only key list now includes hdrTonemap, fastPan, smoothPan; gpuPriority documented as half hot; lowGpuPriority alias noted.
  • 17: stale "always timer-paced" comment in main.cpp replaced.
  • 27: docs 05/07 say every changed tick is written plus NudgeAfterWrite; SendWrite and NudgeAfterLevelWrite names fixed.
  • 30: "default off" comment (mpoGuardLiftWall is 1), 05 lastLevel_ = restLevel_, mag_host sampling-mode 2-4 comment, transform.h (fixed-point offset is test-only).
  • 39: retarget is both engines and not multiMonitor-dependent (03, 04, magnifier_model.h).
  • 43: MagCB is 128 bytes (comment plus static_assert), crosshair 48x48, swap effect is DISCARD not FLIP_DISCARD.
  • 48: 06-input swallow-record clearing and synthetic UPs match Keybind hook polish: lone click-ups on quit, held-state races, one mask key per hold, wheel respects pass-through, more reserved shortcuts #301; keyboard hook does not skip Wind's tag.
  • 65: TRACKING-FINDINGS and CLAUDE.md describe the backed-off Java retry.
  • 77: log folder prefers the exe folder when writable.
  • 84: tray flyout does prompt (ConfirmSwitch).
  • 85: 09 no longer names Keycaps.svelte; maximize window action added.
  • 96, 126: thread table (tick, hooks, focus tracker and lookup, cursor swaps, DWM watch, log writer, tray supervisor, trace dump); WM_TIMER branch documented as dead.
  • 105: Wind.manifest comment (plain manifest) and installer comment about a Magnifier registry restore.
  • 116: transform keeps its context and cursor lens warm at idle (Native cursor for the high resolution mode: DWM-drawn pointer with DWM centring #369) in 02 and 03.
  • 117: engine_pick.h header and 03 table cover protected/rotated/desktop paths.
  • 122: warm-pulse comments no longer claim caret/focus views are warmed (tx_warm.h, config.h).
  • 124: 07 names kLockMs/kFreeMs.
  • 125: CLAUDE.md says only the mouse hook skips Wind's injections.
  • 127: edgeClip, lockedBallistics, smoothPan, fastPan, mpoGuard, txTrace, txRestLevel documented in 08; 01 source map filled in.

Skipped

  • Item 16 (delete the dead WM_TIMER branch) is code, not in this batch; the docs now say the branch is dead.
  • Tools scripts that back up the native Magnifier registry (item 105): accurate, they drive native Magnifier; only the installer comment was stale.
  • Item 48 lines 92 and 144 of 06-input.md: current text matches the code.

Tests

  • build.bat test: [doctest] test cases: 598 | 598 passed | 0 failed | 0 skipped
  • build.bat: builds clean.

No version bump: bumped at merge time.

🤖 Generated with Claude Code

https://claude.ai/code/session_011zPmivSAQeivGUdBjTsaMu

The branch is main plus exactly the combined test build's state after this PR
(conflicts with the PRs merged before it resolved as tested), version 0.24.19.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_011zPmivSAQeivGUdBjTsaMu
@Maxaubert
Maxaubert force-pushed the docs/413-docs-refresh branch from 448e0ab to 34a2872 Compare October 10, 2026 03:00
@Maxaubert
Maxaubert merged commit e2fbb30 into main Oct 10, 2026
1 check passed
@Maxaubert
Maxaubert deleted the docs/413-docs-refresh branch October 10, 2026 03:11
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.

docs: documentation refresh (review batch 9)

1 participant