Skip to content

docs: backfill missing Swift doc comments on public APIs#21

Open
tannn wants to merge 2 commits into
mainfrom
docs-backfill/swift-doc-comments
Open

docs: backfill missing Swift doc comments on public APIs#21
tannn wants to merge 2 commits into
mainfrom
docs-backfill/swift-doc-comments

Conversation

@tannn
Copy link
Copy Markdown
Owner

@tannn tannn commented Apr 10, 2026

Summary

  • Add type-level and member-level Swift doc comments to FloatingPanelComponents.swift (FloatingPanelDesignTokens, FloatingPanelLoadingView, FloatingPanelResponseCard, FloatingPanelErrorCallout)
  • Add type-level doc comment to FloatingPanelView
  • Add class-level and member-level doc comments to MenuBarCoordinator (class, callback properties, installStatusItemIfNeeded, uninstallStatusItem)
  • Add type-level and method-level doc comments to Logger enum and all Category cases plus the four static log-level methods
  • Add missing doc comments for setErrorMessage(_:) and copyText in FloatingPanelViewModel
  • Add doc comments for ten undocumented convenience setter methods on AppState
  • Add doc comments for the four public static redaction helpers on DiagnosticEvent

No behaviour changes — every edit is additive doc comments only.

Test plan

  • Build succeeds with no new warnings
  • Doc comments render correctly in Xcode Quick Help (Option-click each symbol)

🤖 Generated with Claude Code

tannn and others added 2 commits March 1, 2026 23:53
Add /// doc comments to all public protocols, actors, classes, structs,
enums, methods, and properties across 16 core source files. Comments
describe purpose, parameters, return values, concurrency constraints
(actor isolation, @mainactor), and error conditions. No code logic changed.

Nightshift-Task: docs-backfill
Nightshift-Ref: https://github.com/marcus/nightshift

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant